repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
kit-data-manager/Metadata-Schemas-for-Materials-Science | a6c14209fe71debfa246dbfba23a5c933fba6343 | 2024-01-12T12:31:45 | SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Unit) - the unit of the value to be selected from a controlled list (degree, radian).",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A).",
"enum": [
"pA",
"nA",
"uA",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"detectorDetails": {
"additionalProperties": false,
"description": "(Required) - describes the settings related to the detector with which the image set is acquired",
"properties": {
"detectorSettings": {
"$ref": "#/$defs/detectorSettings",
"description": "(Required) - Settings of the specific detector used. E.g., the Everhart Thornley detector (ETD), is a secondary electron and back-scattered electron detector used in scanning electron microscopes, whihc has then particular settings"
},
"detectorType": {
"description": "(Required) - Type of the detector used",
"enum": [
"ETD",
"CDEM",
"CBS",
"ECD",
"External",
"GBSD",
"GSED",
"ICE",
"LFD",
"LVD",
"LVSED",
"None",
"STEM3",
"STEM3_GMode",
"STEM4",
"T1",
"T2",
"T3",
"TLD"
],
"type": "string"
},
"name": {
"description": "(Optional) - Name of the detector used",
"type": "string"
}
},
"required": [
"detectorType"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "describes the parameters of a detector such as the Everhart Thornley detector (ETD), which is a secondary electron and back-scattered electron detector used in scanning electron microscopes",
"properties": {
"brightness": {
"description": "(Optional) - A number indicating the brightness",
"type": "number"
},
"brightnessdB": {
"description": "(Optional) - Describes the brightness in dB",
"type": "number"
},
"contrast": {
"description": "(Optional) - A number indicating the contrast",
"type": "number"
},
"contrastdB": {
"description": "(Optional) - Describes the contrast in dB",
"type": "number"
},
"enhancedContrast": {
"description": "(Optional) - Describes the enhancement in contrast",
"type": "number"
},
"frontEndVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Bias voltage applied to the front end of the detector "
},
"grid": {
"description": "(Optional) - A number indicating the number of grid elements",
"type": "number"
},
"gridVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage applied to the grid "
},
"minimumDwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Minimum possible dwell time for the detector. IRI: https://purls.helmholtz-metadaten.de/EMG/00000006 "
},
"mix": {
"description": "(Optional) - Signals from different detectors can be overlaid (mixed) and this should, in theory, be the percentage of this detectors contribution to the end result.",
"type": "number"
},
"setting": {
"description": "(Optional) - In case of ETD, this is the bias voltage applied to the detector grid. Note that this block looks different for different detectors. ",
"type": "number"
},
"signal": {
"description": "(Optional) - The signal used for detection",
"enum": [
"SE",
"BSE",
"SI"
],
"type": "string"
}
},
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m).",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"eBeamDetails": {
"additionalProperties": false,
"description": "(Required) - Describes the configuration of the electron beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000007",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The potential difference between anode and cathode. The acceleration voltage adds kinetic energy to the particles of the beam. IRI: https://purls.helmholtz-metadaten.de/EMG/00000001 It is defined separately as voltageDetails, (includes the voltage value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - uV, mv, V, kV, MV)"
},
"apertureSetting": {
"additionalProperties": false,
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size (diameter) of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails."
}
},
"type": "object"
},
"beamCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Electrical current which flows along the beam path. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003 It is defined separately as currentDetails (includes the current value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)."
},
"dynamicFocusIsOn": {
"description": "(Optional) - To bet set true if dynamic focus is on. IRI:https://purls.helmholtz-metadaten.de/emg/00000039",
"type": "boolean"
},
"dynamicWDIsOn": {
"description": "(Optional) - To bet set true if dynamic working distance is on. IRI: https://purls.helmholtz-metadaten.de/EMG/00000026",
"type": "boolean"
},
"horizontalFieldWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual horizontal length scanned on the sample defined separately as distanceDetails."
},
"imageMode": {
"description": "(Optional) - The type of image mode used. Could be a text or number depending on the instrument.",
"type": "string"
},
"lensMode": {
"description": "(Optional) - The type of image mode used",
"enum": [
"Field-Free",
"Immersion",
"EDS"
],
"type": "string"
},
"magnificationCorrection": {
"description": "(Optional) - To bet set true if magnification correction is on",
"type": "boolean"
},
"preTilt ": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Sometimes, pre-tilted holders are used and the pretilt angle must be given in the acquisition software because actual tilt = stage tilt plus pretilt."
},
"scanRotation": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Angle by which beam scanning direction is rotated"
},
"tiltCorrectionAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - If the sample is tilted, the image is compressed in the vertical direction, i.e. the pixels are not isotropic anymore. Tilt correction adapts the line spacing of the scanning to compensate for this. IRI:https://purls.helmholtz-metadaten.de/emg/00000037"
},
"tiltCorrectionIsOn": {
"description": "(Optional) - To bet set true if tilt correction is on. IRI:https://purls.helmholtz-metadaten.de/emg/00000037",
"type": "boolean"
},
"verticalFieldWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual vertical length scanned on the sample defined separately as distanceDetails."
}
},
"required": [
"accelerationVoltage",
"verticalFieldWidth",
"horizontalFieldWidth",
"apertureSetting",
"scanRotation"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (nJ, mJ, J, kJ, eV, meV).",
"enum": [
"nJ",
"mJ",
"J",
"kJ",
"eV",
"meV"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"hotStageMEMSDetails": {
"additionalProperties": false,
"description": "describes the parameters related if a hot stage MEMS is used",
"properties": {
"actualTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Describes the actual Temperature measured in the hot stage MEMS"
},
"heatingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Describes the heating current used in the hot stage MEMS"
},
"heatingPower": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Describes the heating power used in the hot stage MEMS"
},
"heatingVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Describes the heating voltage used in the hot stage MEMS"
},
"sampleBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Describes the bias voltage applied to the sample in the hot stage MEMS"
},
"sampleResistance": {
"$ref": "#/$defs/resistanceDetails",
"description": "(Optional) - Describes the target Temperature used in the hot stage MEMS"
},
"targetTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Describes the target Temperature set in the hot stage MEMS"
}
},
"type": "object"
},
"iBeamDetails": {
"additionalProperties": false,
"description": "(Required) - Describes the configuration of the ion beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000016",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The potential difference between anode and cathode. The acceleration voltage adds kinetic energy to the particles of the beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000001 It is defined separately as voltageDetails, (includes the voltage value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - uV, mv, V, kV, MV)"
},
"millingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Electrical current used in SEM-FIB Tomography to mill/cut the sample. In this case this is the same as the beam current of the ion beam. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003 It is defined separately as currentDetails (includes the current value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)."
}
},
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"imageDetails": {
"additionalProperties": false,
"description": "(Required) - describes the settings related to imaging",
"properties": {
"digitalBrightness": {
"description": "(Required) - A number indicating the setting for digital brightness (a basic post-processing method)",
"type": "number"
},
"digitalContrast": {
"description": "(Required) - A number indicating the setting for digital contrast (a basic post-processing method)",
"type": "number"
},
"digitalGamma": {
"description": "(Required) - A number indicating the setting for digital Gamma (a basic post-processing method)",
"type": "number"
},
"driftcorrected": {
"description": "(Required) - To bet set true if drift correction is on",
"type": "boolean"
},
"numberOfPixels": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The number of x, y pixels of the image (Resolution), defined separately as pixelNumberType with separate entries for integer values of xPixels and yPixels"
},
"postprocessing": {
"description": "(Optional) - Describes the post-processing performed on the image",
"type": "string"
},
"transformation": {
"description": "(Optional) - Describes the transformations performed on the image",
"type": "string"
},
"zoomfactor": {
"description": "(Required) - A number indicating the zoom factor",
"type": "number"
}
},
"required": [
"digitalContrast",
"digitalBrightness",
"digitalGamma",
"numberOfPixels",
"driftcorrected",
"zoomfactor"
],
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"beamType": {
"description": "(Required) - The selected beam",
"enum": [
"EBeam",
"IBeam"
],
"type": "string"
},
"detector": {
"oneOf": [
{
"$ref": "#/$defs/detectorDetails",
"description": "(Required) - Details about the detector used for acquisition."
},
{
"description": "(Required) - Details about the detector(s) used for acquisition.",
"items": {
"$ref": "#/$defs/detectorDetails"
},
"minItems": 1,
"type": "array"
}
]
},
"eBeam": {
"$ref": "#/$defs/eBeamDetails",
"description": "(Required) - Details about the electron beam"
},
"hotStageMEMS": {
"$ref": "#/$defs/hotStageMEMSDetails",
"description": "(Optional) - Pressure maintained inside the chamber (in which the sample is housed) during the measurement"
},
"iBeam": {
"$ref": "#/$defs/iBeamDetails",
"description": "(Required) - Details about the ion beam"
},
"imaging": {
"$ref": "#/$defs/imageDetails",
"description": "(Optional) - Details about the imaging settings"
},
"numberOfDetectors": {
"description": "Number of detectors used for the acquisition",
"type": "number"
},
"scan": {
"$ref": "#/$defs/scanDetails",
"description": "(Required) - Details about the scan settings"
},
"spot": {
"description": "(Optional) - Qualitative index for beam current. Varies with current setting, i.e. 1.6 nA is spot = 1, 3.2 nA is spot = 2, 0.1 nA = spot =-3, so it can also be negative. May vary between different microscope models.",
"type": "number"
}
},
"required": [
"eBeam",
"scan",
"imaging",
"detector"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes the resolution of the image split into number of pixels in x and y directions.",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "describes a power",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (\u00b5W, mW, W, kW, MW).",
"enum": [
"\u00b5W",
"mW",
"W",
"kW",
"MW"
],
"type": "string"
},
"value": {
"description": "(Required) - The power expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi).",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"resistanceDetails": {
"additionalProperties": false,
"description": "describes a resistance",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (abohm, ohm, k ohm, M ohm).",
"enum": [
"abohm",
"ohm",
"k ohm",
"M ohm"
],
"type": "string"
},
"value": {
"description": "(Required) - The resistance expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"scanDetails": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scan settings.",
"properties": {
"average": {
"description": "(Optional) - Number of images averaged at each slice",
"type": "number"
},
"dwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time period during which the beam remains on one position/stationary. IRI: https://purls.helmholtz-metadaten.de/EMG/00000006 "
},
"eScan": {
"additionalProperties": false,
"description": "gives settings pertaining to electron beam scan",
"properties": {
"lineAveraging": {
"description": "(Optional) - Number of lines averaged",
"type": "number"
},
"lineIntegration": {
"description": "(Optional) - Number of lines integrated",
"type": "number"
},
"lineTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) -Time period during which a line is fully scanned."
},
"mainsLock": {
"description": "(Optional) - To bet set true if mains lock is on",
"type": "boolean"
},
"scanInterlacing": {
"description": "(Optional) - Number of scans interlaced. This setting splits an imaging area into blocks defined by the number of lines (from 2 to 8). In the first instance, the first line of each block is scanned, then the second one, etc. This imaging method significantly reduces charging.",
"type": "number"
}
},
"type": "object"
},
"frameTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) -Time period during which a frame is fully scanned. IRI: https://purls.helmholtz-metadaten.de/EMG/00000014 "
},
"horizontalFieldSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the actual horizontal length scanned on the sample defined separately as distanceDetails"
},
"integrate": {
"description": "(Optional) - Number of images integrated at each slice",
"type": "number"
},
"internalScan": {
"description": "(Optional) - To bet set true if internal scan is on",
"type": "boolean"
},
"pixelHeight": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual width of a pixel"
},
"pixelWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual width of a pixel"
},
"scanType": {
"description": "(Optional) - The type of scan E-Scan or I-Scan",
"enum": [
"EScan",
"IScan"
],
"type": "string"
},
"verticalFieldSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the actual vertical length scanned on the sample defined separately as distanceDetails"
}
},
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF).",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time period. IRI:https://purls.helmholtz-metadaten.de/EMG/00000024",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (ps, ns, us, ms, s).",
"enum": [
"ps",
"ns",
"us",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (uV, mV, V, kV, MV, GV).",
"enum": [
"uV",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes a set of images acquired during the course of a SEM/FIB Tomography experiment. The images in each dataset is taken using a detector (SE, BSE, EDS, EBSD) using a specific configuration. This Schema contains only the parameters which are specific to the entire dataset. The parameters which are particular to each image is located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json. The units are by default to be considred as the SI units unless otherwise specified",
"properties": {
"columns": {
"description": "(Optional) - Number of column in the tiled image grab setting",
"type": "number"
},
"datasetType": {
"description": "(Optional) - To be selected from the enumerated list depending on the detector and the angle at which the sample is measured: * SEM Image * SEM Image 2 * EDS * EBSD * BSE * ISE * ISI * SI * InLens * SESI",
"enum": [
"SEM Image",
"SEM Image 2",
"SEM Image 3",
"SEM Image 4",
"SEM Image 5",
"EDS",
"EBSD",
"BSE",
"ISE Image",
"ISI Image",
"SI Image",
"InLens",
"SESI"
],
"type": "string"
},
"definition": {
"description": "(Optional)- Name of the schema to which this entry conforms. In this case, acquisition_dataset is to be written",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Identifier of the dataset. It could be the PID of location where the entire dataset is stored"
},
"images": {
"desription": "(Required) - Array containing the images and their specific parameters. No. of images in the array is described by the numberOfItems parameter at the entry level of this schema",
"items": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json"
},
"type": "array"
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings"
},
"numberOfItems": {
"description": "(Required) - Number of Items (images, files). Depends on the number of slices",
"type": "number"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required)- Details concerning the program (or software) used for aquisition"
},
"rows": {
"description": "(Optional) - Number of rows in the tiled image grab setting",
"type": "number"
},
"tileColumn": {
"description": "(Optional) - The selected column in the tiled image grab setting",
"type": "number"
},
"tileRow": {
"description": "(Optional) - The selected row in the tiled image grab setting",
"type": "number"
},
"user": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/user_description.json",
"description": "(Optional)- The contact information of the user responsible for the measurement"
}
},
"required": [
"program",
"instrument",
"datasetType",
"images",
"numberOfItems"
],
"title": "acquisition_dataset",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 32bdbf72c5dcd939888146b1844041950f57347d | 2023-11-24T16:58:56 | SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "degree",
"description": "(Optional) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (pA, nA, \u00b5A, mA, A)",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the current",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "Pa",
"description": "(Optional) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"stage": {
"additionalProperties": false,
"description": "Describes the stage.",
"properties": {
"activeStage": {
"description": "(Required)- Describes the stage in use",
"type": "string"
},
"specTilt": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional)- Pretilt of the sample, usually due to pretilted holder."
},
"stageM": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- M coordinate of the position of the stage (additional translation axis available in Zeiss instruments)"
},
"stageR": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Angle by which the stage is rotated"
},
"stageTa": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Tilt angle alpha of the stage"
},
"stageTb": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Tilt angle beta of the stage"
},
"stageX": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- X coordinate of the position of the stage"
},
"stageY": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Y coordinate of the position of the stage"
},
"stageZ": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Z coordinate of the position of the stage"
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. IRI: https://purls.helmholtz-metadaten.de/EMG/00000026"
}
},
"required": [
"workingDistance",
"stageX",
"stageY",
"stageZ",
"stageR",
"stageTa",
"stageTb",
"activeStage"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"vacuum": {
"additionalProperties": false,
"description": "Describes the vacuum maintained in the system.",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- The pressure maintained in the electron chamber"
},
"gas": {
"description": "(Required)- The gas used in the electron chamber",
"type": "string"
},
"humidity": {
"description": "(Required)- Describes the humidity in the chamber during the measurement",
"type": "string"
},
"userMode": {
"description": "(Required)- The type of vacuum slected by the user",
"enum": [
"High vacuum",
"Medium vacuum",
"Low vacuum"
],
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes an individual image acquired during the course of a SEM/FIB Tomography experiment. Each image is taken using a detector (SE, BSE, EDS, EBSD) at each slice cut using FIB. This Schema contains only the parameters which are specific to the individual image. The parameters which are common to the entire set are described by another schema which describes the dataset as a whole and is located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json.",
"properties": {
"creationTime": {
"description": "(Required)- Time of creation of the image",
"pattern": "(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z)",
"type": "string"
},
"definition": {
"description": "(Required)- Name of the schema to which this entry conforms. In this case, acquisition_image should be written",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Identifier of the image produced by the machine"
},
"fileLink": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Link to the location of the image"
},
"fileName": {
"description": "(Required)- File name of the image",
"type": "string"
},
"specimenCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required)- Current measured on the specimen during acquisition of the image"
},
"stage": {
"$ref": "#/$defs/stage",
"description": "(Required)- Details concerning stage settings used for aquisition"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required)- Temperature of the sample during acquisition"
},
"vacuum": {
"$ref": "#/$defs/vacuum",
"description": "(Required)- Details concerning the vacuum during aquisition"
}
},
"required": [
"creationTime",
"stage",
"vacuum"
],
"title": "acquisition_image",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 723a0408312be41e4499a3ad2861d799df65f78f | 2023-06-06T08:39:25 | Reference_Dataset_Zenodo/PP18_dataset_metadata_Schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$id": "https://github.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/blob/main/PP18_dataset_metadata_Schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes the metadata of the reference dataset by BAM It contains the metadata of the results of ASTM E139 -11 creep tests on a reference material of Nimonic 75 nickel-base alloy",
"properties": {
"access_right": {
"description": " (Required) - Type of access right. e.g. open",
"type": "string"
},
"access_right_category": {
"description": "(Optional) - to be given as success if the document is open-access",
"type": "string"
},
"communities": {
"description": "Details about a collaborative community to which the data belongs",
"items": {
"properties": {
"id": {
"description": "ID of the community as a string. eg. bam",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"creators": {
"items": {
"properties": {
"affiliation": {
"description": "(Required) - Details of the institution to which the creator is affiliated",
"type": "string"
},
"name": {
"description": " (Required) - Full name of the creator in the format (Family Name, Given Name)",
"type": "string"
},
"orcid": {
"description": "(Optional) - Open Researcher and Contributor ID",
"pattern": "^[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[X0-9]{1}$",
"type": "string"
}
},
"required": [
"name",
"affiliation"
],
"type": "object"
},
"type": "array"
},
"description": {
"description": "Elaborate Information on the data",
"type": "string"
},
"doi": {
"description": "(Required) - DOI of the document",
"type": "string"
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"language": {
"description": "(Required) - Language of the Document",
"type": "string"
},
"license": {
"description": "(Required) - Describes the License under which the documents are protected",
"properties": {
"id": {
"description": "(Required) - id of the license, eg. CC-BY-4.0",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"notes": {
"description": "(Optional) - Additional notes",
"type": "string"
},
"publication_date": {
"pattern": "(\\d{4}-\\d{2}-\\d{2})",
"type": "string"
},
"related_identifiers": {
"items": {
"properties": {
"identifier": {
"description": " (Required) - Value of the identifier",
"type": "string"
},
"relation": {
"description": " (Required) - Relation of the related resource, eg: isVersionOf",
"type": "string"
},
"scheme": {
"description": " (Required) - Type of the identifier, eg. DOI",
"type": "string"
}
},
"required": [
"scheme",
"identifier",
"relation"
],
"type": "object"
},
"type": "array"
},
"relations": {
"description": "(Required) - Describes the relations the document has to other documents and versions",
"properties": {
"version": {
"items": {
"properties": {
"count": {
"description": "(Required) - No. of versions at present",
"type": "number"
},
"index": {
"description": "(Required) - Index of the version",
"type": "number"
},
"is_last": {
"description": "(Required) - Is this version the latest one?",
"type": "boolean"
},
"last_child": {
"description": "(Optional) - Details of the ltest child version",
"properties": {
"pid_type": {
"description": "(Optional) - Type of the PID, eg. recid",
"type": "string"
},
"pid_value": {
"description": "(Optional) -Value of the PID",
"type": "string"
}
},
"type": "object"
},
"parent": {
"description": "(Optional) - Details about the parent version",
"properties": {
"pid_type": {
"description": "(Optional) - Type of the PID, eg. recid",
"type": "string"
},
"pid_value": {
"description": "(Optional) -Value of the PID",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"count",
"index",
"is_last"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"version"
],
"type": "object"
},
"resource_type": {
"properties": {
"title": {
"description": " (Required) - Title of the resource. eg. Dataset",
"type": "string"
},
"type": {
"description": " (Required) - Type of the resource. eg. dataset, image",
"type": "string"
}
},
"required": [
"type",
"title"
],
"type": "object"
},
"version": {
"type": "string"
}
},
"required": [
"version",
"creators",
"access_right",
"resource_type",
"publication_date",
"language",
"description",
"doi",
"license"
],
"title": "Metadata of BAM reference data: results of ASTM E139 -11 creep tests on a reference material of Nimonic 75 nickel-base alloy",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | dc83d55d23cc448877a0a9eb2a7ea23d4957be93 | 2024-02-26T12:40:52 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"CTAquisition": {
"additionalProperties": false,
"description": "(Required) - Details about the acquisition.",
"properties": {
"acquisitionScriptName": {
"description": "(Required) - Name of the script used for acquisition.",
"type": "string"
},
"acquisitionTimePerProjection": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time taken for acquisition of a single projection. Typical unit - s."
},
"angularStepSize": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Step size of the rotation of the sample during the CT. Typical unit - degree."
},
"contrastType": {
"description": "(Required) - The contrast type(mode) used - Absorption Contrast or Phase Contrast. If 'Phase Contrast' is selected, please indicate the used Phase Contrast Mode under the field phaseContrastMode.",
"enum": [
"Absorption Contrast",
"Phase Contrast"
],
"type": "string"
},
"endAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - End angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then endAngle is 180\u00b0. Typical unit - degree."
},
"largeFOV": {
"description": "(Required) - To be set to true if large field of view or wide field of view is used.",
"type": "boolean"
},
"numberOfProjections": {
"description": "(Required) - Number of projections acquired during the CT.",
"type": "number"
},
"phaseContrastMode": {
"description": "(Optional) - The phase contrast mode used during acquisition - Zernike phase contrast, propagation-based, grating-based(Hartmann), grating-based(Talbot).",
"enum": [
"Zernike phase contrast",
"Propagation-based",
"Grating-based(Hartmann)",
"Grating-based(Talbot)"
],
"type": "string"
},
"referenceImages": {
"additionalProperties": false,
"description": "(Optional) - Details on the reference images (if used) - number of flats/bright images and number of dark images.",
"properties": {
"numberOfBrightImages": {
"description": "(Optional) - Number of flats or bright images used as reference.",
"type": "number"
},
"numberOfDarkImages": {
"description": "(Optional) - Number of dark images used as reference.",
"type": "number"
}
},
"type": "object"
},
"scanningMode": {
"description": "(Optional) - The scanning mode used during acquisition - helical, raster scanning, fast CT.",
"enum": [
"Helical",
"Raster Scanning",
"Fast CT"
],
"type": "string"
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Start angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then startAngle is -180\u00b0. Typical unit - degree."
},
"totalAcquisitionTime": {
"description": "(Required) - Time taken for acquisition for the entire scan. This is the total scan time, i.e. number of projections multipled by exposure time, but including read-out time. calculated as EndTime-StartTime. Format: hh:mm:ss.",
"format": "time",
"pattern": "^(\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?)$",
"type": "string"
},
"useBadPixelMap": {
"description": "(Optional) - To be set to true if bad pixel map is used. This parameter is relevant for SEM based CT.",
"type": "boolean"
}
},
"required": [
"acquisitionScriptName",
"startAngle",
"endAngle",
"angularStepSize",
"acquisitionTimePerProjection",
"totalAcquisitionTime",
"largeFOV",
"contrastType"
],
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian) of datatype string.",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"angleSet": {
"additionalProperties": false,
"description": "(Optional) - Tilt angles alpha, beta and gamma decribing the three angular positions of an item.",
"properties": {
"alpha": {
"description": "(Optional) - Tilt angle alpha of the item.",
"type": "number"
},
"anglesUnit": {
"description": "(Optional) - unit of the angles (allowed units - degree or radian)",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"beta": {
"description": "(Optional) - Rotation angle beta of the item.",
"type": "number"
},
"gamma": {
"description": "(Optional) - Angle gamma of the item.",
"type": "number"
}
},
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A).",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"data": {
"additionalProperties": false,
"description": "(Required) - Details about the data section of the measurement.",
"properties": {
"projections": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"cropping": {
"additionalProperties": false,
"description": "(Optional) - Details about cropping or clipping to select a region of interest(ROI).",
"properties": {
"ROI": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The size of the region of interest (ROI) in integer values of xPixels and yPixels."
},
"offset": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The offset applied to the origin (i.e., centre of the image) to select the region of interest in x and y coordinates."
}
},
"required": [
"ROI",
"offset"
],
"type": "object"
},
"projectionImageDataStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the data structure of the image data of the projections.",
"properties": {
"IOValue": {
"description": "(Required) - The IO value obtained from the metadata.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The dimension of the image as for integer values of xPixels and yPixels."
},
"fileLocation": {
"description": "(Required) - The location where the data file is stored. A URL is preferred if available.",
"type": "string"
},
"greyValueRepresentation": {
"description": "(Optional) - Description about the grey value representation.",
"type": "string"
},
"header": {
"additionalProperties": false,
"description": "(Required) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Required) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"imageCorrection": {
"additionalProperties": false,
"description": "(Optional) - Details about the image correction.",
"properties": {
"isImageCorrected": {
"description": "(Required) - To be set as true if image is corrected.",
"type": "boolean"
},
"linkToReferenceImages": {
"description": "(Required) - Link to the reference images (flats/darks).",
"format": "uri-reference",
"type": "string"
}
},
"required": [
"isImageCorrected",
"linkToReferenceImages"
],
"type": "object"
},
"imageFormats": {
"additionalProperties": false,
"description": "(Required) - The file formats of the images - tiff, png, jpeg. When more than one file formats are there, then the formats are to be entered as an array of strings.",
"properties": {
"fileFormats": {
"oneOf": [
{
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
{
"items": {
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"fileFormats"
],
"type": "object"
},
"imageID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the Image Data."
},
"isPreFiltered": {
"description": "(Optional) - To be set as true if image is prefiltered.",
"type": "boolean"
},
"name": {
"description": "(Required) - Name of the Projection Image Data.",
"type": "string"
},
"numberOfImages": {
"description": "(Required) - Number of images in the data set. It is same as the number of projections.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical x,y length imaged by a single pixel, normally expressed in \u00b5m."
}
},
"required": [
"fileLocation",
"name",
"imageFormats",
"header"
],
"type": "object"
}
},
"required": [
"projectionImageDataStructure"
],
"type": "object"
},
"reconstructedData": {
"additionalProperties": false,
"description": "(Required) - Details about the reconstructed slices. When multiple reconstructions of the same raw data (projections) are present, the corresponding data can be combined as an array of reconstruction data sets, else as a single reconstruction data set.",
"properties": {
"reconstruction": {
"oneOf": [
{
"$ref": "#/$defs/reconstruction"
},
{
"items": {
"$ref": "#/$defs/reconstruction"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"reconstruction"
],
"type": "object"
}
},
"required": [
"projections",
"reconstructedData"
],
"type": "object"
},
"detector": {
"additionalProperties": false,
"description": "gives the settings of a detector or multiple detectors.",
"properties": {
"detectorSettings": {
"oneOf": [
{
"$ref": "#/$defs/detectorSettings"
},
{
"items": {
"$ref": "#/$defs/detectorSettings"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"detectorSettings"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "(Required) - Gives the settings of a single detector.",
"properties": {
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each pixel or voxel in an image. The bit depth determines the number of possible intensity levels that can be assigned to each pixel or voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"cameraGain": {
"description": "(Optional) - The amplification (gain) of the signal from an image sensor in a camera.",
"type": "number"
},
"detectorCoolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Cooling temperature of the detector, if it cooled. Relevant for SEM based CT. Typical unit - K."
},
"detectorDimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Optional) - The dimensions of the detector in integer values of xPixels and yPixels."
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector."
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the detector (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"detectorMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - The motor positions of the detector in cartesian coordinates and tilt angles."
},
"detectorName": {
"description": "(Optional) - Name of the detector of datatype string.",
"type": "string"
},
"detectorPixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical length in cartesian coordinates imaged by a single pixel of the detector. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"detectorType": {
"description": "(Optional) - The type of detector to be selected from a controlled list consisting of CCD, Panel, PCXD, CMOS, Time-Delay Integration (TDI) and Direct Conversion.",
"enum": [
"CCD",
"Panel",
"PCXD",
"CMOS",
"Time-Delay Integration (TDI)",
"Direct Conversion"
],
"type": "string"
},
"energyThreshold": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - A specific energy level used to filter the detected radiation."
},
"exposureTimePerFrame": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Time for which the sample is exposed per frame. Typical unit - s."
},
"frameSkip": {
"additionalProperties": false,
"description": "(Optional) - A numerical representation indicating the number of frames that are skipped or omitted during the acquisition or recording process. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3. If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped.",
"properties": {
"value": {
"oneOf": [
{
"description": "(Optional) - Number of frames skipped during acquisition. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3.",
"type": "number"
},
{
"description": "(Optional) - Pattern of frames skipped during acquisition. E.g. - If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped like [1,3,5]",
"items": {
"type": "number"
},
"minItems": 1,
"type": "array"
}
]
}
},
"type": "object"
},
"framesPerSecond": {
"description": "(Optional) - The number of frames captured in a second.",
"type": "number"
},
"imagePixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical length in cartesian coordinates imaged by a single pixel of the image. It is the native pixel size divided by the total magnification. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"lens": {
"additionalProperties": false,
"description": "(Optional) - Details of a lens, if used with the detector.",
"properties": {
"hasLens": {
"description": "(Required) - To be set to true if the detector has a lens.",
"type": "boolean"
},
"lensFocalLength": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Focal length of the lens."
},
"lensID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the lens."
},
"lensMagnification": {
"description": "(Optional) - Magnification of the lens as a floating point number.",
"type": "number"
},
"lensManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the lens (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"lensName": {
"description": "(Optional) - Name of the lens of datatype string.",
"type": "string"
}
},
"required": [
"lensMagnification",
"lensFocalLength"
],
"type": "object"
},
"numberOfAveragedFramesPerProjection": {
"description": "(Optional) - The number of averaged frames per projection, if averaging is done.",
"type": "number"
},
"sensor": {
"additionalProperties": false,
"description": "(Optional) - Details about a sensor, if present.",
"properties": {
"hasSensor": {
"description": "(Required) - To be set to true if the detector has a sensor.",
"type": "boolean"
},
"sensorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the sensor."
},
"sensorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the sensor (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"sensorMaterial": {
"description": "(Optional) - Material of the sensor of datatype string.",
"type": "string"
},
"sensorName": {
"description": "(Optional) - Name of the sensor of datatype string.",
"type": "string"
},
"sensorThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the sensor."
},
"sensorType": {
"description": "(Optional) - The type of sensor as a string.",
"type": "string"
}
},
"required": [
"hasSensor"
],
"type": "object"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Temperature of the detector."
},
"totalCountsPerProjection": {
"description": "(Optional) - The sum of the intensity values recorded by the X-ray detector for a single projection during a scan.",
"type": "number"
}
},
"required": [
"detectorType",
"detectorManufacturer",
"binning",
"detectorMotorPositions",
"imagePixelSize"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m).",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ).",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min). Typical unit - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"geometry": {
"additionalProperties": false,
"description": "Describes the geometry of the CT instrument",
"properties": {
"beamGeometry": {
"additionalProperties": false,
"description": "(Required) - Details about beam geometry like beam geometry type and divergence angle.",
"properties": {
"beamGeometryType": {
"description": "(Required) - The type of the beam geometry to be selected between 'collimated' and 'divergent'.",
"enum": [
"collimated",
"divergent"
],
"type": "string"
},
"divergenceAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Angle of divergence when the beam geometry is divergent. Typical unit - degree."
}
},
"type": "object"
},
"geometricMagnification": {
"description": "(Required) - Geometric magnification refers to the ratio of the size of an object's image to the size of the object itself. It is a measure of how much larger the image appears compared to the actual object. Geometric magnification (M) is calculated using the formula M = (SID + SOD) / SID, where SID is the source-to-image distance and SOD is the source-to-object distance.",
"type": "number"
},
"objectToDetectorDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the object and the detector. Typical unit - \u00b5m."
},
"opticalMagnification": {
"description": "(Required) - Optical magnification is calculated as the ratio of the focal length of the objective lens to the focal length of the eyepiece (if an eyepiece is present) in a traditional optical microscope.",
"type": "number"
},
"sourceToObjectDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the source and the object. Typical unit - \u00b5m."
}
},
"required": [
"sourceToObjectDistance",
"objectToDetectorDistance",
"beamGeometry",
"geometricMagnification",
"opticalMagnification"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"CTAquisition": {
"$ref": "#/$defs/CTAquisition",
"description": "(Optional) - Details regarding the acquisition."
},
"calibration": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the calibration and the scaling factor.",
"properties": {
"calibrationType": {
"description": "(Optional) - Type of calibration as a string.",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (YYYY-MM-DDThh:mm:ss.sss) in the ISO 8601 date-time format",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z?)$",
"type": "string"
},
"systemScaling": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scaling factor.",
"properties": {
"adjustSystemScaling": {
"description": "(Required) - To be set to true if system scaling is adjusted, else false.",
"type": "boolean"
},
"measuredScalingFactor": {
"description": "(Optional) - Value of the measured scaling factor.",
"type": "number"
},
"referenceScalingFactor": {
"description": "(Optional) - Value of the reference scaling factor, determined ususally during the data processing.",
"type": "number"
}
},
"required": [
"adjustSystemScaling"
],
"type": "object"
}
},
"type": "object"
},
"detector": {
"$ref": "#/$defs/detector",
"description": "(Optional) - Details regarding the detector."
},
"focalSpotMode": {
"additionalProperties": false,
"description": "(Optional) - Option for setting the size of the focal spot. Some sources have the option to select the target spot size, or focal spot size absolutely by setting a value, while some others give the option of selecting 'small', 'medium' or 'large'. Smaller spot size = higher resolution. Note that the power/current will change with this value. In addition, the detector settings will usually be selected in conjunction. (different scintillator/lens/magnification).",
"properties": {
"selection": {
"description": "(Optional) - Selection of the setting of the size of the focal spot when the option for setting the size of the focal spot by selecting 'small', 'medium' or 'large' according to predefined values set by the manufacturer.",
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the target spot when the option for setting the size of the focal spot absolutely by setting a value is available."
}
},
"type": "object"
},
"geometry": {
"$ref": "#/$defs/geometry",
"description": "(Optional) - Details regarding the geometry."
},
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"optics": {
"$ref": "#/$defs/optics",
"description": "(Optional) - Details about the optics and individual motor positions."
},
"sampleStage": {
"$ref": "#/$defs/sampleStage",
"description": "(Optional) - Details regarding the sample stage."
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray target in an SEM based CT set-up.",
"properties": {
"SEMManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the scanning electron microscope used for SEM based CT."
},
"SEMName": {
"description": "(Required) - Name of the scanning electron microscope used for SEM based CT.",
"type": "string"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the material which acts as the cathode in SEM based CT",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required) - Details of the pressure maintained in the chamber of the SEM."
},
"electronBeamShift": {
"additionalProperties": false,
"description": "(Required) - The distance by which the electron beam is shifted in the x and y directions.",
"properties": {
"xShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the x direction. Typical unit - \u00b5m."
},
"yShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xShift",
"yShift"
],
"type": "object"
},
"electronProbeCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required) - The electron current measured at the probe. Typical unit - \u00b5A."
},
"objectiveLensAperture": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). Typically the diameter of the aperture is set in \u00b5m."
},
"target": {
"additionalProperties": false,
"description": "(Required) - Details regarding the target in SEM based CT, which upon interaction with the e-beam produces the X-rays.",
"properties": {
"targetDriftCorrection": {
"description": "(Required) - If drift correction is activated for the target, this parameter has to be set to true.",
"type": "boolean"
},
"targetMaterial": {
"description": "(Required) - Material with which the target is made.",
"type": "string"
},
"targetShape": {
"description": "(Optional) - Description of the shape or geometry of the target. e.g. - bulk, foil, needle.",
"type": "string"
},
"targetThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Thickness of the target (dimension in Z direction). Default unit - \u00b5m."
},
"targetTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the target is tilted. Typical unit - degree."
}
},
"required": [
"targetMaterial",
"targetThickness",
"targetDriftCorrection",
"targetTiltAngle"
],
"type": "object"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Acceleration Voltage set in the SEM. Default unit - kV."
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. In SEM based CT, the beam is focussed on the target material which emits the X-rays upon interaction with the electrons. Default unit - \u00b5m."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray energy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
}
},
"required": [
"chromaticity"
],
"type": "object"
}
},
"required": [
"chamberPressure",
"electronBeamShift",
"workingDistance",
"objectiveLensAperture",
"electronProbeCurrent",
"target"
],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
},
"targetCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current measured at the X-ray target, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"sourceDrift": {
"additionalProperties": false,
"description": "(Optional) - Distance by which the source is shifted during the measurement (i.e., end position - start position).",
"properties": {
"xDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the x direction. Typical unit - \u00b5m."
},
"yDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xDrift",
"yDrift"
],
"type": "object"
},
"sourcePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the source."
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray energy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source",
"focalSpotMode",
"CTAquisition",
"geometry",
"sampleStage",
"detector"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer.",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"bioReactor": {
"additionalProperties": false,
"description": "(Optional) - Details of an in situ bioreactor.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in sterile conditions.",
"type": "boolean"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is decreased. Typical unit - K/min."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is increased, typically in K/min."
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"anvil": {
"description": "(Optional) - The type of anvil used in the in situ load frame (stage) for applying a particular type of force on the sample. Option to be selected from a controlled list consisting of - Compression, Diamond indentation 90\u00b0 cone, Diamond indentation cube corner, Diamond indentation wedge, Tension, Other. If 'Other' is selected, specify the name of the anvil with a description in the field 'otherAnvil'.",
"enum": [
"Compression",
"Diamond indentation 90\u00b0 cone",
"Diamond indentation cube corner",
"Diamond indentation wedge",
"Tension",
"Other"
],
"type": "string"
},
"blindAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - ed by the load frame(stage). Example: for a CT normally scanned over 180\u00b0 (e.g. -90\u00b0/+90\u00b0), a blind angle of 40\u00b0 due to the in situ cell implies that only 180\u00b0-40\u00b0=140\u00b0 (e.g. -70\u00b0/70\u00b0) is visible. NOTE: for a CT normally scanned over 360\u00b0 (e.g. -180\u00b0/+180\u00b0), a blind angle of 40\u00b0 would require the subtraction of the blind angle twice, implying two scan ranges of 140\u00b0 each (e.g. -160\u00b0/-20\u00b0 and +20\u00b0/+160\u00b0). Typical unit - degree."
},
"displacement": {
"additionalProperties": false,
"description": "(Optional) - Specification on how displacement is applied on the sample. Either 'displacementRate' in \u00b5m/min or 'displacementIncrement' in \u00b5m/acquisition need to be selected.",
"properties": {
"displacementIncrement": {
"description": "(Optional) - The step at which displacement is changed per acquisition in \u00b5m/acquisition.",
"type": "number"
},
"displacementRate": {
"description": "(Optional) - The rate at which displacement is applied on the sample in \u00b5m/min.",
"type": "number"
}
},
"type": "object"
},
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame or anvil (e.g. - size of anvil) relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
},
"maximumDisplacement": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - The maximum displacement allowed in the selected configuration. Typical unit - \u00b5m."
},
"maximumForce": {
"description": "(Optional) - The maximum force that can be applied to the sample in N.",
"type": "number"
},
"otherAnvil": {
"description": "(Optional) - If 'anvil' was selected as 'Other' from the controlled list as it was not listed, please specify the name of the anvil with a description in this field.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the vacuum chamber relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the vacuum chamber relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the vacuum chamber."
},
"chamberName": {
"description": "(Optional) - Name of the vacuum chamber.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"motorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchical level and direction of a motor.",
"properties": {
"motorDirection": {
"description": "(Required) - The direction of movement (for X,Y,Z,M motors) or axis of rotation (for rotating motors) expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the X-stage and perpendicular to the Y-stage. then beam direction = [1 0 0], X-stage-direction = [1 0 0] (positive movement direction away from source towards detector) or can be (-1 0 0) (towards source) and Y-stage-direction = [0 1 0] or can be [0 -1 0] (analogous interpretation). The parameters need to be individually determined for each instrument. For rotating motors, the directional vector of axis of rotation should be given in Cartesian coordinates (counterclockwise, right-hand rule).",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"motorLevel": {
"description": "(Required) - Hierarchy of the motor expressed as an integer.",
"type": "number"
}
},
"type": "object"
},
"motorPositions": {
"additionalProperties": false,
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the motor.",
"properties": {
"angles": {
"$ref": "#/$defs/angleSet",
"description": "(Optional) - The three tilt angles alpha, beta and gamma of the motors controlling the position of the item."
},
"xyzPositions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - The xyz coordinates describing the motor positions of the item."
}
},
"type": "object"
},
"optics": {
"additionalProperties": false,
"description": "(Optional) - Details about the optics and individual motor positions.",
"properties": {
"collimator": {
"additionalProperties": false,
"description": "(Optional) - Details about the collimator and its individual motor positions.",
"properties": {
"collimatorDetails": {
"description": "(Optional) - Details about the collimator relevant for the measurement.",
"type": "string"
},
"collimatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the collimator."
}
},
"type": "object"
},
"condenser": {
"additionalProperties": false,
"description": "(Optional) - Details about the condenser lens and its individual motor positions, if used.",
"properties": {
"condenserDetails": {
"description": "(Optional) - Details about the condenser relevant for the measurement.",
"type": "string"
},
"condenserPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the condenser."
}
},
"type": "object"
},
"fresnelZonePlate": {
"additionalProperties": false,
"description": "(Optional) - Details about the fresnel zone plate and its individual motor positions, if used.",
"properties": {
"fresnelZonePlateDetails": {
"description": "(Optional) - Details about the fresnel zone plate relevant for the measurement.",
"type": "string"
},
"fresnelZonePlatePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the fresnel zone plate."
}
},
"type": "object"
},
"monochromator": {
"additionalProperties": false,
"description": "(Required) - Details about the monochromator and individual motor positions, if used.",
"properties": {
"monochromatorDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the monochromator type type, material, energy and notes.",
"properties": {
"energy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Energy set in the monochromator. Typical unit - eV."
},
"material": {
"description": "(Optional) - Material of the monochromator.",
"type": "string"
},
"monochromatorType": {
"description": "(Optional) - Type of the monochromator.",
"type": "string"
},
"notes": {
"description": "(Optional) - Additional information about the monochromator relevant for the measurement."
}
},
"type": "object"
},
"monochromatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the monochromator."
},
"monochromatorUsed": {
"description": "(Required) - To be set to true if monochromator is used, else false.",
"type": "boolean"
}
},
"required": [
"monochromatorUsed"
],
"type": "object"
},
"phaseRing": {
"additionalProperties": false,
"description": "(Required) - Details about the phase ring and its individual motor positions, if inserted.",
"properties": {
"phaseRingDetails": {
"description": "(Optional) - Details about the phase ring relevant for the measurement.",
"type": "string"
},
"phaseRingPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the phase ring."
}
},
"type": "object"
}
},
"required": [
"monochromator"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes a parameter which can be split into number of pixels in x and y directions like the resolution",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm or \u00b5m, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the size of a single pixel (typical value - nm, \u00b5m) of datatype string",
"enum": [
"nm",
"\u00b5m"
],
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min).",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW).",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi).",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"rampDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a rate at which temperature is increased or decreased.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K/min, K/s).",
"enum": [
"K/min",
"K/s"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of temperature increase or decrease.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"reconstruction": {
"additionalProperties": false,
"description": "Data from one single reconstruction.",
"properties": {
"reconstructionDetails": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"additionalFilters": {
"beamHardeningCorrection": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"filterType": {
"description": "(Optional) - Type of the additional filter - Median or Gauss",
"enum": [
"Median",
"Gauss"
],
"type": "string"
},
"phaseRetrieval": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"ringFilter": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
}
},
"algorithm": {
"description": "(Required) - Algorithm used for reconstruction to be selected from FBP - Filtered Back Projection, ART - Algebraic Reconstruction Technique, 3dCT - 3D Computed Tomography and Gridrec.",
"enum": [
"FBP - Filtered Back Projection",
"ART - Algebraic Reconstruction Technique",
"3dCT - 3D Computed Tomography",
"Gridrec"
],
"type": "string"
},
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepthConversionMax": {
"description": "(Required) - Maximum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"bitDepthConversionMin": {
"description": "(Required) - Minimum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"hardwarePlatform": {
"description": "(Optional) - Hardware platform used for reconstruction to be selected between CPU and GPU.",
"enum": [
"CPU",
"GPU"
],
"type": "string"
},
"lastImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the last image for the reconstruction of the 3D Volume, typically an integer.",
"type": "string"
},
"projectionPadding": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the projection padding applied to the raw projection data to address certain issues in the reconstruction process.",
"properties": {
"paddingSize": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - Size of the projection padding used in pixels."
},
"paddingType": {
"description": "(Required) - Type of the projection padding used - Zero Padding, Linear Interpolation Padding, Sinc Interpolation Padding, Shepp-Logan Filtered Back Projection (SL-FBP), Gridding and Extended Field of View (FOV) Padding.",
"enum": [
"Zero Padding",
"Linear Interpolation Padding",
"Sinc Interpolation Padding",
"Shepp-Logan Filtered Back Projection (SL-FBP)",
"Gridding",
"Extended Field of View (FOV) Padding"
],
"type": "string"
}
},
"type": "object"
},
"reconstructionSoftware": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for reconstruction. It may be the same as the acquisition software or a different one."
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Scan angle at which the reconstruction of the 3D Volume starts. Typical unit - degree."
},
"startImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the start image for the reconstruction of the 3D Volume.",
"type": "string"
},
"tomographicProjectionFilter": {
"description": "(Optional) - Name of the tomographic projection filter used to be selected from Ram-Lak Filter, Butterworth Filter, Shepp-Logan Filter, Hann (Hanning) Filter, Gaussian Filter, Cosine Filter, Soft Filtration Method and Hard Filtration Method.",
"enum": [
"Ram-Lak Filter",
"Butterworth Filter",
"Shepp-Logan Filter",
"Hann (Hanning) Filter",
"Gaussian Filter",
"Cosine Filter",
"Soft Filtration Method",
"Hard Filtration Method"
],
"type": "string"
}
},
"required": [
"startImage",
"lastImage",
"startAngle",
"hardwarePlatform",
"algorithm",
"binning"
],
"type": "object"
},
"volumeStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each voxel in the 3D volume. The bit depth determines the number of possible intensity levels that can be assigned to each voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Required) - The dimension of the 3D volume in XYZ coordinates. If the length in Z dimension is not known and instead only the number of slices are known, they need to be separately entered in the field 'numberOfSlices'. Typical unit - \u00b5m."
},
"header": {
"additionalProperties": false,
"description": "(Optional) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Optional) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"name": {
"description": "(Required) - Name of the 3D volume structure (dataset).",
"type": "string"
},
"numberOfSlices": {
"description": "(Optional) - No. of slices which make up the 3D volume.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel/voxel, normally expressed in \u00b5m."
},
"volumeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry of the 3D reconstructed volume usually provided by the project or the laboratory."
}
},
"required": [
"name",
"dimensions",
"bitDepth",
"pixelSize"
],
"type": "object"
}
},
"required": [
"volumeStructure",
"reconstructionDetails"
],
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"sampleStage": {
"additionalProperties": false,
"description": "(Required) - Details about sample stage.",
"properties": {
"stageMotorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchy of the stage motors. This information is required to know how the motor movements affect the positions of the samples, particularly relevant for correlative characterization.",
"properties": {
"beamDirection": {
"description": "(Required) - The beam direction expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the Y-stage and perpendicular to the X-stage. then beam direction = [0 1 0].",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"mMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the M motor (stage) as a vector in cartesian coordiantes. The M motor is usually relevant only for SEM based CT. It is a special motor which counteracts the Z motor."
},
"rMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the R motor (stage) as a vector in cartesian coordiantes. R motor has rotation around z axis +1 (for anticlockwise)."
},
"tMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the T motor (stage) as a vector in cartesian coordiantes. The T motor is usually relevant only for SEM based CT."
},
"xMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the X motor (stage) as a vector in cartesian coordinates."
},
"yMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Y motor (stage) as a vector in cartesian coordinates."
},
"zMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Z motor (stage) as a vector in cartesian coordinates."
}
},
"required": [
"beamDirection",
"xMotor",
"yMotor",
"zMotor",
"rMotor"
],
"type": "object"
},
"stageMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the stage motors."
}
},
"required": [
"stageMotorHierarchy"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s).",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"user": {
"description": "Basic schema for user description. It can be extended.",
"properties": {
"ORCID": {
"description": "(Optional) - Open Researcher and Contributor ID expressed as a URI",
"pattern": "^https://orcid\\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[X0-9]{1}$",
"type": "string"
},
"affiliation": {
"description": "(Optional) - Details of the institution to which the user is affiliated",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"description": "(Optional) -Identifier of the institution to which the user is affiliated",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be chosen from a controlled list of values (*ROR *GRID *ISNI *URL *DOI *Handle)",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"email": {
"description": "(Optional) - Email of the user",
"format": "email",
"type": "string"
},
"familyName": {
"description": "(Optional) - Family name of the user",
"type": "string"
},
"givenName": {
"description": "(Optional) - Given name of the user",
"type": "string"
},
"role": {
"description": "(Required) - Role of the research user",
"enum": [
"Data Curator",
"Instrument Scientist",
"Team Leader",
"Team Member"
],
"type": "string"
},
"userName": {
"description": "(Required) - Full name of the user in the format (Family Name, Given Name)",
"type": "string"
}
},
"required": [
"userName",
"role"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV).",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided. Contributors (in alphabetical order of last names): Alexey Boubnov, Rafaela Debastiani, Jonas Fell, Sarah Irvine, Reetu Elza Joseph.",
"properties": {
"consumables": {
"description": "(Optional) - Auxiliary entity used during Fabrication, Sample Preparation or Measurement which has a limited time capacity or is limited in its number of uses before it is disposed of, necessary to the process itself and normally bought from third party manufacturers. Examples are: gloves, syringes, wipes, etching solutions, glass slides, spatulas, weighing paper, two-sided tape.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"data": {
"$ref": "#/$defs/data",
"description": "(Required)- Details concerning the data section of the measurement."
},
"definition": {
"description": "(Required) - Name of the schema to which this entry conforms. In this case, lab_CT should be written.",
"type": "string"
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format YYYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z?)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry usually provided by the project or the laboratory."
},
"equipment": {
"description": "(Optional) - Any kind of physical or virtual item, device, machine or other tools used to perform one or more Fabrication(s), Sample Preparation(s), Model Preparation(s), Data Acquisition(s) and/or any of the processes included in the Data Analysis Lifecycle. Usually, the Equipment is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. Equipment is usually an investment. According to this definition, an Instrument is a particular type of Equipment.",
"type": "string"
},
"experimentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the measurement usually provided by the project or the laboratory."
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings. Instrument is a physical or virtual identifiable piece of Equipment used to perform a Data Acquisition and to generate Raw Data. The Instrument is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. A virtual Instrument may be any computational resource or HPC infrastructure (cloud infrastructure or supercomputer) needed to perform Calculations or Simulations."
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure."
},
"measurementDescription": {
"description": "(Optional) - Description about the measurement.",
"type": "string"
},
"measurementPurpose": {
"description": "(Required) - Measurement is experimental Data Acquisition, typically performed on a Sample using an experimental Technique. It may also be performed during Fabrication or Sample Preparation, e.g., to characterise the intermediate stages and/or the final resulting Precursor(s) or Sample(s), respectively. A Measurement may require the use of Consumables.",
"enum": [
"assessment (to given categories or values)",
"completeness check (presence or absence of given properties)",
"correlative characterization (dedicated sample treatment to emphasise given features)",
"exploratory (routine check of known properties)",
"feasibility (quick check, rough estimate)",
"high quality measurement (precise, careful treatment)",
"test specific hypothesis (focus only on given aspects)",
"other (please specify in the comment)"
],
"type": "string"
},
"parents": {
"description": "(Required) - Parents of this metadata like the metadata document of the sample with which the measurement was performed.",
"items": {
"if": {
"properties": {
"parentType": {
"not": {
"const": "not applicable"
}
}
}
},
"properties": {
"parentReference": {
"description": "If type is 'MetaStore URI' it is possible to easily fill this field in a later stage",
"format": "uri-reference",
"type": "string"
},
"parentReferenceType": {
"default": "MetaStore URI",
"enum": [
"plain text",
"external URL",
"MetaStore URI"
],
"type": "string"
},
"parentType": {
"default": "sample",
"enum": [
"not applicable",
"sample"
],
"type": "string"
}
},
"required": [
"parentType"
],
"then": {
"required": [
"parentReferenceType",
"parentReference"
]
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition."
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format."
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format YYYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z?)$",
"type": "string"
},
"technique": {
"description": "(Required) - Any experimental, theoretical or computational method used during Data Acquisition or during any of the processes included in the Data Analysis Lifecycle to acquire, process or analyse Research Data about a System or a set of them with an Instrument, which is used to generate this metadata.",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement.",
"type": "string"
},
"user": {
"$ref": "#/$defs/user",
"description": "(Required)- The contact information of the user responsible for the measurement."
}
},
"required": [
"title",
"technique",
"definition",
"parents",
"measurementPurpose",
"startTime",
"endTime",
"program",
"user",
"instrument",
"data"
],
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | faeeb3856a267e10bd94c904a5e763ba3ad1e9fe | 2023-06-06T09:00:37 | Reference_Dataset_Zenodo/pp18_file_schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$id": "needs to be updated",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes the metadata of a single file in the reference dataset by BAM. It contains the metadata of the results of ASTM E139 -11 creep tests on a reference material of Nimonic 75 nickel-base alloy",
"properties": {
"bucket": {
"description": "(Required) - string indicating the dataset in which the document is contained",
"type": "string"
},
"checksum": {
"description": "(Required) - checksum of the document",
"type": "string"
},
"key": {
"description": "(Required) - key of the document (File name)",
"type": "string"
},
"links": {
"properties": {
"self": {
"description": "(Required) - URL/ link to the document",
"type": "string"
}
},
"required": [
"self"
],
"type": "object"
},
"size": {
"description": "(Required) - Size of the document in bytes",
"type": "string"
},
"type": {
"description": "(Required) - File type of the document",
"type": "string"
}
},
"required": [
"links",
"checksum",
"bucket",
"key",
"type",
"size"
],
"title": "Metadata of BAM reference data (individual files): results of ASTM E139 -11 creep tests on a reference material of Nimonic 75 nickel-base alloy",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 0f036897334f8de0a92a835b959c27dacb61d06c | 2024-02-20T17:37:47 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"CTAquisition": {
"additionalProperties": false,
"description": "(Required) - Details about the acquisition.",
"properties": {
"acquisitionScriptName": {
"description": "(Required) - Name of the script used for acquisition.",
"type": "string"
},
"acquisitionTimePerProjection": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time taken for acquisition of a single projection. Typical unit - s."
},
"angularStepSize": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Step size of the rotation of the sample during the CT. Typical unit - degree."
},
"contrastType": {
"description": "(Required) - The contrast type(mode) used - Absorption Contrast or Phase Contrast. If 'Phase Contrast' is selected, please indicate the used Phase Contrast Mode under the field phaseContrastMode.",
"enum": [
"Absorption Contrast",
"Phase Contrast"
],
"type": "string"
},
"endAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - End angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then endAngle is 180\u00b0. Typical unit - degree."
},
"largeFOV": {
"description": "(Required) - To be set to true if large field of view or wide field of view is used.",
"type": "boolean"
},
"numberOfProjections": {
"description": "(Required) - Number of projections acquired during the CT.",
"type": "number"
},
"phaseContrastMode": {
"description": "(Optional) - The phase contrast mode used during acquisition - Zernike phase contrast, propagation-based, grating-based(Hartmann), grating-based(Talbot).",
"enum": [
"Zernike phase contrast",
"Propagation-based",
"Grating-based(Hartmann)",
"Grating-based(Talbot)"
],
"type": "string"
},
"referenceImages": {
"additionalProperties": false,
"description": "(Optional) - Details on the reference images (if used) - number of flats/bright images and number of dark images.",
"properties": {
"numberOfBrightImages": {
"description": "(Optional) - Number of flats or bright images used as reference.",
"type": "number"
},
"numberOfDarkImages": {
"description": "(Optional) - Number of dark images used as reference.",
"type": "number"
}
},
"type": "object"
},
"scanningMode": {
"description": "(Optional) - The scanning mode used during acquisition - helical, raster scanning, fast CT.",
"enum": [
"Helical",
"Raster Scanning",
"Fast CT"
],
"type": "string"
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Start angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then startAngle is -180\u00b0. Typical unit - degree."
},
"totalAcquisitionTime": {
"description": "(Required) - Time taken for acquisition for the entire scan. This is the total scan time, i.e. number of projections multipled by exposure time, but including read-out time. calculated as EndTime-StartTime. Format: hh:mm:ss.",
"format": "time",
"pattern": "^(\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?)$",
"type": "string"
},
"useBadPixelMap": {
"description": "(Optional) - To be set to true if bad pixel map is used. This parameter is relevant for SEM based CT.",
"type": "boolean"
}
},
"required": [
"acquisitionScriptName",
"startAngle",
"endAngle",
"angularStepSize",
"acquisitionTimePerProjection",
"totalAcquisitionTime",
"largeFOV",
"contrastType"
],
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian) of datatype string.",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"angleSet": {
"additionalProperties": false,
"description": "(Optional) - Tilt angles alpha, beta and gamma decribing the three angular positions of an item.",
"properties": {
"alpha": {
"description": "(Optional) - Tilt angle alpha of the item.",
"type": "number"
},
"anglesUnit": {
"description": "(Optional) - unit of the angles (allowed units - degree or radian)",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"beta": {
"description": "(Optional) - Rotation angle beta of the item.",
"type": "number"
},
"gamma": {
"description": "(Optional) - Angle gamma of the item.",
"type": "number"
}
},
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A).",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"data": {
"additionalProperties": false,
"description": "(Required) - Details about the data section of the measurement.",
"properties": {
"projections": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"cropping": {
"additionalProperties": false,
"description": "(Optional) - Details about cropping or clipping to select a region of interest(ROI).",
"properties": {
"ROI": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The size of the region of interest (ROI) in integer values of xPixels and yPixels."
},
"offset": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The offset applied to the origin (i.e., centre of the image) to select the region of interest in x and y coordinates."
}
},
"required": [
"ROI",
"offset"
],
"type": "object"
},
"projectionImageDataStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the data structure of the image data of the projections.",
"properties": {
"IOValue": {
"description": "(Required) - The IO value obtained from the metadata.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The dimension of the image as for integer values of xPixels and yPixels."
},
"fileLocation": {
"description": "(Required) - The location where the data file is stored. A URL is preferred if available.",
"type": "string"
},
"greyValueRepresentation": {
"description": "(Optional) - Description about the grey value representation.",
"type": "string"
},
"header": {
"additionalProperties": false,
"description": "(Required) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Required) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"imageCorrection": {
"additionalProperties": false,
"description": "(Optional) - Details about the image correction.",
"properties": {
"isImageCorrected": {
"description": "(Required) - To be set as true if image is corrected.",
"type": "boolean"
},
"linkToReferenceImages": {
"description": "(Required) - Link to the reference images (flats/darks).",
"format": "uri-reference",
"type": "string"
}
},
"required": [
"isImageCorrected",
"linkToReferenceImages"
],
"type": "object"
},
"imageFormats": {
"additionalProperties": false,
"description": "(Required) - The file formats of the images - tiff, png, jpeg. When more than one file formats are there, then the formats are to be entered as an array of strings.",
"properties": {
"fileFormats": {
"oneOf": [
{
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
{
"items": {
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"fileFormats"
],
"type": "object"
},
"imageID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the Image Data."
},
"isPreFiltered": {
"description": "(Optional) - To be set as true if image is prefiltered.",
"type": "boolean"
},
"name": {
"description": "(Required) - Name of the Projection Image Data.",
"type": "string"
},
"numberOfImages": {
"description": "(Required) - Number of images in the data set. It is same as the number of projections.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical x,y length imaged by a single pixel, normally expressed in \u00b5m."
}
},
"required": [
"fileLocation",
"name",
"imageFormats",
"header"
],
"type": "object"
}
},
"required": [
"projectionImageDataStructure"
],
"type": "object"
},
"reconstructedData": {
"additionalProperties": false,
"description": "(Required) - Details about the reconstructed slices. When multiple reconstructions of the same raw data (projections) are present, the corresponding data can be combined as an array of reconstruction data sets, else as a single reconstruction data set.",
"properties": {
"reconstruction": {
"oneOf": [
{
"$ref": "#/$defs/reconstruction"
},
{
"items": {
"$ref": "#/$defs/reconstruction"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"reconstruction"
],
"type": "object"
}
},
"required": [
"projections",
"reconstructedData"
],
"type": "object"
},
"detector": {
"additionalProperties": false,
"description": "gives the settings of a detector or multiple detectors.",
"properties": {
"detectorSettings": {
"oneOf": [
{
"$ref": "#/$defs/detectorSettings"
},
{
"items": {
"$ref": "#/$defs/detectorSettings"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"detectorSettings"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "(Required) - Gives the settings of a single detector.",
"properties": {
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each pixel or voxel in an image. The bit depth determines the number of possible intensity levels that can be assigned to each pixel or voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"cameraGain": {
"description": "(Optional) - The amplification (gain) of the signal from an image sensor in a camera.",
"type": "number"
},
"detectorCoolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Cooling temperature of the detector, if it cooled. Relevant for SEM based CT. Typical unit - K."
},
"detectorDimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Optional) - The dimensions of the detector in integer values of xPixels and yPixels."
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector."
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the detector (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"detectorMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - The motor positions of the detector in cartesian coordinates and tilt angles."
},
"detectorName": {
"description": "(Optional) - Name of the detector of datatype string.",
"type": "string"
},
"detectorPixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical length in cartesian coordinates imaged by a single pixel of the detector. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"detectorType": {
"description": "(Optional) - The type of detector to be selected from a controlled list consisting of CCD, Panel, PCXD, CMOS, Time-Delay Integration (TDI) and Direct Conversion.",
"enum": [
"CCD",
"Panel",
"PCXD",
"CMOS",
"Time-Delay Integration (TDI)",
"Direct Conversion"
],
"type": "string"
},
"energyThreshold": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - A specific energy level used to filter the detected radiation."
},
"exposureTimePerFrame": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Time for which the sample is exposed per frame. Typical unit - s."
},
"frameSkip": {
"additionalProperties": false,
"description": "(Optional) - A numerical representation indicating the number of frames that are skipped or omitted during the acquisition or recording process. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3. If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped.",
"properties": {
"value": {
"oneOf": [
{
"description": "(Optional) - Number of frames skipped during acquisition. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3.",
"type": "number"
},
{
"description": "(Optional) - Pattern of frames skipped during acquisition. E.g. - If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped like [1,3,5]",
"items": {
"type": "number"
},
"minItems": 1,
"type": "array"
}
]
}
},
"type": "object"
},
"framesPerSecond": {
"description": "(Optional) - The number of frames captured in a second.",
"type": "number"
},
"imagePixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical length in cartesian coordinates imaged by a single pixel of the image. It is the native pixel size divided by the total magnification. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"lens": {
"additionalProperties": false,
"description": "(Optional) - Details of a lens, if used with the detector.",
"properties": {
"hasLens": {
"description": "(Required) - To be set to true if the detector has a lens.",
"type": "boolean"
},
"lensFocalLength": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Focal length of the lens."
},
"lensID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the lens."
},
"lensMagnification": {
"description": "(Optional) - Magnification of the lens as a floating point number.",
"type": "number"
},
"lensManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the lens (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"lensName": {
"description": "(Optional) - Name of the lens of datatype string.",
"type": "string"
}
},
"required": [
"lensMagnification",
"lensFocalLength"
],
"type": "object"
},
"numberOfAveragedFramesPerProjection": {
"description": "(Optional) - The number of averaged frames per projection, if averaging is done.",
"type": "number"
},
"sensor": {
"additionalProperties": false,
"description": "(Optional) - Details about a sensor, if present.",
"properties": {
"hasSensor": {
"description": "(Required) - To be set to true if the detector has a sensor.",
"type": "boolean"
},
"sensorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the sensor."
},
"sensorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the sensor (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"sensorMaterial": {
"description": "(Optional) - Material of the sensor of datatype string.",
"type": "string"
},
"sensorName": {
"description": "(Optional) - Name of the sensor of datatype string.",
"type": "string"
},
"sensorThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the sensor."
},
"sensorType": {
"description": "(Optional) - The type of sensor as a string.",
"type": "string"
}
},
"required": [
"hasSensor"
],
"type": "object"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Temperature of the detector."
},
"totalCountsPerProjection": {
"description": "(Optional) - The sum of the intensity values recorded by the X-ray detector for a single projection during a scan.",
"type": "number"
}
},
"required": [
"detectorType",
"detectorManufacturer",
"binning",
"detectorMotorPositions",
"imagePixelSize"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m).",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ).",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min). Typical unit - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"geometry": {
"additionalProperties": false,
"description": "Describes the geometry of the CT instrument",
"properties": {
"beamGeometry": {
"additionalProperties": false,
"description": "(Required) - Details about beam geometry like beam geometry type and divergence angle.",
"properties": {
"beamGeometryType": {
"description": "(Required) - The type of the beam geometry to be selected between 'collimated' and 'divergent'.",
"enum": [
"collimated",
"divergent"
],
"type": "string"
},
"divergenceAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Angle of divergence when the beam geometry is divergent. Typical unit - degree."
}
},
"type": "object"
},
"geometricMagnification": {
"description": "(Required) - Geometric magnification refers to the ratio of the size of an object's image to the size of the object itself. It is a measure of how much larger the image appears compared to the actual object. Geometric magnification (M) is calculated using the formula M = (SID + SOD) / SID, where SID is the source-to-image distance and SOD is the source-to-object distance.",
"type": "number"
},
"objectToDetectorDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the object and the detector. Typical unit - \u00b5m."
},
"opticalMagnification": {
"description": "(Required) - Optical magnification is calculated as the ratio of the focal length of the objective lens to the focal length of the eyepiece (if an eyepiece is present) in a traditional optical microscope.",
"type": "number"
},
"sourceToObjectDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the source and the object. Typical unit - \u00b5m."
}
},
"required": [
"sourceToObjectDistance",
"objectToDetectorDistance",
"beamGeometry",
"geometricMagnification",
"opticalMagnification"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"CTAquisition": {
"$ref": "#/$defs/CTAquisition",
"description": "(Optional) - Details regarding the acquisition."
},
"calibration": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the calibration and the scaling factor.",
"properties": {
"calibrationType": {
"description": "(Optional) - Type of calibration as a string.",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (YYYY-MM-DDThh:mm:ss.sss) in the ISO 8601 date-time format",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"systemScaling": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scaling factor.",
"properties": {
"adjustSystemScaling": {
"description": "(Required) - To be set to true if system scaling is adjusted, else false.",
"type": "boolean"
},
"measuredScalingFactor": {
"description": "(Optional) - Value of the measured scaling factor.",
"type": "number"
},
"referenceScalingFactor": {
"description": "(Optional) - Value of the reference scaling factor, determined ususally during the data processing.",
"type": "number"
}
},
"required": [
"adjustSystemScaling"
],
"type": "object"
}
},
"type": "object"
},
"detector": {
"$ref": "#/$defs/detector",
"description": "(Optional) - Details regarding the detector."
},
"focalSpotMode": {
"additionalProperties": false,
"description": "(Optional) - Option for setting the size of the focal spot. Some sources have the option to select the target spot size, or focal spot size absolutely by setting a value, while some others give the option of selecting 'small', 'medium' or 'large'. Smaller spot size = higher resolution. Note that the power/current will change with this value. In addition, the detector settings will usually be selected in conjunction. (different scintillator/lens/magnification).",
"properties": {
"selection": {
"description": "(Optional) - Selection of the setting of the size of the focal spot when the option for setting the size of the focal spot by selecting 'small', 'medium' or 'large' according to predefined values set by the manufacturer.",
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the target spot when the option for setting the size of the focal spot absolutely by setting a value is available."
}
},
"type": "object"
},
"geometry": {
"$ref": "#/$defs/geometry",
"description": "(Optional) - Details regarding the geometry."
},
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"optics": {
"$ref": "#/$defs/optics",
"description": "(Optional) - Details about the optics and individual motor positions."
},
"sampleStage": {
"$ref": "#/$defs/sampleStage",
"description": "(Optional) - Details regarding the sample stage."
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray target in an SEM based CT set-up.",
"properties": {
"SEMManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the scanning electron microscope used for SEM based CT."
},
"SEMName": {
"description": "(Required) - Name of the scanning electron microscope used for SEM based CT.",
"type": "string"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the material which acts as the cathode in SEM based CT",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required) - Details of the pressure maintained in the chamber of the SEM."
},
"electronBeamShift": {
"additionalProperties": false,
"description": "(Required) - The distance by which the electron beam is shifted in the x and y directions.",
"properties": {
"xShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the x direction. Typical unit - \u00b5m."
},
"yShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xShift",
"yShift"
],
"type": "object"
},
"electronProbeCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required) - The electron current measured at the probe. Typical unit - \u00b5A."
},
"objectiveLensAperture": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). Typically the diameter of the aperture is set in \u00b5m."
},
"target": {
"additionalProperties": false,
"description": "(Required) - Details regarding the target in SEM based CT, which upon interaction with the e-beam produces the X-rays.",
"properties": {
"targetDriftCorrection": {
"description": "(Required) - If drift correction is activated for the target, this parameter has to be set to true.",
"type": "boolean"
},
"targetMaterial": {
"description": "(Required) - Material with which the target is made.",
"type": "string"
},
"targetShape": {
"description": "(Optional) - Description of the shape or geometry of the target. e.g. - bulk, foil, needle.",
"type": "string"
},
"targetThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Thickness of the target (dimension in Z direction). Default unit - \u00b5m."
},
"targetTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the target is tilted. Typical unit - degree."
}
},
"required": [
"targetMaterial",
"targetThickness",
"targetDriftCorrection",
"targetTiltAngle"
],
"type": "object"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Acceleration Voltage set in the SEM. Default unit - kV."
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. In SEM based CT, the beam is focussed on the target material which emits the X-rays upon interaction with the electrons. Default unit - \u00b5m."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray energy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
}
},
"required": [
"chromaticity"
],
"type": "object"
}
},
"required": [
"chamberPressure",
"electronBeamShift",
"workingDistance",
"objectiveLensAperture",
"electronProbeCurrent",
"target"
],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
},
"targetCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current measured at the X-ray target, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"sourceDrift": {
"additionalProperties": false,
"description": "(Optional) - Distance by which the source is shifted during the measurement (i.e., end position - start position).",
"properties": {
"xDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the x direction. Typical unit - \u00b5m."
},
"yDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xDrift",
"yDrift"
],
"type": "object"
},
"sourcePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the source."
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray energy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source",
"focalSpotMode",
"CTAquisition",
"geometry",
"sampleStage",
"detector"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer.",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"bioReactor": {
"additionalProperties": false,
"description": "(Optional) - Details of an in situ bioreactor.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in sterile conditions.",
"type": "boolean"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is decreased. Typical unit - K/min."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is increased, typically in K/min."
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"anvil": {
"description": "(Optional) - The type of anvil used in the in situ load frame (stage) for applying a particular type of force on the sample. Option to be selected from a controlled list consisting of - Compression, Diamond indentation 90\u00b0 cone, Diamond indentation cube corner, Diamond indentation wedge, Tension, Other. If 'Other' is selected, specify the name of the anvil with a description in the field 'otherAnvil'.",
"enum": [
"Compression",
"Diamond indentation 90\u00b0 cone",
"Diamond indentation cube corner",
"Diamond indentation wedge",
"Tension",
"Other"
],
"type": "string"
},
"blindAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - ed by the load frame(stage). Example: for a CT normally scanned over 180\u00b0 (e.g. -90\u00b0/+90\u00b0), a blind angle of 40\u00b0 due to the in situ cell implies that only 180\u00b0-40\u00b0=140\u00b0 (e.g. -70\u00b0/70\u00b0) is visible. NOTE: for a CT normally scanned over 360\u00b0 (e.g. -180\u00b0/+180\u00b0), a blind angle of 40\u00b0 would require the subtraction of the blind angle twice, implying two scan ranges of 140\u00b0 each (e.g. -160\u00b0/-20\u00b0 and +20\u00b0/+160\u00b0). Typical unit - degree."
},
"displacement": {
"additionalProperties": false,
"description": "(Optional) - Specification on how displacement is applied on the sample. Either 'displacementRate' in \u00b5m/min or 'displacementIncrement' in \u00b5m/acquisition need to be selected.",
"properties": {
"displacementIncrement": {
"description": "(Optional) - The step at which displacement is changed per acquisition in \u00b5m/acquisition.",
"type": "number"
},
"displacementRate": {
"description": "(Optional) - The rate at which displacement is applied on the sample in \u00b5m/min.",
"type": "number"
}
},
"type": "object"
},
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame or anvil (e.g. - size of anvil) relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
},
"maximumDisplacement": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - The maximum displacement allowed in the selected configuration. Typical unit - \u00b5m."
},
"maximumForce": {
"description": "(Optional) - The maximum force that can be applied to the sample in N.",
"type": "number"
},
"otherAnvil": {
"description": "(Optional) - If 'anvil' was selected as 'Other' from the controlled list as it was not listed, please specify the name of the anvil with a description in this field.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the vacuum chamber relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the vacuum chamber relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the vacuum chamber."
},
"chamberName": {
"description": "(Optional) - Name of the vacuum chamber.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"motorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchical level and direction of a motor.",
"properties": {
"motorDirection": {
"description": "(Required) - The direction of movement (for X,Y,Z,M motors) or axis of rotation (for rotating motors) expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the X-stage and perpendicular to the Y-stage. then beam direction = [1 0 0], X-stage-direction = [1 0 0] (positive movement direction away from source towards detector) or can be (-1 0 0) (towards source) and Y-stage-direction = [0 1 0] or can be [0 -1 0] (analogous interpretation). The parameters need to be individually determined for each instrument. For rotating motors, the directional vector of axis of rotation should be given in Cartesian coordinates (counterclockwise, right-hand rule).",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"motorLevel": {
"description": "(Required) - Hierarchy of the motor expressed as an integer.",
"type": "number"
}
},
"type": "object"
},
"motorPositions": {
"additionalProperties": false,
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the motor.",
"properties": {
"angles": {
"$ref": "#/$defs/angleSet",
"description": "(Optional) - The three tilt angles alpha, beta and gamma of the motors controlling the position of the item."
},
"xyzPositions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - The xyz coordinates describing the motor positions of the item."
}
},
"type": "object"
},
"optics": {
"additionalProperties": false,
"description": "(Optional) - Details about the optics and individual motor positions.",
"properties": {
"collimator": {
"additionalProperties": false,
"description": "(Optional) - Details about the collimator and its individual motor positions.",
"properties": {
"collimatorDetails": {
"description": "(Optional) - Details about the collimator relevant for the measurement.",
"type": "string"
},
"collimatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the collimator."
}
},
"type": "object"
},
"condenser": {
"additionalProperties": false,
"description": "(Optional) - Details about the condenser lens and its individual motor positions, if used.",
"properties": {
"condenserDetails": {
"description": "(Optional) - Details about the condenser relevant for the measurement.",
"type": "string"
},
"condenserPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the condenser."
}
},
"type": "object"
},
"fresnelZonePlate": {
"additionalProperties": false,
"description": "(Optional) - Details about the fresnel zone plate and its individual motor positions, if used.",
"properties": {
"fresnelZonePlateDetails": {
"description": "(Optional) - Details about the fresnel zone plate relevant for the measurement.",
"type": "string"
},
"fresnelZonePlatePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the fresnel zone plate."
}
},
"type": "object"
},
"monochromator": {
"additionalProperties": false,
"description": "(Required) - Details about the monochromator and individual motor positions, if used.",
"properties": {
"monochromatorDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the monochromator type type, material, energy and notes.",
"properties": {
"energy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Energy set in the monochromator. Typical unit - eV."
},
"material": {
"description": "(Optional) - Material of the monochromator.",
"type": "string"
},
"monochromatorType": {
"description": "(Optional) - Type of the monochromator.",
"type": "string"
},
"notes": {
"description": "(Optional) - Additional information about the monochromator relevant for the measurement."
}
},
"type": "object"
},
"monochromatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the monochromator."
},
"monochromatorUsed": {
"description": "(Required) - To be set to true if monochromator is used, else false.",
"type": "boolean"
}
},
"required": [
"monochromatorUsed"
],
"type": "object"
},
"phaseRing": {
"additionalProperties": false,
"description": "(Required) - Details about the phase ring and its individual motor positions, if inserted.",
"properties": {
"phaseRingDetails": {
"description": "(Optional) - Details about the phase ring relevant for the measurement.",
"type": "string"
},
"phaseRingPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the phase ring."
}
},
"type": "object"
}
},
"required": [
"monochromator"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes a parameter which can be split into number of pixels in x and y directions like the resolution",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm or \u00b5m, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the size of a single pixel (typical value - nm, \u00b5m) of datatype string",
"enum": [
"nm",
"\u00b5m"
],
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min).",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW).",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi).",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"rampDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a rate at which temperature is increased or decreased.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K/min, K/s).",
"enum": [
"K/min",
"K/s"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of temperature increase or decrease.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"reconstruction": {
"additionalProperties": false,
"description": "Data from one single reconstruction.",
"properties": {
"reconstructionDetails": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"additionalFilters": {
"beamHardeningCorrection": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"filterType": {
"description": "(Optional) - Type of the additional filter - Median or Gauss",
"enum": [
"Median",
"Gauss"
],
"type": "string"
},
"phaseRetrieval": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"ringFilter": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
}
},
"algorithm": {
"description": "(Required) - Algorithm used for reconstruction to be selected from FBP - Filtered Back Projection, ART - Algebraic Reconstruction Technique, 3dCT - 3D Computed Tomography and Gridrec.",
"enum": [
"FBP - Filtered Back Projection",
"ART - Algebraic Reconstruction Technique",
"3dCT - 3D Computed Tomography",
"Gridrec"
],
"type": "string"
},
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepthConversionMax": {
"description": "(Required) - Maximum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"bitDepthConversionMin": {
"description": "(Required) - Minimum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"hardwarePlatform": {
"description": "(Optional) - Hardware platform used for reconstruction to be selected between CPU and GPU.",
"enum": [
"CPU",
"GPU"
],
"type": "string"
},
"lastImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the last image for the reconstruction of the 3D Volume, typically an integer.",
"type": "string"
},
"projectionPadding": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the projection padding applied to the raw projection data to address certain issues in the reconstruction process.",
"properties": {
"paddingSize": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - Size of the projection padding used in pixels."
},
"paddingType": {
"description": "(Required) - Type of the projection padding used - Zero Padding, Linear Interpolation Padding, Sinc Interpolation Padding, Shepp-Logan Filtered Back Projection (SL-FBP), Gridding and Extended Field of View (FOV) Padding.",
"enum": [
"Zero Padding",
"Linear Interpolation Padding",
"Sinc Interpolation Padding",
"Shepp-Logan Filtered Back Projection (SL-FBP)",
"Gridding",
"Extended Field of View (FOV) Padding"
],
"type": "string"
}
},
"type": "object"
},
"reconstructionSoftware": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for reconstruction. It may be the same as the acquisition software or a different one."
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Scan angle at which the reconstruction of the 3D Volume starts. Typical unit - degree."
},
"startImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the start image for the reconstruction of the 3D Volume.",
"type": "string"
},
"tomographicProjectionFilter": {
"description": "(Optional) - Name of the tomographic projection filter used to be selected from Ram-Lak Filter, Butterworth Filter, Shepp-Logan Filter, Hann (Hanning) Filter, Gaussian Filter, Cosine Filter, Soft Filtration Method and Hard Filtration Method.",
"enum": [
"Ram-Lak Filter",
"Butterworth Filter",
"Shepp-Logan Filter",
"Hann (Hanning) Filter",
"Gaussian Filter",
"Cosine Filter",
"Soft Filtration Method",
"Hard Filtration Method"
],
"type": "string"
}
},
"required": [
"startImage",
"lastImage",
"startAngle",
"hardwarePlatform",
"algorithm",
"binning"
],
"type": "object"
},
"volumeStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each voxel in the 3D volume. The bit depth determines the number of possible intensity levels that can be assigned to each voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Required) - The dimension of the 3D volume in XYZ coordinates. If the length in Z dimension is not known and instead only the number of slices are known, they need to be separately entered in the field 'numberOfSlices'. Typical unit - \u00b5m."
},
"header": {
"additionalProperties": false,
"description": "(Optional) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Optional) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"name": {
"description": "(Required) - Name of the 3D volume structure (dataset).",
"type": "string"
},
"numberOfSlices": {
"description": "(Optional) - No. of slices which make up the 3D volume.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel/voxel, normally expressed in \u00b5m."
},
"volumeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry of the 3D reconstructed volume usually provided by the project or the laboratory."
}
},
"required": [
"name",
"dimensions",
"bitDepth",
"pixelSize"
],
"type": "object"
}
},
"required": [
"volumeStructure",
"reconstructionDetails"
],
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"sampleStage": {
"additionalProperties": false,
"description": "(Required) - Details about sample stage.",
"properties": {
"stageMotorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchy of the stage motors. This information is required to know how the motor movements affect the positions of the samples, particularly relevant for correlative characterization.",
"properties": {
"beamDirection": {
"description": "(Required) - The beam direction expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the Y-stage and perpendicular to the X-stage. then beam direction = [0 1 0].",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"mMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the M motor (stage) as a vector in cartesian coordiantes. The M motor is usually relevant only for SEM based CT. It is a special motor which counteracts the Z motor."
},
"rMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the R motor (stage) as a vector in cartesian coordiantes. R motor has rotation around z axis +1 (for anticlockwise)."
},
"tMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the T motor (stage) as a vector in cartesian coordiantes. The T motor is usually relevant only for SEM based CT."
},
"xMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the X motor (stage) as a vector in cartesian coordinates."
},
"yMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Y motor (stage) as a vector in cartesian coordinates."
},
"zMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Z motor (stage) as a vector in cartesian coordinates."
}
},
"required": [
"beamDirection",
"xMotor",
"yMotor",
"zMotor",
"rMotor"
],
"type": "object"
},
"stageMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the stage motors."
}
},
"required": [
"stageMotorHierarchy"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s).",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"user": {
"description": "Basic schema for user description. It can be extended.",
"properties": {
"ORCID": {
"description": "(Optional) - Open Researcher and Contributor ID expressed as a URI",
"pattern": "^https://orcid\\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[X0-9]{1}$",
"type": "string"
},
"affiliation": {
"description": "(Optional) - Details of the institution to which the user is affiliated",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"description": "(Optional) -Identifier of the institution to which the user is affiliated",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be chosen from a controlled list of values (*ROR *GRID *ISNI *URL *DOI *Handle)",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"email": {
"description": "(Optional) - Email of the user",
"format": "email",
"type": "string"
},
"familyName": {
"description": "(Optional) - Family name of the user",
"type": "string"
},
"givenName": {
"description": "(Optional) - Given name of the user",
"type": "string"
},
"role": {
"description": "(Required) - Role of the research user",
"enum": [
"Data Curator",
"Instrument Scientist",
"Team Leader",
"Team Member"
],
"type": "string"
},
"userName": {
"description": "(Required) - Full name of the user in the format (Family Name, Given Name)",
"type": "string"
}
},
"required": [
"userName",
"role"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV).",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided. Contributors (in alphabetical order of last names): Alexey Boubnov, Rafaela Debastiani, Jonas Fell, Sarah Irvine, Reetu Elza Joseph.",
"properties": {
"consumables": {
"description": "(Optional) - Auxiliary entity used during Fabrication, Sample Preparation or Measurement which has a limited time capacity or is limited in its number of uses before it is disposed of, necessary to the process itself and normally bought from third party manufacturers. Examples are: gloves, syringes, wipes, etching solutions, glass slides, spatulas, weighing paper, two-sided tape.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"data": {
"$ref": "#/$defs/data",
"description": "(Required)- Details concerning the data section of the measurement."
},
"definition": {
"description": "(Required) - Name of the schema to which this entry conforms. In this case, lab_CT should be written.",
"type": "string"
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format YYYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry usually provided by the project or the laboratory."
},
"equipment": {
"description": "(Optional) - Any kind of physical or virtual item, device, machine or other tools used to perform one or more Fabrication(s), Sample Preparation(s), Model Preparation(s), Data Acquisition(s) and/or any of the processes included in the Data Analysis Lifecycle. Usually, the Equipment is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. Equipment is usually an investment. According to this definition, an Instrument is a particular type of Equipment.",
"type": "string"
},
"experimentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the measurement usually provided by the project or the laboratory."
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings. Instrument is a physical or virtual identifiable piece of Equipment used to perform a Data Acquisition and to generate Raw Data. The Instrument is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. A virtual Instrument may be any computational resource or HPC infrastructure (cloud infrastructure or supercomputer) needed to perform Calculations or Simulations."
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure."
},
"measurementDescription": {
"description": "(Optional) - Description about the measurement.",
"type": "string"
},
"measurementPurpose": {
"description": "(Required) - Measurement is experimental Data Acquisition, typically performed on a Sample using an experimental Technique. It may also be performed during Fabrication or Sample Preparation, e.g., to characterise the intermediate stages and/or the final resulting Precursor(s) or Sample(s), respectively. A Measurement may require the use of Consumables.",
"enum": [
"assessment (to given categories or values)",
"completeness check (presence or absence of given properties)",
"correlative characterization (dedicated sample treatment to emphasise given features)",
"exploratory (routine check of known properties)",
"feasibility (quick check, rough estimate)",
"high quality measurement (precise, careful treatment)",
"test specific hypothesis (focus only on given aspects)",
"other (please specify in the comment)"
],
"type": "string"
},
"parents": {
"description": "(Required) - Parents of this metadata like the metadata document of the sample with which the measurement was performed.",
"items": {
"if": {
"properties": {
"parentType": {
"not": {
"const": "not applicable"
}
}
}
},
"properties": {
"parentReference": {
"description": "If type is 'MetaStore URI' it is possible to easily fill this field in a later stage",
"format": "uri-reference",
"type": "string"
},
"parentReferenceType": {
"default": "MetaStore URI",
"enum": [
"plain text",
"external URL",
"MetaStore URI"
],
"type": "string"
},
"parentType": {
"default": "sample",
"enum": [
"not applicable",
"sample"
],
"type": "string"
}
},
"required": [
"parentType"
],
"then": {
"required": [
"parentReferenceType",
"parentReference"
]
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition."
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format."
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format YYYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"technique": {
"description": "(Required) - Any experimental, theoretical or computational method used during Data Acquisition or during any of the processes included in the Data Analysis Lifecycle to acquire, process or analyse Research Data about a System or a set of them with an Instrument, which is used to generate this metadata.",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement.",
"type": "string"
},
"user": {
"$ref": "#/$defs/user",
"description": "(Required)- The contact information of the user responsible for the measurement."
}
},
"required": [
"title",
"technique",
"definition",
"parents",
"measurementPurpose",
"startTime",
"endTime",
"program",
"user",
"instrument",
"data"
],
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 44904b842f74ba6ff5ce35c5fa665e82c0ee6757 | 2023-12-12T13:36:59 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"CTAquisition": {
"additionalProperties": false,
"description": "(Required) - Details about the acquisition.",
"properties": {
"acquisitionScriptName": {
"description": "(Required) - Name of the script used for acquisition.",
"type": "string"
},
"acquisitionTimePerProjection": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time taken for acquisition of a single projection. Typical unit - s."
},
"angularStepSize": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Step size of the rotation of the sample during the CT. Typical unit - degree."
},
"endAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - End angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then endAngle is 180\u00b0. Typical unit - degree."
},
"largeFOV": {
"description": "(Required) - To be set to true if large field of view or wide field of view is used.",
"type": "boolean"
},
"numberOfProjections": {
"description": "(Required) - Number of projections acquired during the CT.",
"type": "number"
},
"phaseContrastMode": {
"description": "(Required) - The phase contrast mode used during acquisition - Zernike phase contrast, propagation-based, grating-based(Hartmann), grating-based(Talbot).",
"enum": [
"Zernike phase contrast",
"Propagation-based",
"Grating-based(Hartmann)",
"Grating-based(Talbot)"
],
"type": "string"
},
"referenceImages": {
"additionalProperties": false,
"description": "(Optional) - Details on the reference images (if used) - number of flats/bright images and number of dark images.",
"properties": {
"numberOfBrightImages": {
"description": "(Optional) - Number of flats or bright images used as reference.",
"type": "number"
},
"numberOfDarkImages": {
"description": "(Optional) - Number of dark images used as reference.",
"type": "number"
}
},
"type": "object"
},
"scanningMode": {
"description": "(Optional) - The scanning mode used during acquisition - helical, raster scanning, fast CT.",
"enum": [
"Helical",
"Raster Scanning",
"Fast CT"
],
"type": "string"
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Start angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then startAngle is -180\u00b0. Typical unit - degree."
},
"totalAcquisitionTime": {
"description": "(Required) - Time taken for acquisition for the entire scan. This is the total scan time, i.e. number of projections multipled by exposure time, but including read-out time. calculated as EndTime-StartTime. Format: hh:mm:ss.",
"format": "time",
"pattern": "^(\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?)$",
"type": "string"
},
"useBadPixelMap": {
"description": "(Optional) - To be set to true if bad pixel map is used. This parameter is relevant for SEM based CT.",
"type": "boolean"
}
},
"required": [
"acquisitionScriptName",
"startAngle",
"endAngle",
"angularStepSize",
"acquisitionTimePerProjection",
"totalAcquisitionTime",
"largeFOV",
"phaseContrastMode"
],
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "degree",
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"angleSet": {
"additionalProperties": false,
"description": "(Optional) - Tilt angles alpha, beta and gamma decribing the three angular positions of an item.",
"properties": {
"alpha": {
"description": "(Optional) - Tilt angle alpha of the item.",
"type": "number"
},
"anglesUnit": {
"default": "degree",
"description": "(Optional) - unit of the angles (allowed units - degree or radian)",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"beta": {
"description": "(Optional) - Rotation angle beta of the item.",
"type": "number"
},
"gamma": {
"description": "(Optional) - Angle gamma of the item.",
"type": "number"
}
},
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"default": "\u00b5m",
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "pA",
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string.",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"detectorDetails": {
"additionalProperties": false,
"description": "gives the settings of a detector.",
"properties": {
"componentGeometry": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - xyz coordinates describing the position of the detector defined separately as coordinateSet"
},
"detectorBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - bias voltage applied to the detector defined separately as voltageDetails. Allowed units nV, uV, mV, V, kV"
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector"
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - describes the details of the detector (manufacturerName, modelName and detectorID) as part of manufacturerDetails"
},
"detectorName": {
"description": "(Required) -Name of the detector of datatype string",
"type": "string"
},
"detectorType": {
"default": "Secondary Electron",
"description": "(Optional) - The type of detector (e.g., surface electron detection, secondary electron, back-scattered electron) of datatype string",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (YYYY-MM-DDThh:mm:ss.sss) in the ISO 8601 date-time format",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
}
},
"required": [
"detectorName"
],
"type": "object"
},
"detectorSetDetails": {
"additionalProperties": false,
"description": "gives information about signal mixing between two detectors and provides the information about the detector(s).",
"properties": {
"detector1": {
"$ref": "#/$defs/detectorDetails",
"description": "(Required) - gives the settings of one detector defined separately as detectorDetails; entering the details of at least one detector is compulsory"
},
"detector2": {
"$ref": "#/$defs/detectorDetails",
"description": "(Optional) - gives the settings of a second detector defined separately as detectorDetails"
},
"signalMixingDescription": {
"description": "(Optional) - Describes the purpose and technique of signal mixing of datatype string",
"type": "string"
},
"signalMixingDone": {
"default": false,
"description": "(Optional) - whether the detector signals are mixed, true or false, of datatype boolean",
"type": "boolean"
}
},
"required": [
"detector1"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"eBeamDecelerationDetails": {
"additionalProperties": false,
"description": "Details about deceleration of the e- beam.",
"properties": {
"landingEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Landing energy of the e-beam defined separately as energyDetails (allowed units - meV, eV, keV, nJ, mJ, J, kJ, MJ)"
},
"stageBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Bias voltage applied to the stage defined separately biasDetails (allowed units - nV, uV, mV, V, kV, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ; default value - keV) of datatype string",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"entry": {
"additionalProperties": false,
"description": "Required) - The entry level is the root element of the schema. It contains all the metadata describing a CT measurement.",
"properties": {
"definition": {
"description": "(Optional) - Name of the schema to which this entry conforms. In this case, lab_CT should be written",
"type": "string"
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "entryID (Optional) - Identifier of the metadata entry usually provided by the project or the laboratory"
},
"experimentID": {
"$ref": "#/$defs/identifier",
"description": "entryID (Optional) - Identifier of the measurement usually provided by the project or the laboratory"
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings"
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition"
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format"
},
"sample": {
"$ref": "#/$defs/sample",
"description": "(Required)- Details concerning the sample"
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement",
"type": "string"
},
"user": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/user_description.json",
"description": "(Required)- The contact information of the user responsible for the measurement"
}
},
"required": [
"title",
"startTime",
"endTime",
"program",
"user",
"instrument",
"data"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/ time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min) default value - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"geometry": {
"additionalProperties": false,
"description": "Describes the geometry of the CT instrument",
"properties": {
"beamGeometry": {},
"geometricMagnification": {},
"objectToDetectorDistance": {},
"opticalMagnification": {},
"sourceToObjectDistance": {}
},
"required": [
"sourceToObjectDistance",
"objectToDetectorDistance",
"beamGeometry",
"geometricMagnification",
"opticalMagnification"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"imagingDetails": {
"additionalProperties": false,
"description": "describes the imaging settings of the instrument during the measurement.",
"properties": {
"apertureSetting": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Optional) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). The element apertureSetting is defined separately as apertureSettingType which gives the option to choose between current or size. If the size can be set directly, then it is defined with the complex type distanceDetails, else if the aperture setting is controlled with the beam current defined separately as currentDetails"
},
"collectionMethod": {
"default": "normal scan",
"description": "(Optional) - the method of collection of the image, for e.g., normal scan, average of multiple images, integration of multiple images, default value - normal scan, of datatype string",
"type": "string"
},
"cycleTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - the time taken by the beam to scan a frame, defined separately as timeDetails. It is the time needed to scan a line times the number of lines in a frame."
},
"dwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - the dwell time of the beam per pixel, defined separately as timeDetails"
},
"dynamicFocus": {
"description": "(Optional) - To be set to true if dynamic focus is turned on, else false",
"type": "boolean"
},
"noiseReduction": {
"description": "(Optional) - The type of noise reduction used as an enumerated list of six parameters: Pixel Avg, Line Avg, Frame Avg, Pixel Int, Line Int, Frame Int.",
"enum": [
"Pixel Avg",
"Line Avg",
"Frame Avg",
"Pixel Int",
"Line Int",
"Frame Int"
],
"type": "string"
},
"numberOfPixels": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The number of x, y pixels of the image, defined separately as pixelNumberType with separate entries for integer values of xPixels and yPixels"
},
"pixelSize": {
"$ref": "#/$defs/pixelsize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel, normally expressed in nm/pixel, defined separately as pixelSize3D for the mapping along x,y and z directions, with each pixel having a pixelSize, optional uncertainty, optional qualifier and optional notes. The y-pixel-size is to be given only if it is different from the x-pixel-size, and z-pixel-size can be ignored if it is greater than voxel size"
},
"voxel": {
"$ref": "#/$defs/voxelDetails",
"description": "(Optional) - Size of the voxel in case 3D imaging is done for Energy-dispersive X-ray Spectroscopy or Electron-backscatter Diffraction, defined separately as voxelDetails"
}
},
"required": [
"numberOfPixels",
"pixelSize"
],
"type": "object"
},
"institutionDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the institution to which the user is affiliated.",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier pertaining to the institution (e.g. ROR)"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"CTAquisition": {
"$ref": "#/$defs/CTAquisition",
"description": "(Optional) - Details regarding the acquisition."
},
"calibration": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the calibration and the scaling factor.",
"properties": {
"calibrationType": {
"description": "(Optional) - Type of calibration as a string.",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (YYYY-MM-DDThh:mm:ss.sss) in the ISO 8601 date-time format",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"systemScaling": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scaling factor.",
"properties": {
"adjustSystemScaling": {
"description": "(Required) - To be set to true if system scaling is adjusted, else false.",
"type": "boolean"
},
"measuredScalingFactor": {
"description": "(Optional) - Value of the measured scaling factor.",
"type": "number"
},
"referenceScalingFactor": {
"description": "(Optional) - Value of the reference scaling factor, determined ususally during the data processing.",
"type": "number"
}
},
"required": [
"adjustSystemScaling"
],
"type": "object"
}
},
"type": "object"
},
"detector": {
"$ref": "#/$defs/detectorDetails",
"description": "(Optional) - Details regarding the detector."
},
"focalSpotMode": {
"additionalProperties": false,
"description": "(Optional) - Option for setting the size of the focal spot. Some sources have the option to select the target spot size, or focal spot size absolutely by setting a value, while some others give the option of selecting 'small', 'medium' or 'large'. Smaller spot size = higher resolution. Note that the power/current will change with this value. In addition, the detector settings will usually be selected in conjunction. (different scintillator/lens/magnification).",
"properties": {
"selection": {
"description": "(Optional) - Selection of the setting of the size of the focal spot when the option for setting the size of the focal spot by selecting 'small', 'medium' or 'large' according to predefined values set by the manufacturer.",
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the target spot when the option for setting the size of the focal spot absolutely by setting a value is available."
}
},
"type": "object"
},
"geometry": {
"$ref": "#/$defs/geometry",
"description": "(Optional) - Details regarding the geometry."
},
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"optics": {
"$ref": "#/$defs/optics",
"description": "(Optional) - Details about the optics and individual motor positions."
},
"sampleStage": {
"$ref": "#/$defs/sampleStageDetails",
"description": "(Optional) - Details regarding the sample stage."
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray target in an SEM based CT set-up.",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required) - Details of the pressure maintained in the chamber of the SEM."
},
"electronBeamShift": {
"additionalProperties": false,
"description": "(Required) - The distance by which the electron beam is shifted in the x and y directions.",
"properties": {
"xShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the x direction. Typical unit - \u00b5m."
},
"yShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xShift",
"yShift"
],
"type": "object"
},
"electronProbeCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required) - The electron current measured at the probe. Typical unit - \u00b5A."
},
"objectiveLensAperture": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). Typically the diameter of the aperture is set in \u00b5m."
},
"target": {
"additionalProperties": false,
"description": "(Required) - Details regarding the target in SEM based CT, which upon interaction with the e-beam produces the X-rays.",
"properties": {
"targetDriftCorrection": {
"description": "(Required) - If drift correction is activated for the target, this parameter has to be set to true.",
"type": "boolean"
},
"targetMaterial": {
"description": "(Required) - Material with which the target is made.",
"type": "string"
},
"targetShape": {
"description": "(Optional) - Description of the shape or geometry of the target. e.g. - bulk, foil, needle.",
"type": "string"
},
"targetThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Thickness of the target (dimension in Z direction). Default unit - \u00b5m."
},
"targetTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the target is tilted. Typical unit - degree."
}
},
"required": [
"targetMaterial",
"targetThickness",
"targetDriftCorrection",
"targetTiltAngle",
"targetCurrent"
],
"type": "object"
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. In SEM based CT, the beam is focussed on the target material which emits the X-rays upon interaction with the electrons. Default unit - \u00b5m."
}
},
"required": [
"chamberPressure",
"electronBeamShift",
"workingDistance",
"objectiveLensAperture",
"electronProbeCurrent",
"target"
],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
},
"targetCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current measured at the X-ray target, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"sourceDrift": {
"additionalProperties": false,
"description": "(Optional) - Distance by which the source is shifted during the measurement (i.e., end position - start position).",
"properties": {
"xDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the x direction. Typical unit - \u00b5m."
},
"yDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xDrift",
"yDrift"
],
"type": "object"
},
"sourcePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the source."
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray enrgy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source",
"focalSpotMode",
"CTAquisition",
"geometry",
"sampleStage",
"detector"
],
"type": "object"
},
"lifetimeDetails": {
"additionalProperties": false,
"description": "describes a lifetime.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5Ah",
"description": "(Required) - the unit of the value (default value - \u00b5Ah) of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The lifetime of the source expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"bioReactor": {
"additionalProperties": false,
"description": "(Optional) - Details of an in situ bioreactor.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in sterile conditions.",
"type": "boolean"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is decreased. Typical unit - K/min."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is increased, typically in K/min."
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"anvil": {
"description": "(Optional) - The type of anvil used in the in situ load frame (stage) for applying a particular type of force on the sample. Option to be selected from a controlled list consisting of - Compression, Diamond indentation 90\u00b0 cone, Diamond indentation cube corner, Diamond indentation wedge, Tension, Other. If 'Other' is selected, specify the name of the anvil with a description in the field 'otherAnvil'.",
"enum": [
"Compression",
"Diamond indentation 90\u00b0 cone",
"Diamond indentation cube corner",
"Diamond indentation wedge",
"Tension",
"Other"
],
"type": "string"
},
"displacement": {
"additionalProperties": false,
"description": "(Optional) - Specification on how displacement is applied on the sample. Either 'displacementRate' in \u00b5m/min or 'displacementIncrement' in \u00b5m/acquisition need to be selected.",
"properties": {
"displacementIncrement": {
"description": "(Optional) - The step at which displacement is changed per acquisition in \u00b5m/acquisition.",
"type": "number"
},
"displacementRate": {
"description": "(Optional) - The rate at which displacement is applied on the sample in \u00b5m/min.",
"type": "number"
}
},
"type": "object"
},
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
},
"maximumDisplacement": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - The maximum displacement allowed in the selected configuration. Typical unit - \u00b5m."
},
"maximumForce": {
"description": "(Optional) - The maximum force that can be applied to the sample in N.",
"type": "number"
},
"otherAnvil": {
"description": "(Optional) - If 'anvil' was selected as 'Other' from the controlled list as it was not listed, please specify the name of the anvil with a description in this field.",
"type": "string"
},
"rotationRange": {
"additionalProperties": false,
"description": "(Optional) - The range of rotation of the sample during the CT with the load frame (stage) to be specified as startAngle and endAngle. Typical unit - degree.",
"properties": {
"endAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - End angle of the range of rotation of the sample during the CT with the load frame (stage). If the range is -70\u00b0/70\u00b0, then endAngle is 70\u00b0. Note that, this parameter can be different from the maximum possible angle of rotation of the sample. Typical unit - degree."
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Start angle of the range of rotation of the sample during the CT with the load frame (stage). If the range is -70\u00b0/70\u00b0, then startAngle is -70\u00b0. Note that, this parameter can be different from the minimum possible angle of rotation of the sample. Typical unit - degree."
}
},
"type": "object"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"chamberName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"motorPositions": {
"additionalProperties": false,
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the item.",
"properties": {
"itemPosition": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - The xyz coordinates decribing the motor positions of the item."
},
"itemTilt": {
"$ref": "#/$defs/angleSet",
"description": "(Optional) - The three tilt angles alpha, beta and gamma describing the motor positions of the item."
}
},
"type": "object"
},
"optics": {
"additionalProperties": false,
"description": "(Optional) - Details about the optics and individual motor positions.",
"properties": {
"collimator": {
"additionalProperties": false,
"description": "(Optional) - Details about the collimator and its individual motor positions.",
"properties": {
"collimatorDetails": {
"description": "(Optional) - Details about the collimator relevant for the measurement.",
"type": "string"
},
"collimatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the collimator."
}
},
"type": "object"
},
"condenser": {
"additionalProperties": false,
"description": "(Optional) - Details about the condenser lens and its individual motor positions, if used.",
"properties": {
"condenserDetails": {
"description": "(Optional) - Details about the condenser relevant for the measurement.",
"type": "string"
},
"condenserPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the condenser."
}
},
"type": "object"
},
"fresnelZonePlate": {
"additionalProperties": false,
"description": "(Optional) - Details about the fresnel zone plate and its individual motor positions, if used.",
"properties": {
"fresnelZonePlateDetails": {
"description": "(Optional) - Details about the fresnel zone plate relevant for the measurement.",
"type": "string"
},
"fresnelZonePlatePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the fresnel zone plate."
}
},
"type": "object"
},
"monochromator": {
"additionalProperties": false,
"description": "(Optional) - Details about the monochromator and individual motor positions, if used.",
"properties": {
"monochromatorDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the monochromator type type, material, energy and notes.",
"properties": {
"energy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Energy set in the monochromator. Typical unit - eV"
},
"material": {
"description": "(Optional) - Material of the monochromator.",
"type": "string"
},
"monochromatorType": {
"description": "(Optional) - Type of the monochromator.",
"type": "string"
},
"notes": {
"description": "(Optional) - Additional information about the monochromator relevant for the measurement."
}
},
"type": "object"
},
"monochromatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the monochromator."
}
},
"type": "object"
},
"phaseRing": {
"additionalProperties": false,
"description": "(Required) - Details about the phase ring and its individual motor positions, if inserted.",
"properties": {
"phaseRingDetails": {
"description": "(Optional) - Details about the phase ring relevant for the measurement.",
"type": "string"
},
"phaseRingPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the phase ring."
}
},
"type": "object"
}
},
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes the resolution of the image split into number of pixels in x and y directions.",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "nm/pixel",
"description": "(Required) - the unit of the value (default value - nm/pixel) of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"pixelsize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm/pixel, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min, default value - max) of datatype string.",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"default": "W",
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW, default value - W) of datatype string.",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "Pa",
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"rampDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a rate at which temperature is increased or decreased.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K/min",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K/min, K/s)",
"enum": [
"K/min",
"K/s"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of temperature increase or decrease.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"sample": {
"additionalProperties": false,
"description": "(Required) - Details concerning the sample.",
"properties": {
"sampleForm": {
"description": "(Optional) - Description of the sample form (e.g., bulk, nanostructured, powder, pellet)",
"type": "string"
},
"sampleHolder": {
"description": "(Optional) - Type of sample holder used",
"type": "string"
},
"sampleID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the sample"
},
"sampleName": {
"description": "(Optional) - Name of the sample",
"type": "string"
},
"samplePreparation": {
"$ref": "#/$defs/samplePrepType",
"description": "(Optional) - Details pertaining to the sample prepapration like date, ID, etc"
},
"sampleSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the sample"
},
"sampleWeight": {
"$ref": "#/$defs/weightDetails",
"description": "(Optional) - Weight of the sample"
},
"storageConditions": {
"default": "Ambient, dry environment",
"description": "(Optional) - Environment conditions in which the sample has to be stored before and after the measurement (e.g., nitrogen atmosphere, hermetically sealed, controlled temperature and pressure).",
"type": "string"
}
},
"type": "object"
},
"samplePrepType": {
"additionalProperties": false,
"description": "(Optional) - Describes the sample preparation process.",
"properties": {
"preparationDate": {
"description": "(Optional) - Date of the sample preparation in the ISO 8601 format.",
"format": "date",
"type": "string"
},
"preparationDescription": {
"description": "(Optional) - Short description of the sample preparation.",
"type": "string"
},
"preparationID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the sample preparation."
}
},
"type": "object"
},
"stageDetails": {
"additionalProperties": false,
"description": "describes the stage settings during a measurement.",
"properties": {
"coordinateReference": {
"default": "origin at centre of sample",
"description": "(Optional) - description of the reference used for defining the coordinates (for eg. - origin at centre of sample, distances from two edges, etc.)",
"type": "string"
},
"coordinates": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - the xyz coordinates of a point expressed separately as coordinateSet which allows entering each of the xyz coordinates along with their optional uncertainties. If correllation images (two reference spots) are available, the coordinates enable correlative microscopy and they need to be entered"
},
"eBeamWorkingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the distance at which the beam is focussed (when the sample is in focus, this will be the distance between the bottom end of the pole-piece of the objective lens and the sample) defined separately as distanceDetails, with the distance value, optional uncertainty, optional notes, optional qualifier and choice of units between nm, um, mm, cm and m"
},
"isCorrelationImage": {
"description": "(Optional) - Whether the image is used for correlating in xyz coordinates with another image? Check if true. If true the coordinates have to be entered for the sake of correlative characterization of datatype boolean",
"type": "boolean"
},
"preTilt": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - predefined angle of a tilted sample holder which is tilted by design defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"stageAlignmentDone": {
"description": "(Optional) - was stage alignment done? (check if true)",
"type": "boolean"
},
"stageTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the stage is actually tilted (Stage at T) defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"tiltCorrectionAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - angle used to correct the tilt of the sample defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"tiltCorrectionType": {
"default": "none",
"description": "(Optional) - the tilt correction type applied to the image to compensate for the tilting, for e.g., sample surface, cross-section, none or manual, default value- none of datatype string",
"type": "string"
}
},
"required": [
"eBeamWorkingDistance",
"stageTiltAngle"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5s",
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s default value - \u00b5s) of datatype string",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "kV",
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV default value - V) of datatype string.",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"voxelDetails": {
"additionalProperties": false,
"description": "describes the size of a voxel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "mm",
"description": "(Required) - the unit of the value of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The voxel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"weightDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a weight.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "\u00b5g",
"description": "(Required) - Unit of the value to be selected from a controlled list (ng, \u00b5g, mg, g, kg, default value - ug)",
"enum": [
"ng",
"\u00b5g",
"mg",
"g",
"kg"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the weight",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided. Contributors (in alphabetical order of last names): Alexey Boubnov, Rafaela Debastiani, Jonas Fell, Sarah Irvine, Reetu Elza Joseph",
"properties": {
"entry": {
"$ref": "#/$defs/entry"
}
},
"required": [
"entry"
],
"title": "lab_CT",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 7136b6fbe9498dfc9c0ca1402d55f2c093f3738e | 2024-02-27T10:53:20 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"CTAquisition": {
"additionalProperties": false,
"description": "(Required) - Details about the acquisition.",
"properties": {
"acquisitionScriptName": {
"description": "(Required) - Name of the script used for acquisition.",
"type": "string"
},
"acquisitionTimePerProjection": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time taken for acquisition of a single projection. Typical unit - s."
},
"angularStepSize": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Step size of the rotation of the sample during the CT. Typical unit - degree."
},
"contrastType": {
"description": "(Required) - The contrast type(mode) used - Absorption Contrast or Phase Contrast. If 'Phase Contrast' is selected, please indicate the used Phase Contrast Mode under the field phaseContrastMode.",
"enum": [
"Absorption Contrast",
"Phase Contrast"
],
"type": "string"
},
"endAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - End angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then endAngle is 180\u00b0. Typical unit - degree."
},
"largeFOV": {
"description": "(Required) - To be set to true if large field of view or wide field of view is used.",
"type": "boolean"
},
"numberOfProjections": {
"description": "(Required) - Number of projections acquired during the CT.",
"type": "number"
},
"phaseContrastMode": {
"description": "(Optional) - The phase contrast mode used during acquisition - Zernike phase contrast, propagation-based, grating-based(Hartmann), grating-based(Talbot).",
"enum": [
"Zernike phase contrast",
"Propagation-based",
"Grating-based(Hartmann)",
"Grating-based(Talbot)"
],
"type": "string"
},
"referenceImages": {
"additionalProperties": false,
"description": "(Optional) - Details on the reference images (if used) - number of flats/bright images and number of dark images.",
"properties": {
"numberOfBrightImages": {
"description": "(Optional) - Number of flats or bright images used as reference.",
"type": "number"
},
"numberOfDarkImages": {
"description": "(Optional) - Number of dark images used as reference.",
"type": "number"
}
},
"type": "object"
},
"scanningMode": {
"description": "(Optional) - The scanning mode used during acquisition - helical, raster scanning, fast CT.",
"enum": [
"Helical",
"Raster Scanning",
"Fast CT"
],
"type": "string"
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Start angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then startAngle is -180\u00b0. Typical unit - degree."
},
"totalAcquisitionTime": {
"description": "(Required) - Time taken for acquisition for the entire scan. This is the total scan time, i.e. number of projections multipled by exposure time, but including read-out time. calculated as EndTime-StartTime. Format: hh:mm:ss.",
"format": "time",
"pattern": "^(\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?)$",
"type": "string"
},
"useBadPixelMap": {
"description": "(Optional) - To be set to true if bad pixel map is used. This parameter is relevant for SEM based CT.",
"type": "boolean"
}
},
"required": [
"acquisitionScriptName",
"startAngle",
"endAngle",
"angularStepSize",
"acquisitionTimePerProjection",
"totalAcquisitionTime",
"largeFOV",
"contrastType"
],
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian) of datatype string.",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"angleSet": {
"additionalProperties": false,
"description": "(Optional) - Tilt angles alpha, beta and gamma decribing the three angular positions of an item.",
"properties": {
"alpha": {
"description": "(Optional) - Tilt angle alpha of the item.",
"type": "number"
},
"anglesUnit": {
"description": "(Optional) - unit of the angles (allowed units - degree or radian)",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"beta": {
"description": "(Optional) - Rotation angle beta of the item.",
"type": "number"
},
"gamma": {
"description": "(Optional) - Angle gamma of the item.",
"type": "number"
}
},
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A).",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"data": {
"additionalProperties": false,
"description": "(Required) - Details about the data section of the measurement.",
"properties": {
"projections": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"cropping": {
"additionalProperties": false,
"description": "(Optional) - Details about cropping or clipping to select a region of interest(ROI).",
"properties": {
"ROI": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The size of the region of interest (ROI) in integer values of xPixels and yPixels."
},
"offset": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The offset applied to the origin (i.e., centre of the image) to select the region of interest in x and y coordinates."
}
},
"required": [
"ROI",
"offset"
],
"type": "object"
},
"projectionImageDataStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the data structure of the image data of the projections.",
"properties": {
"IOValue": {
"description": "(Required) - The IO value obtained from the metadata.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The dimension of the image as for integer values of xPixels and yPixels."
},
"fileLocation": {
"description": "(Required) - The location where the data file is stored. A URL is preferred if available.",
"type": "string"
},
"greyValueRepresentation": {
"description": "(Optional) - Description about the grey value representation.",
"type": "string"
},
"header": {
"additionalProperties": false,
"description": "(Required) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Required) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"imageCorrection": {
"additionalProperties": false,
"description": "(Optional) - Details about the image correction.",
"properties": {
"isImageCorrected": {
"description": "(Required) - To be set as true if image is corrected.",
"type": "boolean"
},
"linkToReferenceImages": {
"description": "(Required) - Link to the reference images (flats/darks).",
"format": "uri-reference",
"type": "string"
}
},
"required": [
"isImageCorrected",
"linkToReferenceImages"
],
"type": "object"
},
"imageFormats": {
"additionalProperties": false,
"description": "(Required) - The file formats of the images - tiff, png, jpeg. When more than one file formats are there, then the formats are to be entered as an array of strings.",
"properties": {
"fileFormats": {
"oneOf": [
{
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
{
"items": {
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"fileFormats"
],
"type": "object"
},
"imageID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the Image Data."
},
"isPreFiltered": {
"description": "(Optional) - To be set as true if image is prefiltered.",
"type": "boolean"
},
"name": {
"description": "(Required) - Name of the Projection Image Data.",
"type": "string"
},
"numberOfImages": {
"description": "(Required) - Number of images in the data set. It is same as the number of projections.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical x,y length imaged by a single pixel, normally expressed in \u00b5m."
}
},
"required": [
"fileLocation",
"name",
"imageFormats",
"header"
],
"type": "object"
}
},
"required": [
"projectionImageDataStructure"
],
"type": "object"
},
"reconstructedData": {
"additionalProperties": false,
"description": "(Required) - Details about the reconstructed slices. When multiple reconstructions of the same raw data (projections) are present, the corresponding data can be combined as an array of reconstruction data sets, else as a single reconstruction data set.",
"properties": {
"reconstruction": {
"oneOf": [
{
"$ref": "#/$defs/reconstruction"
},
{
"items": {
"$ref": "#/$defs/reconstruction"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"reconstruction"
],
"type": "object"
}
},
"required": [
"projections",
"reconstructedData"
],
"type": "object"
},
"detector": {
"additionalProperties": false,
"description": "gives the settings of a detector or multiple detectors.",
"properties": {
"detectorSettings": {
"oneOf": [
{
"$ref": "#/$defs/detectorSettings"
},
{
"items": {
"$ref": "#/$defs/detectorSettings"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"detectorSettings"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "(Required) - Gives the settings of a single detector.",
"properties": {
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each pixel or voxel in an image. The bit depth determines the number of possible intensity levels that can be assigned to each pixel or voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"cameraGain": {
"description": "(Optional) - The amplification (gain) of the signal from an image sensor in a camera.",
"type": "number"
},
"detectorCoolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Cooling temperature of the detector, if it cooled. Relevant for SEM based CT. Typical unit - K."
},
"detectorDimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Optional) - The dimensions of the detector in integer values of xPixels and yPixels."
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector."
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the detector (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"detectorMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - The motor positions of the detector in cartesian coordinates and tilt angles."
},
"detectorName": {
"description": "(Optional) - Name of the detector of datatype string.",
"type": "string"
},
"detectorPixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical length in cartesian coordinates imaged by a single pixel of the detector. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"detectorType": {
"description": "(Optional) - The type of detector to be selected from a controlled list consisting of CCD, Panel, PCXD, CMOS, Time-Delay Integration (TDI) and Direct Conversion.",
"enum": [
"CCD",
"Panel",
"PCXD",
"CMOS",
"Time-Delay Integration (TDI)",
"Direct Conversion"
],
"type": "string"
},
"energyThreshold": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - A specific energy level used to filter the detected radiation."
},
"exposureTimePerFrame": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Time for which the sample is exposed per frame. Typical unit - s."
},
"frameSkip": {
"additionalProperties": false,
"description": "(Optional) - A numerical representation indicating the number of frames that are skipped or omitted during the acquisition or recording process. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3. If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped.",
"properties": {
"value": {
"oneOf": [
{
"description": "(Optional) - Number of frames skipped during acquisition. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3.",
"type": "number"
},
{
"description": "(Optional) - Pattern of frames skipped during acquisition. E.g. - If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped like [1,3,5]",
"items": {
"type": "number"
},
"minItems": 1,
"type": "array"
}
]
}
},
"type": "object"
},
"framesPerSecond": {
"description": "(Optional) - The number of frames captured in a second.",
"type": "number"
},
"imagePixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical length in cartesian coordinates imaged by a single pixel of the image. It is the native pixel size divided by the total magnification. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"lens": {
"additionalProperties": false,
"description": "(Optional) - Details of a lens, if used with the detector.",
"properties": {
"hasLens": {
"description": "(Required) - To be set to true if the detector has a lens.",
"type": "boolean"
},
"lensFocalLength": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Focal length of the lens."
},
"lensID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the lens."
},
"lensMagnification": {
"description": "(Optional) - Magnification of the lens as a floating point number.",
"type": "number"
},
"lensManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the lens (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"lensName": {
"description": "(Optional) - Name of the lens of datatype string.",
"type": "string"
}
},
"required": [
"lensMagnification",
"lensFocalLength"
],
"type": "object"
},
"numberOfAveragedFramesPerProjection": {
"description": "(Optional) - The number of averaged frames per projection, if averaging is done.",
"type": "number"
},
"sensor": {
"additionalProperties": false,
"description": "(Optional) - Details about a sensor, if present.",
"properties": {
"hasSensor": {
"description": "(Required) - To be set to true if the detector has a sensor.",
"type": "boolean"
},
"sensorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the sensor."
},
"sensorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the sensor (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"sensorMaterial": {
"description": "(Optional) - Material of the sensor of datatype string.",
"type": "string"
},
"sensorName": {
"description": "(Optional) - Name of the sensor of datatype string.",
"type": "string"
},
"sensorThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the sensor."
},
"sensorType": {
"description": "(Optional) - The type of sensor as a string.",
"type": "string"
}
},
"required": [
"hasSensor"
],
"type": "object"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Temperature of the detector."
},
"totalCountsPerProjection": {
"description": "(Optional) - The sum of the intensity values recorded by the X-ray detector for a single projection during a scan.",
"type": "number"
}
},
"required": [
"detectorType",
"detectorManufacturer",
"binning",
"detectorMotorPositions",
"imagePixelSize"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m).",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ).",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min). Typical unit - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"geometry": {
"additionalProperties": false,
"description": "Describes the geometry of the CT instrument",
"properties": {
"beamGeometry": {
"additionalProperties": false,
"description": "(Required) - Details about beam geometry like beam geometry type and divergence angle.",
"properties": {
"beamGeometryType": {
"description": "(Required) - The type of the beam geometry to be selected between 'collimated' and 'divergent'.",
"enum": [
"collimated",
"divergent"
],
"type": "string"
},
"divergenceAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Angle of divergence when the beam geometry is divergent. Typical unit - degree."
}
},
"type": "object"
},
"geometricMagnification": {
"description": "(Required) - Geometric magnification refers to the ratio of the size of an object's image to the size of the object itself. It is a measure of how much larger the image appears compared to the actual object. Geometric magnification (M) is calculated using the formula M = (SID + SOD) / SID, where SID is the source-to-image distance and SOD is the source-to-object distance.",
"type": "number"
},
"objectToDetectorDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the object and the detector. Typical unit - \u00b5m."
},
"opticalMagnification": {
"description": "(Required) - Optical magnification is calculated as the ratio of the focal length of the objective lens to the focal length of the eyepiece (if an eyepiece is present) in a traditional optical microscope.",
"type": "number"
},
"sourceToObjectDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the source and the object. Typical unit - \u00b5m."
}
},
"required": [
"sourceToObjectDistance",
"objectToDetectorDistance",
"beamGeometry",
"geometricMagnification",
"opticalMagnification"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"CTAquisition": {
"$ref": "#/$defs/CTAquisition",
"description": "(Optional) - Details regarding the acquisition."
},
"calibration": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the calibration and the scaling factor.",
"properties": {
"calibrationType": {
"description": "(Optional) - Type of calibration as a string.",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (YYYY-MM-DDThh:mm:ss.sss) in the ISO 8601 date-time format",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z?)$",
"type": "string"
},
"systemScaling": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scaling factor.",
"properties": {
"adjustSystemScaling": {
"description": "(Required) - To be set to true if system scaling is adjusted, else false.",
"type": "boolean"
},
"measuredScalingFactor": {
"description": "(Optional) - Value of the measured scaling factor.",
"type": "number"
},
"referenceScalingFactor": {
"description": "(Optional) - Value of the reference scaling factor, determined ususally during the data processing.",
"type": "number"
}
},
"required": [
"adjustSystemScaling"
],
"type": "object"
}
},
"type": "object"
},
"detector": {
"$ref": "#/$defs/detector",
"description": "(Optional) - Details regarding the detector."
},
"focalSpotMode": {
"additionalProperties": false,
"description": "(Optional) - Option for setting the size of the focal spot. Some sources have the option to select the target spot size, or focal spot size absolutely by setting a value, while some others give the option of selecting 'small', 'medium' or 'large'. Smaller spot size = higher resolution. Note that the power/current will change with this value. In addition, the detector settings will usually be selected in conjunction. (different scintillator/lens/magnification).",
"properties": {
"selection": {
"description": "(Optional) - Selection of the setting of the size of the focal spot when the option for setting the size of the focal spot by selecting 'small', 'medium' or 'large' according to predefined values set by the manufacturer.",
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the target spot when the option for setting the size of the focal spot absolutely by setting a value is available."
}
},
"type": "object"
},
"geometry": {
"$ref": "#/$defs/geometry",
"description": "(Optional) - Details regarding the geometry."
},
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"optics": {
"$ref": "#/$defs/optics",
"description": "(Optional) - Details about the optics and individual motor positions."
},
"sampleStage": {
"$ref": "#/$defs/sampleStage",
"description": "(Optional) - Details regarding the sample stage."
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray target in an SEM based CT set-up.",
"properties": {
"SEMManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the scanning electron microscope used for SEM based CT."
},
"SEMName": {
"description": "(Optional) - Name of the scanning electron microscope used for SEM based CT.",
"type": "string"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the material which acts as the cathode in SEM based CT",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details of the pressure maintained in the chamber of the SEM."
},
"electronBeamShift": {
"additionalProperties": false,
"description": "(Optional) - The distance by which the electron beam is shifted in the x and y directions.",
"properties": {
"xShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Beam shift in the x direction. Typical unit - \u00b5m."
},
"yShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Beam shift in the y direction. Typical unit - \u00b5m."
}
},
"type": "object"
},
"electronProbeCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required) - The electron current measured at the probe. Typical unit - \u00b5A."
},
"objectiveLensAperture": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). Typically the diameter of the aperture is set in \u00b5m."
},
"target": {
"additionalProperties": false,
"description": "(Required) - Details regarding the target in SEM based CT, which upon interaction with the e-beam produces the X-rays.",
"properties": {
"targetDriftCorrection": {
"description": "(Required) - If drift correction is activated for the target, this parameter has to be set to true.",
"type": "boolean"
},
"targetMaterial": {
"description": "(Required) - Material with which the target is made.",
"type": "string"
},
"targetShape": {
"description": "(Optional) - Description of the shape or geometry of the target. e.g. - bulk, foil, needle.",
"type": "string"
},
"targetThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Thickness of the target (dimension in Z direction). Default unit - \u00b5m."
},
"targetTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the target is tilted. Typical unit - degree."
}
},
"required": [
"targetMaterial",
"targetThickness",
"targetDriftCorrection",
"targetTiltAngle"
],
"type": "object"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - Acceleration Voltage set in the SEM. Default unit - kV."
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. In SEM based CT, the beam is focussed on the target material which emits the X-rays upon interaction with the electrons. Default unit - \u00b5m."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray energy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Optional) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"xrayCharacteristicLine": {
"description": "(Optional) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"workingDistance",
"objectiveLensAperture",
"electronProbeCurrent",
"voltage",
"target"
],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
},
"targetCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current measured at the X-ray target, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"sourceDrift": {
"additionalProperties": false,
"description": "(Optional) - Distance by which the source is shifted during the measurement (i.e., end position - start position).",
"properties": {
"xDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the x direction. Typical unit - \u00b5m."
},
"yDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xDrift",
"yDrift"
],
"type": "object"
},
"sourcePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the source."
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray energy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source",
"focalSpotMode",
"CTAquisition",
"geometry",
"sampleStage",
"detector"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer.",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"bioReactor": {
"additionalProperties": false,
"description": "(Optional) - Details of an in situ bioreactor.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in sterile conditions.",
"type": "boolean"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is decreased. Typical unit - K/min."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is increased, typically in K/min."
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"anvil": {
"description": "(Optional) - The type of anvil used in the in situ load frame (stage) for applying a particular type of force on the sample. Option to be selected from a controlled list consisting of - Compression, Diamond indentation 90\u00b0 cone, Diamond indentation cube corner, Diamond indentation wedge, Tension, Other. If 'Other' is selected, specify the name of the anvil with a description in the field 'otherAnvil'.",
"enum": [
"Compression",
"Diamond indentation 90\u00b0 cone",
"Diamond indentation cube corner",
"Diamond indentation wedge",
"Tension",
"Other"
],
"type": "string"
},
"blindAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - ed by the load frame(stage). Example: for a CT normally scanned over 180\u00b0 (e.g. -90\u00b0/+90\u00b0), a blind angle of 40\u00b0 due to the in situ cell implies that only 180\u00b0-40\u00b0=140\u00b0 (e.g. -70\u00b0/70\u00b0) is visible. NOTE: for a CT normally scanned over 360\u00b0 (e.g. -180\u00b0/+180\u00b0), a blind angle of 40\u00b0 would require the subtraction of the blind angle twice, implying two scan ranges of 140\u00b0 each (e.g. -160\u00b0/-20\u00b0 and +20\u00b0/+160\u00b0). Typical unit - degree."
},
"displacement": {
"additionalProperties": false,
"description": "(Optional) - Specification on how displacement is applied on the sample. Either 'displacementRate' in \u00b5m/min or 'displacementIncrement' in \u00b5m/acquisition need to be selected.",
"properties": {
"displacementIncrement": {
"description": "(Optional) - The step at which displacement is changed per acquisition in \u00b5m/acquisition.",
"type": "number"
},
"displacementRate": {
"description": "(Optional) - The rate at which displacement is applied on the sample in \u00b5m/min.",
"type": "number"
}
},
"type": "object"
},
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame or anvil (e.g. - size of anvil) relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
},
"maximumDisplacement": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - The maximum displacement allowed in the selected configuration. Typical unit - \u00b5m."
},
"maximumForce": {
"description": "(Optional) - The maximum force that can be applied to the sample in N.",
"type": "number"
},
"otherAnvil": {
"description": "(Optional) - If 'anvil' was selected as 'Other' from the controlled list as it was not listed, please specify the name of the anvil with a description in this field.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the vacuum chamber relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the vacuum chamber relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the vacuum chamber."
},
"chamberName": {
"description": "(Optional) - Name of the vacuum chamber.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"motorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchical level and direction of a motor.",
"properties": {
"motorDirection": {
"description": "(Required) - The direction of movement (for X,Y,Z,M motors) or axis of rotation (for rotating motors) expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the X-stage and perpendicular to the Y-stage. then beam direction = [1 0 0], X-stage-direction = [1 0 0] (positive movement direction away from source towards detector) or can be (-1 0 0) (towards source) and Y-stage-direction = [0 1 0] or can be [0 -1 0] (analogous interpretation). The parameters need to be individually determined for each instrument. For rotating motors, the directional vector of axis of rotation should be given in Cartesian coordinates (counterclockwise, right-hand rule).",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"motorLevel": {
"description": "(Required) - Hierarchy of the motor expressed as an integer.",
"type": "number"
}
},
"type": "object"
},
"motorPositions": {
"additionalProperties": false,
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the motor.",
"properties": {
"angles": {
"$ref": "#/$defs/angleSet",
"description": "(Optional) - The three tilt angles alpha, beta and gamma of the motors controlling the position of the item."
},
"xyzPositions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - The xyz coordinates describing the motor positions of the item."
}
},
"type": "object"
},
"optics": {
"additionalProperties": false,
"description": "(Optional) - Details about the optics and individual motor positions.",
"properties": {
"collimator": {
"additionalProperties": false,
"description": "(Optional) - Details about the collimator and its individual motor positions.",
"properties": {
"collimatorDetails": {
"description": "(Optional) - Details about the collimator relevant for the measurement.",
"type": "string"
},
"collimatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the collimator."
}
},
"type": "object"
},
"condenser": {
"additionalProperties": false,
"description": "(Optional) - Details about the condenser lens and its individual motor positions, if used.",
"properties": {
"condenserDetails": {
"description": "(Optional) - Details about the condenser relevant for the measurement.",
"type": "string"
},
"condenserPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the condenser."
}
},
"type": "object"
},
"fresnelZonePlate": {
"additionalProperties": false,
"description": "(Optional) - Details about the fresnel zone plate and its individual motor positions, if used.",
"properties": {
"fresnelZonePlateDetails": {
"description": "(Optional) - Details about the fresnel zone plate relevant for the measurement.",
"type": "string"
},
"fresnelZonePlatePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the fresnel zone plate."
}
},
"type": "object"
},
"monochromator": {
"additionalProperties": false,
"description": "(Required) - Details about the monochromator and individual motor positions, if used.",
"properties": {
"monochromatorDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the monochromator type type, material, energy and notes.",
"properties": {
"energy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Energy set in the monochromator. Typical unit - eV."
},
"material": {
"description": "(Optional) - Material of the monochromator.",
"type": "string"
},
"monochromatorType": {
"description": "(Optional) - Type of the monochromator.",
"type": "string"
},
"notes": {
"description": "(Optional) - Additional information about the monochromator relevant for the measurement."
}
},
"type": "object"
},
"monochromatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the monochromator."
},
"monochromatorUsed": {
"description": "(Required) - To be set to true if monochromator is used, else false.",
"type": "boolean"
}
},
"required": [
"monochromatorUsed"
],
"type": "object"
},
"phaseRing": {
"additionalProperties": false,
"description": "(Required) - Details about the phase ring and its individual motor positions, if inserted.",
"properties": {
"phaseRingDetails": {
"description": "(Optional) - Details about the phase ring relevant for the measurement.",
"type": "string"
},
"phaseRingPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the phase ring."
}
},
"type": "object"
}
},
"required": [
"monochromator"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes a parameter which can be split into number of pixels in x and y directions like the resolution",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm or \u00b5m, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the size of a single pixel (typical value - nm, \u00b5m) of datatype string",
"enum": [
"nm",
"\u00b5m"
],
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min).",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW).",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi).",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"rampDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a rate at which temperature is increased or decreased.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K/min, K/s).",
"enum": [
"K/min",
"K/s"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of temperature increase or decrease.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"reconstruction": {
"additionalProperties": false,
"description": "Data from one single reconstruction.",
"properties": {
"reconstructionDetails": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"additionalFilters": {
"beamHardeningCorrection": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"filterType": {
"description": "(Optional) - Type of the additional filter - Median or Gauss",
"enum": [
"Median",
"Gauss"
],
"type": "string"
},
"phaseRetrieval": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"ringFilter": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
}
},
"algorithm": {
"description": "(Required) - Algorithm used for reconstruction to be selected from FBP - Filtered Back Projection, ART - Algebraic Reconstruction Technique, 3dCT - 3D Computed Tomography and Gridrec.",
"enum": [
"FBP - Filtered Back Projection",
"ART - Algebraic Reconstruction Technique",
"3dCT - 3D Computed Tomography",
"Gridrec"
],
"type": "string"
},
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepthConversionMax": {
"description": "(Required) - Maximum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"bitDepthConversionMin": {
"description": "(Required) - Minimum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"hardwarePlatform": {
"description": "(Optional) - Hardware platform used for reconstruction to be selected between CPU and GPU.",
"enum": [
"CPU",
"GPU"
],
"type": "string"
},
"lastImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the last image for the reconstruction of the 3D Volume, typically an integer.",
"type": "string"
},
"projectionPadding": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the projection padding applied to the raw projection data to address certain issues in the reconstruction process.",
"properties": {
"paddingSize": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - Size of the projection padding used in pixels."
},
"paddingType": {
"description": "(Required) - Type of the projection padding used - Zero Padding, Linear Interpolation Padding, Sinc Interpolation Padding, Shepp-Logan Filtered Back Projection (SL-FBP), Gridding and Extended Field of View (FOV) Padding.",
"enum": [
"Zero Padding",
"Linear Interpolation Padding",
"Sinc Interpolation Padding",
"Shepp-Logan Filtered Back Projection (SL-FBP)",
"Gridding",
"Extended Field of View (FOV) Padding"
],
"type": "string"
}
},
"type": "object"
},
"reconstructionSoftware": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for reconstruction. It may be the same as the acquisition software or a different one."
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Scan angle at which the reconstruction of the 3D Volume starts. Typical unit - degree."
},
"startImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the start image for the reconstruction of the 3D Volume.",
"type": "string"
},
"tomographicProjectionFilter": {
"description": "(Optional) - Name of the tomographic projection filter used to be selected from Ram-Lak Filter, Butterworth Filter, Shepp-Logan Filter, Hann (Hanning) Filter, Gaussian Filter, Cosine Filter, Soft Filtration Method and Hard Filtration Method.",
"enum": [
"Ram-Lak Filter",
"Butterworth Filter",
"Shepp-Logan Filter",
"Hann (Hanning) Filter",
"Gaussian Filter",
"Cosine Filter",
"Soft Filtration Method",
"Hard Filtration Method"
],
"type": "string"
}
},
"required": [
"startImage",
"lastImage",
"startAngle",
"hardwarePlatform",
"algorithm",
"binning"
],
"type": "object"
},
"volumeStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each voxel in the 3D volume. The bit depth determines the number of possible intensity levels that can be assigned to each voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Required) - The dimension of the 3D volume in XYZ coordinates. If the length in Z dimension is not known and instead only the number of slices are known, they need to be separately entered in the field 'numberOfSlices'. Typical unit - \u00b5m."
},
"header": {
"additionalProperties": false,
"description": "(Optional) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Optional) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"name": {
"description": "(Required) - Name of the 3D volume structure (dataset).",
"type": "string"
},
"numberOfSlices": {
"description": "(Optional) - No. of slices which make up the 3D volume.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel/voxel, normally expressed in \u00b5m."
},
"volumeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry of the 3D reconstructed volume usually provided by the project or the laboratory."
}
},
"required": [
"name",
"dimensions",
"bitDepth",
"pixelSize"
],
"type": "object"
}
},
"required": [
"volumeStructure",
"reconstructionDetails"
],
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"sampleStage": {
"additionalProperties": false,
"description": "(Required) - Details about sample stage.",
"properties": {
"stageMotorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchy of the stage motors. This information is required to know how the motor movements affect the positions of the samples, particularly relevant for correlative characterization.",
"properties": {
"beamDirection": {
"description": "(Required) - The beam direction expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the Y-stage and perpendicular to the X-stage. then beam direction = [0 1 0].",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"mMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the M motor (stage) as a vector in cartesian coordiantes. The M motor is usually relevant only for SEM based CT. It is a special motor which counteracts the Z motor."
},
"rMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the R motor (stage) as a vector in cartesian coordiantes. R motor has rotation around z axis +1 (for anticlockwise)."
},
"tMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the T motor (stage) as a vector in cartesian coordiantes. The T motor is usually relevant only for SEM based CT."
},
"xMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the X motor (stage) as a vector in cartesian coordinates."
},
"yMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Y motor (stage) as a vector in cartesian coordinates."
},
"zMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Z motor (stage) as a vector in cartesian coordinates."
}
},
"required": [
"beamDirection",
"xMotor",
"yMotor",
"zMotor",
"rMotor"
],
"type": "object"
},
"stageMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the stage motors."
}
},
"required": [
"stageMotorHierarchy"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s).",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"user": {
"description": "Basic schema for user description. It can be extended.",
"properties": {
"ORCID": {
"description": "(Optional) - Open Researcher and Contributor ID expressed as a URI",
"pattern": "^https://orcid\\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[X0-9]{1}$",
"type": "string"
},
"affiliation": {
"description": "(Optional) - Details of the institution to which the user is affiliated",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"description": "(Optional) -Identifier of the institution to which the user is affiliated",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be chosen from a controlled list of values (*ROR *GRID *ISNI *URL *DOI *Handle)",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"email": {
"description": "(Optional) - Email of the user",
"format": "email",
"type": "string"
},
"familyName": {
"description": "(Optional) - Family name of the user",
"type": "string"
},
"givenName": {
"description": "(Optional) - Given name of the user",
"type": "string"
},
"role": {
"description": "(Required) - Role of the research user",
"enum": [
"Data Curator",
"Instrument Scientist",
"Team Leader",
"Team Member"
],
"type": "string"
},
"userName": {
"description": "(Required) - Full name of the user in the format (Family Name, Given Name)",
"type": "string"
}
},
"required": [
"userName",
"role"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV).",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided. Contributors (in alphabetical order of last names): Alexey Boubnov, Rafaela Debastiani, Jonas Fell, Sarah Irvine, Reetu Elza Joseph.",
"properties": {
"consumables": {
"description": "(Optional) - Auxiliary entity used during Fabrication, Sample Preparation or Measurement which has a limited time capacity or is limited in its number of uses before it is disposed of, necessary to the process itself and normally bought from third party manufacturers. Examples are: gloves, syringes, wipes, etching solutions, glass slides, spatulas, weighing paper, two-sided tape.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"data": {
"$ref": "#/$defs/data",
"description": "(Required)- Details concerning the data section of the measurement."
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format YYYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z?)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry usually provided by the project or the laboratory."
},
"equipment": {
"description": "(Optional) - Any kind of physical or virtual item, device, machine or other tools used to perform one or more Fabrication(s), Sample Preparation(s), Model Preparation(s), Data Acquisition(s) and/or any of the processes included in the Data Analysis Lifecycle. Usually, the Equipment is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. Equipment is usually an investment. According to this definition, an Instrument is a particular type of Equipment.",
"type": "string"
},
"experimentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the measurement usually provided by the project or the laboratory."
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings. Instrument is a physical or virtual identifiable piece of Equipment used to perform a Data Acquisition and to generate Raw Data. The Instrument is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. A virtual Instrument may be any computational resource or HPC infrastructure (cloud infrastructure or supercomputer) needed to perform Calculations or Simulations."
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure."
},
"measurementDescription": {
"description": "(Optional) - Description about the measurement.",
"type": "string"
},
"measurementPurpose": {
"description": "(Required) - Measurement is experimental Data Acquisition, typically performed on a Sample using an experimental Technique. It may also be performed during Fabrication or Sample Preparation, e.g., to characterise the intermediate stages and/or the final resulting Precursor(s) or Sample(s), respectively. A Measurement may require the use of Consumables.",
"enum": [
"assessment (to given categories or values)",
"completeness check (presence or absence of given properties)",
"correlative characterization (dedicated sample treatment to emphasise given features)",
"exploratory (routine check of known properties)",
"feasibility (quick check, rough estimate)",
"high quality measurement (precise, careful treatment)",
"test specific hypothesis (focus only on given aspects)",
"other (please specify in the comment)"
],
"type": "string"
},
"parents": {
"description": "(Required) - Parents of this metadata like the metadata document of the sample with which the measurement was performed.",
"items": {
"if": {
"properties": {
"parentType": {
"not": {
"const": "not applicable"
}
}
}
},
"properties": {
"parentReference": {
"description": "If type is 'MetaStore URI' it is possible to easily fill this field in a later stage",
"format": "uri-reference",
"type": "string"
},
"parentReferenceType": {
"default": "MetaStore URI",
"enum": [
"plain text",
"external URL",
"MetaStore URI"
],
"type": "string"
},
"parentType": {
"default": "sample",
"enum": [
"not applicable",
"sample"
],
"type": "string"
}
},
"required": [
"parentType"
],
"then": {
"required": [
"parentReferenceType",
"parentReference"
]
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition."
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format."
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format YYYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z?)$",
"type": "string"
},
"technique": {
"description": "(Required) - Any experimental, theoretical or computational method used during Data Acquisition or during any of the processes included in the Data Analysis Lifecycle to acquire, process or analyse Research Data about a System or a set of them with an Instrument, which is used to generate this metadata.",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement.",
"type": "string"
},
"user": {
"$ref": "#/$defs/user",
"description": "(Required)- The contact information of the user responsible for the measurement."
}
},
"required": [
"title",
"technique",
"parents",
"measurementPurpose",
"startTime",
"endTime",
"program",
"user",
"instrument",
"data"
],
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | a630c6dc650ba68cd6c85f4608ef178b9a85c110 | 2023-11-24T15:29:33 | SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "degree",
"description": "(Optional) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (pA, nA, \u00b5A, mA, A)",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the current",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "Pa",
"description": "(Optional) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"stage": {
"additionalProperties": false,
"description": "Describes the stage.",
"properties": {
"activeStage": {
"description": "(Required)- Describes the stage in use",
"type": "string"
},
"specTilt": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional)- Pretilt of the sample, usually due to pretilted holder."
},
"stageM": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- M coordinate of the position of the stage (additional translation axis available in Zeiss instruments)"
},
"stageR": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Angle by which the stage is rotated"
},
"stageTa": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Tilt angle alpha of the stage"
},
"stageTb": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Tilt angle beta of the stage"
},
"stageX": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- X coordinate of the position of the stage"
},
"stageY": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Y coordinate of the position of the stage"
},
"stageZ": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Z coordinate of the position of the stage"
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. IRI: https://purls.helmholtz-metadaten.de/EMG/00000026"
}
},
"required": [
"workingDistance",
"stageX",
"stageY",
"stageZ",
"stageR",
"stageTa",
"stageTb",
"activeStage"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"vacuum": {
"additionalProperties": false,
"description": "Describes the vacuum maintained in the system.",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- The pressure maintained in the electron chamber"
},
"gas": {
"description": "(Required)- The gas used in the electron chamber",
"type": "string"
},
"humidity": {
"description": "(Required)- Describes the humidity in the chamber during the measurement",
"type": "string"
},
"userMode": {
"description": "(Required)- The type of vacuum slected by the user",
"enum": [
"High vacuum",
"Medium vacuum",
"Low vacuum"
],
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes an individual image acquired during the course of a SEM/FIB Tomography experiment. Each image is taken using a detector (SE, BSE, EDS, EBSD) at each slice cut using FIB. This Schema contains only the parameters which are specific to the individual image. The parameters which are common to the entire set are described by another schema which describes the dataset as a whole and is located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json.",
"properties": {
"creationTime": {
"description": "(Required)- Time of creation of the image",
"pattern": "(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z)",
"type": "string"
},
"definition": {
"description": "(Required)- Name of the schema to which this entry conforms. In this case, acquisition_image should be written",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Identifier of the image produced by the machine"
},
"fileLink": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Link to the location of the image"
},
"fileName": {
"description": "(Required)- File name of the image",
"type": "string"
},
"specimenCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required)- Current measured on the specimen during acquisition of the image"
},
"stage": {
"$ref": "#/$defs/stage",
"description": "(Required)- Details concerning stage settings used for aquisition"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required)- Temperature of the sample during acquisition"
},
"vacuum": {
"$ref": "#/$defs/vacuum",
"description": "(Required)- Details concerning the vacuum during aquisition"
}
},
"required": [
"fileName",
"creationTime",
"definition",
"stage",
"vacuum",
"temperature"
],
"title": "acquisition_image",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | d86cfaf4bc575c93bb74983b3385140026a7ec01 | 2024-02-20T09:20:01 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"CTAquisition": {
"additionalProperties": false,
"description": "(Required) - Details about the acquisition.",
"properties": {
"acquisitionScriptName": {
"description": "(Required) - Name of the script used for acquisition.",
"type": "string"
},
"acquisitionTimePerProjection": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time taken for acquisition of a single projection. Typical unit - s."
},
"angularStepSize": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Step size of the rotation of the sample during the CT. Typical unit - degree."
},
"contrastType": {
"description": "(Required) - The contrast type(mode) used - Absorption Contrast or Phase Contrast. If 'Phase Contrast' is selected, please indicate the used Phase Contrast Mode under the field phaseContrastMode.",
"enum": [
"Absorption Contrast",
"Phase Contrast"
],
"type": "string"
},
"endAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - End angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then endAngle is 180\u00b0. Typical unit - degree."
},
"largeFOV": {
"description": "(Required) - To be set to true if large field of view or wide field of view is used.",
"type": "boolean"
},
"numberOfProjections": {
"description": "(Required) - Number of projections acquired during the CT.",
"type": "number"
},
"phaseContrastMode": {
"description": "(Optional) - The phase contrast mode used during acquisition - Zernike phase contrast, propagation-based, grating-based(Hartmann), grating-based(Talbot).",
"enum": [
"Zernike phase contrast",
"Propagation-based",
"Grating-based(Hartmann)",
"Grating-based(Talbot)"
],
"type": "string"
},
"referenceImages": {
"additionalProperties": false,
"description": "(Optional) - Details on the reference images (if used) - number of flats/bright images and number of dark images.",
"properties": {
"numberOfBrightImages": {
"description": "(Optional) - Number of flats or bright images used as reference.",
"type": "number"
},
"numberOfDarkImages": {
"description": "(Optional) - Number of dark images used as reference.",
"type": "number"
}
},
"type": "object"
},
"scanningMode": {
"description": "(Optional) - The scanning mode used during acquisition - helical, raster scanning, fast CT.",
"enum": [
"Helical",
"Raster Scanning",
"Fast CT"
],
"type": "string"
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Start angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then startAngle is -180\u00b0. Typical unit - degree."
},
"totalAcquisitionTime": {
"description": "(Required) - Time taken for acquisition for the entire scan. This is the total scan time, i.e. number of projections multipled by exposure time, but including read-out time. calculated as EndTime-StartTime. Format: hh:mm:ss.",
"format": "time",
"pattern": "^(\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?)$",
"type": "string"
},
"useBadPixelMap": {
"description": "(Optional) - To be set to true if bad pixel map is used. This parameter is relevant for SEM based CT.",
"type": "boolean"
}
},
"required": [
"acquisitionScriptName",
"startAngle",
"endAngle",
"angularStepSize",
"acquisitionTimePerProjection",
"totalAcquisitionTime",
"largeFOV",
"contrastType"
],
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian) of datatype string.",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"angleSet": {
"additionalProperties": false,
"description": "(Optional) - Tilt angles alpha, beta and gamma decribing the three angular positions of an item.",
"properties": {
"alpha": {
"description": "(Optional) - Tilt angle alpha of the item.",
"type": "number"
},
"anglesUnit": {
"description": "(Optional) - unit of the angles (allowed units - degree or radian)",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"beta": {
"description": "(Optional) - Rotation angle beta of the item.",
"type": "number"
},
"gamma": {
"description": "(Optional) - Angle gamma of the item.",
"type": "number"
}
},
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A).",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"data": {
"additionalProperties": false,
"description": "(Required) - Details about the data section of the measurement.",
"properties": {
"projections": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"cropping": {
"additionalProperties": false,
"description": "(Optional) - Details about cropping or clipping to select a region of interest(ROI).",
"properties": {
"ROI": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The size of the region of interest (ROI) in integer values of xPixels and yPixels."
},
"offset": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The offset applied to the origin (i.e., centre of the image) to select the region of interest in x and y coordinates."
}
},
"required": [
"ROI",
"offset"
],
"type": "object"
},
"projectionImageDataStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the data structure of the image data of the projections.",
"properties": {
"IOValue": {
"description": "(Required) - The IO value obtained from the metadata.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The dimension of the image as for integer values of xPixels and yPixels."
},
"fileLocation": {
"description": "(Required) - The location where the data file is stored. A URL is preferred if available.",
"type": "string"
},
"greyValueRepresentation": {
"description": "(Optional) - Description about the grey value representation.",
"type": "string"
},
"header": {
"additionalProperties": false,
"description": "(Required) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Required) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"imageCorrection": {
"additionalProperties": false,
"description": "(Optional) - Details about the image correction.",
"properties": {
"isImageCorrected": {
"description": "(Required) - To be set as true if image is corrected.",
"type": "boolean"
},
"linkToReferenceImages": {
"description": "(Required) - Link to the reference images (flats/darks).",
"format": "uri-reference",
"type": "string"
}
},
"required": [
"isImageCorrected",
"linkToReferenceImages"
],
"type": "object"
},
"imageFormats": {
"additionalProperties": false,
"description": "(Required) - The file formats of the images - tiff, png, jpeg. When more than one file formats are there, then the formats are to be entered as an array of strings.",
"properties": {
"fileFormats": {
"oneOf": [
{
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
{
"items": {
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"fileFormats"
],
"type": "object"
},
"imageID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the Image Data."
},
"isPreFiltered": {
"description": "(Optional) - To be set as true if image is prefiltered.",
"type": "boolean"
},
"name": {
"description": "(Required) - Name of the Projection Image Data.",
"type": "string"
},
"numberOfImages": {
"description": "(Required) - Number of images in the data set. It is same as the number of projections.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical x,y length imaged by a single pixel, normally expressed in \u00b5m."
}
},
"required": [
"fileLocation",
"name",
"imageFormats",
"header"
],
"type": "object"
}
},
"required": [
"projectionImageDataStructure"
],
"type": "object"
},
"reconstructedData": {
"additionalProperties": false,
"description": "(Required) - Details about the reconstructed slices. When multiple reconstructions of the same raw data (projections) are present, the corresponding data can be combined as an array of reconstruction data sets, else as a single reconstruction data set.",
"properties": {
"reconstruction": {
"oneOf": [
{
"$ref": "#/$defs/reconstruction"
},
{
"items": {
"$ref": "#/$defs/reconstruction"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"reconstruction"
],
"type": "object"
}
},
"required": [
"projections",
"reconstructedData"
],
"type": "object"
},
"detector": {
"additionalProperties": false,
"description": "gives the settings of a detector or multiple detectors.",
"properties": {
"detectorSettings": {
"oneOf": [
{
"$ref": "#/$defs/detectorSettings"
},
{
"items": {
"$ref": "#/$defs/detectorSettings"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"detectorSettings"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "(Required) - Gives the settings of a single detector.",
"properties": {
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each pixel or voxel in an image. The bit depth determines the number of possible intensity levels that can be assigned to each pixel or voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"cameraGain": {
"description": "(Optional) - The amplification (gain) of the signal from an image sensor in a camera.",
"type": "number"
},
"detectorCoolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Cooling temperature of the detector, if it cooled. Relevant for SEM based CT. Typical unit - K."
},
"detectorDimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Optional) - The dimensions of the detector in integer values of xPixels and yPixels."
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector."
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the detector (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"detectorMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - The motor positions of the detector in cartesian coordinates and tilt angles."
},
"detectorName": {
"description": "(Optional) - Name of the detector of datatype string.",
"type": "string"
},
"detectorPixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical length in cartesian coordinates imaged by a single pixel of the detector. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"detectorType": {
"description": "(Optional) - The type of detector to be selected from a controlled list consisting of CCD, Panel, PCXD, CMOS, Time-Delay Integration (TDI) and Direct Conversion.",
"enum": [
"CCD",
"Panel",
"PCXD",
"CMOS",
"Time-Delay Integration (TDI)",
"Direct Conversion"
],
"type": "string"
},
"energyThreshold": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - A specific energy level used to filter the detected radiation."
},
"exposureTimePerFrame": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Time for which the sample is exposed per frame. Typical unit - s."
},
"frameSkip": {
"additionalProperties": false,
"description": "(Optional) - A numerical representation indicating the number of frames that are skipped or omitted during the acquisition or recording process. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3. If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped.",
"properties": {
"value": {
"oneOf": [
{
"description": "(Optional) - Number of frames skipped during acquisition. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3.",
"type": "number"
},
{
"description": "(Optional) - Pattern of frames skipped during acquisition. E.g. - If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped like [1,3,5]",
"items": {
"type": "number"
},
"minItems": 1,
"type": "array"
}
]
}
},
"type": "object"
},
"framesPerSecond": {
"description": "(Optional) - The number of frames captured in a second.",
"type": "number"
},
"imagePixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical length in cartesian coordinates imaged by a single pixel of the image. It is the native pixel size divided by the total magnification. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"lens": {
"additionalProperties": false,
"description": "(Optional) - Details of a lens, if used with the detector.",
"properties": {
"hasLens": {
"description": "(Required) - To be set to true if the detector has a lens.",
"type": "boolean"
},
"lensFocalLength": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Focal length of the lens."
},
"lensID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the lens."
},
"lensMagnification": {
"description": "(Optional) - Magnification of the lens as a floating point number.",
"type": "number"
},
"lensManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the lens (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"lensName": {
"description": "(Optional) - Name of the lens of datatype string.",
"type": "string"
}
},
"required": [
"lensMagnification",
"lensFocalLength"
],
"type": "object"
},
"numberOfAveragedFramesPerProjection": {
"description": "(Optional) - The number of averaged frames per projection, if averaging is done.",
"type": "number"
},
"sensor": {
"additionalProperties": false,
"description": "(Optional) - Details about a sensor, if present.",
"properties": {
"hasSensor": {
"description": "(Required) - To be set to true if the detector has a sensor.",
"type": "boolean"
},
"sensorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the sensor."
},
"sensorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the sensor (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"sensorMaterial": {
"description": "(Optional) - Material of the sensor of datatype string.",
"type": "string"
},
"sensorName": {
"description": "(Optional) - Name of the sensor of datatype string.",
"type": "string"
},
"sensorThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the sensor."
},
"sensorType": {
"description": "(Optional) - The type of sensor as a string.",
"type": "string"
}
},
"required": [
"hasSensor"
],
"type": "object"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Temperature of the detector."
},
"totalCountsPerProjection": {
"description": "(Optional) - The sum of the intensity values recorded by the X-ray detector for a single projection during a scan.",
"type": "number"
}
},
"required": [
"detectorType",
"detectorManufacturer",
"binning",
"detectorMotorPositions",
"imagePixelSize"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m).",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ).",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min). Typical unit - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"geometry": {
"additionalProperties": false,
"description": "Describes the geometry of the CT instrument",
"properties": {
"beamGeometry": {
"additionalProperties": false,
"description": "(Required) - Details about beam geometry like beam geometry type and divergence angle.",
"properties": {
"beamGeometryType": {
"description": "(Required) - The type of the beam geometry to be selected between 'collimated' and 'divergent'.",
"enum": [
"collimated",
"divergent"
],
"type": "string"
},
"divergenceAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Angle of divergence when the beam geometry is divergent. Typical unit - degree."
}
},
"type": "object"
},
"geometricMagnification": {
"description": "(Required) - Geometric magnification refers to the ratio of the size of an object's image to the size of the object itself. It is a measure of how much larger the image appears compared to the actual object. Geometric magnification (M) is calculated using the formula M = (SID + SOD) / SID, where SID is the source-to-image distance and SOD is the source-to-object distance.",
"type": "number"
},
"objectToDetectorDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the object and the detector. Typical unit - \u00b5m."
},
"opticalMagnification": {
"description": "(Required) - Optical magnification is calculated as the ratio of the focal length of the objective lens to the focal length of the eyepiece (if an eyepiece is present) in a traditional optical microscope.",
"type": "number"
},
"sourceToObjectDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the source and the object. Typical unit - \u00b5m."
}
},
"required": [
"sourceToObjectDistance",
"objectToDetectorDistance",
"beamGeometry",
"geometricMagnification",
"opticalMagnification"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"CTAquisition": {
"$ref": "#/$defs/CTAquisition",
"description": "(Optional) - Details regarding the acquisition."
},
"calibration": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the calibration and the scaling factor.",
"properties": {
"calibrationType": {
"description": "(Optional) - Type of calibration as a string.",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (YYYY-MM-DDThh:mm:ss.sss) in the ISO 8601 date-time format",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"systemScaling": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scaling factor.",
"properties": {
"adjustSystemScaling": {
"description": "(Required) - To be set to true if system scaling is adjusted, else false.",
"type": "boolean"
},
"measuredScalingFactor": {
"description": "(Optional) - Value of the measured scaling factor.",
"type": "number"
},
"referenceScalingFactor": {
"description": "(Optional) - Value of the reference scaling factor, determined ususally during the data processing.",
"type": "number"
}
},
"required": [
"adjustSystemScaling"
],
"type": "object"
}
},
"type": "object"
},
"detector": {
"$ref": "#/$defs/detector",
"description": "(Optional) - Details regarding the detector."
},
"focalSpotMode": {
"additionalProperties": false,
"description": "(Optional) - Option for setting the size of the focal spot. Some sources have the option to select the target spot size, or focal spot size absolutely by setting a value, while some others give the option of selecting 'small', 'medium' or 'large'. Smaller spot size = higher resolution. Note that the power/current will change with this value. In addition, the detector settings will usually be selected in conjunction. (different scintillator/lens/magnification).",
"properties": {
"selection": {
"description": "(Optional) - Selection of the setting of the size of the focal spot when the option for setting the size of the focal spot by selecting 'small', 'medium' or 'large' according to predefined values set by the manufacturer.",
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the target spot when the option for setting the size of the focal spot absolutely by setting a value is available."
}
},
"type": "object"
},
"geometry": {
"$ref": "#/$defs/geometry",
"description": "(Optional) - Details regarding the geometry."
},
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"optics": {
"$ref": "#/$defs/optics",
"description": "(Optional) - Details about the optics and individual motor positions."
},
"sampleStage": {
"$ref": "#/$defs/sampleStage",
"description": "(Optional) - Details regarding the sample stage."
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray target in an SEM based CT set-up.",
"properties": {
"SEMManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the scanning electron microscope used for SEM based CT."
},
"SEMName": {
"description": "(Required) - Name of the scanning electron microscope used for SEM based CT.",
"type": "string"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the material which acts as the cathode in SEM based CT",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required) - Details of the pressure maintained in the chamber of the SEM."
},
"electronBeamShift": {
"additionalProperties": false,
"description": "(Required) - The distance by which the electron beam is shifted in the x and y directions.",
"properties": {
"xShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the x direction. Typical unit - \u00b5m."
},
"yShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xShift",
"yShift"
],
"type": "object"
},
"electronProbeCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required) - The electron current measured at the probe. Typical unit - \u00b5A."
},
"objectiveLensAperture": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). Typically the diameter of the aperture is set in \u00b5m."
},
"target": {
"additionalProperties": false,
"description": "(Required) - Details regarding the target in SEM based CT, which upon interaction with the e-beam produces the X-rays.",
"properties": {
"targetDriftCorrection": {
"description": "(Required) - If drift correction is activated for the target, this parameter has to be set to true.",
"type": "boolean"
},
"targetMaterial": {
"description": "(Required) - Material with which the target is made.",
"type": "string"
},
"targetShape": {
"description": "(Optional) - Description of the shape or geometry of the target. e.g. - bulk, foil, needle.",
"type": "string"
},
"targetThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Thickness of the target (dimension in Z direction). Default unit - \u00b5m."
},
"targetTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the target is tilted. Typical unit - degree."
}
},
"required": [
"targetMaterial",
"targetThickness",
"targetDriftCorrection",
"targetTiltAngle"
],
"type": "object"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Acceleration Voltage set in the SEM. Default unit - kV."
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. In SEM based CT, the beam is focussed on the target material which emits the X-rays upon interaction with the electrons. Default unit - \u00b5m."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray energy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
}
},
"required": [
"chromaticity"
],
"type": "object"
}
},
"required": [
"chamberPressure",
"electronBeamShift",
"workingDistance",
"objectiveLensAperture",
"electronProbeCurrent",
"target"
],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
},
"targetCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current measured at the X-ray target, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"sourceDrift": {
"additionalProperties": false,
"description": "(Optional) - Distance by which the source is shifted during the measurement (i.e., end position - start position).",
"properties": {
"xDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the x direction. Typical unit - \u00b5m."
},
"yDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xDrift",
"yDrift"
],
"type": "object"
},
"sourcePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the source."
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray energy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source",
"focalSpotMode",
"CTAquisition",
"geometry",
"sampleStage",
"detector"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer.",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"bioReactor": {
"additionalProperties": false,
"description": "(Optional) - Details of an in situ bioreactor.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in sterile conditions.",
"type": "boolean"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is decreased. Typical unit - K/min."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is increased, typically in K/min."
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"anvil": {
"description": "(Optional) - The type of anvil used in the in situ load frame (stage) for applying a particular type of force on the sample. Option to be selected from a controlled list consisting of - Compression, Diamond indentation 90\u00b0 cone, Diamond indentation cube corner, Diamond indentation wedge, Tension, Other. If 'Other' is selected, specify the name of the anvil with a description in the field 'otherAnvil'.",
"enum": [
"Compression",
"Diamond indentation 90\u00b0 cone",
"Diamond indentation cube corner",
"Diamond indentation wedge",
"Tension",
"Other"
],
"type": "string"
},
"blindAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - ed by the load frame(stage). Example: for a CT normally scanned over 180\u00b0 (e.g. -90\u00b0/+90\u00b0), a blind angle of 40\u00b0 due to the in situ cell implies that only 180\u00b0-40\u00b0=140\u00b0 (e.g. -70\u00b0/70\u00b0) is visible. NOTE: for a CT normally scanned over 360\u00b0 (e.g. -180\u00b0/+180\u00b0), a blind angle of 40\u00b0 would require the subtraction of the blind angle twice, implying two scan ranges of 140\u00b0 each (e.g. -160\u00b0/-20\u00b0 and +20\u00b0/+160\u00b0). Typical unit - degree."
},
"displacement": {
"additionalProperties": false,
"description": "(Optional) - Specification on how displacement is applied on the sample. Either 'displacementRate' in \u00b5m/min or 'displacementIncrement' in \u00b5m/acquisition need to be selected.",
"properties": {
"displacementIncrement": {
"description": "(Optional) - The step at which displacement is changed per acquisition in \u00b5m/acquisition.",
"type": "number"
},
"displacementRate": {
"description": "(Optional) - The rate at which displacement is applied on the sample in \u00b5m/min.",
"type": "number"
}
},
"type": "object"
},
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame or anvil (e.g. - size of anvil) relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
},
"maximumDisplacement": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - The maximum displacement allowed in the selected configuration. Typical unit - \u00b5m."
},
"maximumForce": {
"description": "(Optional) - The maximum force that can be applied to the sample in N.",
"type": "number"
},
"otherAnvil": {
"description": "(Optional) - If 'anvil' was selected as 'Other' from the controlled list as it was not listed, please specify the name of the anvil with a description in this field.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the vacuum chamber relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the vacuum chamber relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the vacuum chamber."
},
"chamberName": {
"description": "(Optional) - Name of the vacuum chamber.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"motorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchical level and direction of a motor.",
"properties": {
"motorDirection": {
"description": "(Required) - The direction of movement (for X,Y,Z,M motors) or axis of rotation (for rotating motors) expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the X-stage and perpendicular to the Y-stage. then beam direction = [1 0 0], X-stage-direction = [1 0 0] (positive movement direction away from source towards detector) or can be (-1 0 0) (towards source) and Y-stage-direction = [0 1 0] or can be [0 -1 0] (analogous interpretation). The parameters need to be individually determined for each instrument. For rotating motors, the directional vector of axis of rotation should be given in Cartesian coordinates (counterclockwise, right-hand rule).",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"motorLevel": {
"description": "(Required) - Hierarchy of the motor expressed as an integer.",
"type": "number"
}
},
"type": "object"
},
"motorPositions": {
"additionalProperties": false,
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the motor.",
"properties": {
"angles": {
"$ref": "#/$defs/angleSet",
"description": "(Optional) - The three tilt angles alpha, beta and gamma of the motors controlling the position of the item."
},
"xyzPositions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - The xyz coordinates describing the motor positions of the item."
}
},
"type": "object"
},
"optics": {
"additionalProperties": false,
"description": "(Optional) - Details about the optics and individual motor positions.",
"properties": {
"collimator": {
"additionalProperties": false,
"description": "(Optional) - Details about the collimator and its individual motor positions.",
"properties": {
"collimatorDetails": {
"description": "(Optional) - Details about the collimator relevant for the measurement.",
"type": "string"
},
"collimatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the collimator."
}
},
"type": "object"
},
"condenser": {
"additionalProperties": false,
"description": "(Optional) - Details about the condenser lens and its individual motor positions, if used.",
"properties": {
"condenserDetails": {
"description": "(Optional) - Details about the condenser relevant for the measurement.",
"type": "string"
},
"condenserPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the condenser."
}
},
"type": "object"
},
"fresnelZonePlate": {
"additionalProperties": false,
"description": "(Optional) - Details about the fresnel zone plate and its individual motor positions, if used.",
"properties": {
"fresnelZonePlateDetails": {
"description": "(Optional) - Details about the fresnel zone plate relevant for the measurement.",
"type": "string"
},
"fresnelZonePlatePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the fresnel zone plate."
}
},
"type": "object"
},
"monochromator": {
"additionalProperties": false,
"description": "(Required) - Details about the monochromator and individual motor positions, if used.",
"properties": {
"monochromatorDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the monochromator type type, material, energy and notes.",
"properties": {
"energy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Energy set in the monochromator. Typical unit - eV."
},
"material": {
"description": "(Optional) - Material of the monochromator.",
"type": "string"
},
"monochromatorType": {
"description": "(Optional) - Type of the monochromator.",
"type": "string"
},
"notes": {
"description": "(Optional) - Additional information about the monochromator relevant for the measurement."
}
},
"type": "object"
},
"monochromatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the monochromator."
},
"monochromatorUsed": {
"description": "(Required) - To be set to true if monochromator is used, else false.",
"type": "boolean"
}
},
"required": [
"monochromatorUsed"
],
"type": "object"
},
"phaseRing": {
"additionalProperties": false,
"description": "(Required) - Details about the phase ring and its individual motor positions, if inserted.",
"properties": {
"phaseRingDetails": {
"description": "(Optional) - Details about the phase ring relevant for the measurement.",
"type": "string"
},
"phaseRingPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the phase ring."
}
},
"type": "object"
}
},
"required": [
"monochromator"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes a parameter which can be split into number of pixels in x and y directions like the resolution",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm or \u00b5m, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the size of a single pixel (typical value - nm, \u00b5m) of datatype string",
"enum": [
"nm",
"\u00b5m"
],
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min).",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW).",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi).",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"rampDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a rate at which temperature is increased or decreased.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K/min, K/s).",
"enum": [
"K/min",
"K/s"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of temperature increase or decrease.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"reconstruction": {
"additionalProperties": false,
"description": "Data from one single reconstruction.",
"properties": {
"reconstructionDetails": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"additionalFilters": {
"beamHardeningCorrection": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"filterType": {
"description": "(Optional) - Type of the additional filter - Median or Gauss",
"enum": [
"Median",
"Gauss"
],
"type": "string"
},
"phaseRetrieval": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"ringFilter": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
}
},
"algorithm": {
"description": "(Required) - Algorithm used for reconstruction to be selected from FBP - Filtered Back Projection, ART - Algebraic Reconstruction Technique, 3dCT - 3D Computed Tomography and Gridrec.",
"enum": [
"FBP - Filtered Back Projection",
"ART - Algebraic Reconstruction Technique",
"3dCT - 3D Computed Tomography",
"Gridrec"
],
"type": "string"
},
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepthConversionMax": {
"description": "(Required) - Maximum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"bitDepthConversionMin": {
"description": "(Required) - Minimum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"hardwarePlatform": {
"description": "(Optional) - Hardware platform used for reconstruction to be selected between CPU and GPU.",
"enum": [
"CPU",
"GPU"
],
"type": "string"
},
"lastImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the last image for the reconstruction of the 3D Volume, typically an integer.",
"type": "string"
},
"projectionPadding": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the projection padding applied to the raw projection data to address certain issues in the reconstruction process.",
"properties": {
"paddingSize": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - Size of the projection padding used in pixels."
},
"paddingType": {
"description": "(Required) - Type of the projection padding used - Zero Padding, Linear Interpolation Padding, Sinc Interpolation Padding, Shepp-Logan Filtered Back Projection (SL-FBP), Gridding and Extended Field of View (FOV) Padding.",
"enum": [
"Zero Padding",
"Linear Interpolation Padding",
"Sinc Interpolation Padding",
"Shepp-Logan Filtered Back Projection (SL-FBP)",
"Gridding",
"Extended Field of View (FOV) Padding"
],
"type": "string"
}
},
"type": "object"
},
"reconstructionSoftware": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for reconstruction. It may be the same as the acquisition software or a different one."
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Scan angle at which the reconstruction of the 3D Volume starts. Typical unit - degree."
},
"startImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the start image for the reconstruction of the 3D Volume.",
"type": "string"
},
"tomographicProjectionFilter": {
"description": "(Optional) - Name of the tomographic projection filter used to be selected from Ram-Lak Filter, Butterworth Filter, Shepp-Logan Filter, Hann (Hanning) Filter, Gaussian Filter, Cosine Filter, Soft Filtration Method and Hard Filtration Method.",
"enum": [
"Ram-Lak Filter",
"Butterworth Filter",
"Shepp-Logan Filter",
"Hann (Hanning) Filter",
"Gaussian Filter",
"Cosine Filter",
"Soft Filtration Method",
"Hard Filtration Method"
],
"type": "string"
}
},
"required": [
"startImage",
"lastImage",
"startAngle",
"hardwarePlatform",
"algorithm",
"binning"
],
"type": "object"
},
"volumeStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each voxel in the 3D volume. The bit depth determines the number of possible intensity levels that can be assigned to each voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Required) - The dimension of the 3D volume in XYZ coordinates. If the length in Z dimension is not known and instead only the number of slices are known, they need to be separately entered in the field 'numberOfSlices'. Typical unit - \u00b5m."
},
"header": {
"additionalProperties": false,
"description": "(Optional) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Optional) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"name": {
"description": "(Required) - Name of the 3D volume structure (dataset).",
"type": "string"
},
"numberOfSlices": {
"description": "(Optional) - No. of slices which make up the 3D volume.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel/voxel, normally expressed in \u00b5m."
},
"volumeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry of the 3D reconstructed volume usually provided by the project or the laboratory."
}
},
"required": [
"name",
"dimensions",
"bitDepth",
"pixelSize"
],
"type": "object"
}
},
"required": [
"volumeStructure",
"reconstructionDetails"
],
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"sampleStage": {
"additionalProperties": false,
"description": "(Required) - Details about sample stage.",
"properties": {
"stageMotorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchy of the stage motors. This information is required to know how the motor movements affect the positions of the samples, particularly relevant for correlative characterization.",
"properties": {
"beamDirection": {
"description": "(Required) - The beam direction expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the Y-stage and perpendicular to the X-stage. then beam direction = [0 1 0].",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"mMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the M motor (stage) as a vector in cartesian coordiantes. The M motor is usually relevant only for SEM based CT. It is a special motor which counteracts the Z motor."
},
"rMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the R motor (stage) as a vector in cartesian coordiantes. R motor has rotation around z axis +1 (for anticlockwise)."
},
"tMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the T motor (stage) as a vector in cartesian coordiantes. The T motor is usually relevant only for SEM based CT."
},
"xMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the X motor (stage) as a vector in cartesian coordinates."
},
"yMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Y motor (stage) as a vector in cartesian coordinates."
},
"zMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Z motor (stage) as a vector in cartesian coordinates."
}
},
"required": [
"beamDirection",
"xMotor",
"yMotor",
"zMotor",
"rMotor"
],
"type": "object"
},
"stageMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the stage motors."
}
},
"required": [
"stageMotorHierarchy"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s).",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"user": {
"description": "Basic schema for user description. It can be extended.",
"properties": {
"ORCID": {
"description": "(Optional) - Open Researcher and Contributor ID expressed as a URI",
"pattern": "^https://orcid\\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[X0-9]{1}$",
"type": "string"
},
"affiliation": {
"description": "(Optional) - Details of the institution to which the user is affiliated",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"description": "(Optional) -Identifier of the institution to which the user is affiliated",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be chosen from a controlled list of values (*ROR *GRID *ISNI *URL *DOI *Handle)",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"email": {
"description": "(Optional) - Email of the user",
"format": "email",
"type": "string"
},
"familyName": {
"description": "(Optional) - Family name of the user",
"type": "string"
},
"givenName": {
"description": "(Optional) - Given name of the user",
"type": "string"
},
"role": {
"description": "(Required) - Role of the research user",
"enum": [
"Data Curator",
"Instrument Scientist",
"Team Leader",
"Team Member"
],
"type": "string"
},
"userName": {
"description": "(Required) - Full name of the user in the format (Family Name, Given Name)",
"type": "string"
}
},
"required": [
"userName",
"role"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV).",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided. Contributors (in alphabetical order of last names): Alexey Boubnov, Rafaela Debastiani, Jonas Fell, Sarah Irvine, Reetu Elza Joseph.",
"properties": {
"consumables": {
"description": "(Optional) - Auxiliary entity used during Fabrication, Sample Preparation or Measurement which has a limited time capacity or is limited in its number of uses before it is disposed of, necessary to the process itself and normally bought from third party manufacturers. Examples are: gloves, syringes, wipes, etching solutions, glass slides, spatulas, weighing paper, two-sided tape.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"data": {
"$ref": "#/$defs/data",
"description": "(Required)- Details concerning the data section of the measurement."
},
"definition": {
"description": "(Required) - Name of the schema to which this entry conforms. In this case, lab_CT should be written.",
"type": "string"
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry usually provided by the project or the laboratory."
},
"equipment": {
"description": "(Optional) - Any kind of physical or virtual item, device, machine or other tools used to perform one or more Fabrication(s), Sample Preparation(s), Model Preparation(s), Data Acquisition(s) and/or any of the processes included in the Data Analysis Lifecycle. Usually, the Equipment is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. Equipment is usually an investment. According to this definition, an Instrument is a particular type of Equipment.",
"type": "string"
},
"experimentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the measurement usually provided by the project or the laboratory."
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings. Instrument is a physical or virtual identifiable piece of Equipment used to perform a Data Acquisition and to generate Raw Data. The Instrument is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. A virtual Instrument may be any computational resource or HPC infrastructure (cloud infrastructure or supercomputer) needed to perform Calculations or Simulations."
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure."
},
"measurementDescription": {
"description": "(Optional) - Description about the measurement.",
"type": "string"
},
"measurementPurpose": {
"description": "(Required) - Measurement is experimental Data Acquisition, typically performed on a Sample using an experimental Technique. It may also be performed during Fabrication or Sample Preparation, e.g., to characterise the intermediate stages and/or the final resulting Precursor(s) or Sample(s), respectively. A Measurement may require the use of Consumables.",
"enum": [
"assessment (to given categories or values)",
"completeness check (presence or absence of given properties)",
"correlative characterization (dedicated sample treatment to emphasise given features)",
"exploratory (routine check of known properties)",
"feasibility (quick check, rough estimate)",
"high quality measurement (precise, careful treatment)",
"test specific hypothesis (focus only on given aspects)",
"other (please specify in the comment)"
],
"type": "string"
},
"parents": {
"description": "(Required) - Parents of this metadata like the metadata document of the sample with which the measurement was performed.",
"items": {
"if": {
"properties": {
"parentType": {
"not": {
"const": "not applicable"
}
}
}
},
"properties": {
"parentReference": {
"description": "If type is 'MetaStore URI' it is possible to easily fill this field in a later stage",
"format": "uri-reference",
"type": "string"
},
"parentReferenceType": {
"default": "MetaStore URI",
"enum": [
"plain text",
"external URL",
"MetaStore URI"
],
"type": "string"
},
"parentType": {
"default": "sample",
"enum": [
"not applicable",
"sample"
],
"type": "string"
}
},
"required": [
"parentType"
],
"then": {
"required": [
"parentReferenceType",
"parentReference"
]
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition."
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format."
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"technique": {
"description": "(Required) - Any experimental, theoretical or computational method used during Data Acquisition or during any of the processes included in the Data Analysis Lifecycle to acquire, process or analyse Research Data about a System or a set of them with an Instrument, which is used to generate this metadata.",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement.",
"type": "string"
},
"user": {
"$ref": "#/$defs/user",
"description": "(Required)- The contact information of the user responsible for the measurement."
}
},
"required": [
"title",
"technique",
"definition",
"parents",
"measurementPurpose",
"startTime",
"endTime",
"program",
"user",
"instrument",
"data"
],
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | a6c14209fe71debfa246dbfba23a5c933fba6343 | 2024-01-12T12:31:45 | SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"angleDetails": {
"additionalProperties": false,
"description": "Describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (degree, radian).",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (pA, nA, \u00b5A, mA, A).",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the current.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m).",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi).",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"stage": {
"additionalProperties": false,
"description": "Describes the stage.",
"properties": {
"activeStage": {
"description": "(Required)- Describes the stage in use",
"type": "string"
},
"specTilt": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional)- Pretilt of the sample, usually due to pretilted holder."
},
"stageM": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional)- M coordinate of the position of the stage (additional translation axis available in Zeiss instruments)"
},
"stageR": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Angle by which the stage is rotated"
},
"stageTa": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Tilt angle alpha of the stage"
},
"stageTb": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Tilt angle beta of the stage"
},
"stageX": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- X coordinate of the position of the stage"
},
"stageY": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Y coordinate of the position of the stage"
},
"stageZ": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Z coordinate of the position of the stage"
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. IRI: https://purls.helmholtz-metadaten.de/EMG/00000026"
}
},
"required": [
"workingDistance",
"stageX",
"stageY",
"stageZ",
"stageR",
"stageTa",
"stageTb",
"activeStage"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF).",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"vacuum": {
"additionalProperties": false,
"description": "Describes the vacuum maintained in the system.",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- The pressure maintained in the electron chamber"
},
"gas": {
"description": "(Required)- The gas used in the electron chamber",
"type": "string"
},
"humidity": {
"description": "(Required)- Describes the humidity in the chamber during the measurement",
"type": "string"
},
"userMode": {
"description": "(Required)- The type of vacuum slected by the user",
"enum": [
"High vacuum",
"Medium vacuum",
"Low vacuum"
],
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes an individual image acquired during the course of a SEM/FIB Tomography experiment. Each image is taken using a detector (SE, BSE, EDS, EBSD) at each slice cut using FIB. This Schema contains only the parameters which are specific to the individual image. The parameters which are common to the entire set are described by another schema which describes the dataset as a whole and is located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json.",
"properties": {
"creationTime": {
"description": "(Required)- Time of creation of the image",
"format": "date-time",
"pattern": "(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z)",
"type": "string"
},
"definition": {
"description": "(Optional)- Name of the schema to which this entry conforms. In this case, acquisition_image should be written",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Identifier of the image produced by the machine"
},
"fileLink": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Link to the location of the image"
},
"fileName": {
"description": "(Optional)- File name of the image",
"type": "string"
},
"specimenCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional)- Current measured on the specimen during acquisition of the image"
},
"stage": {
"$ref": "#/$defs/stage",
"description": "(Required)- Details concerning stage settings used for aquisition"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional)- Temperature of the sample during acquisition"
},
"vacuum": {
"$ref": "#/$defs/vacuum",
"description": "(Required)- Details concerning the vacuum during aquisition"
}
},
"required": [
"creationTime",
"stage",
"vacuum"
],
"title": "acquisition_image",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | d6d1907ea5454bf69edcd0774e0c0727f05f2f27 | 2023-12-15T08:52:32 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"CTAquisition": {
"additionalProperties": false,
"description": "(Required) - Details about the acquisition.",
"properties": {
"acquisitionScriptName": {
"description": "(Required) - Name of the script used for acquisition.",
"type": "string"
},
"acquisitionTimePerProjection": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time taken for acquisition of a single projection. Typical unit - s."
},
"angularStepSize": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Step size of the rotation of the sample during the CT. Typical unit - degree."
},
"contrastType": {
"description": "(Required) - The contrast type(mode) used - Absorption Contrast or Phase Contrast. If 'Phase Contrast' is selected, please indicate the used Phase Contrast Mode under the field phaseContrastMode.",
"enum": [
"Absorption Contrast",
"Phase Contrast"
],
"type": "string"
},
"endAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - End angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then endAngle is 180\u00b0. Typical unit - degree."
},
"largeFOV": {
"description": "(Required) - To be set to true if large field of view or wide field of view is used.",
"type": "boolean"
},
"numberOfProjections": {
"description": "(Required) - Number of projections acquired during the CT.",
"type": "number"
},
"phaseContrastMode": {
"description": "(Optional) - The phase contrast mode used during acquisition - Zernike phase contrast, propagation-based, grating-based(Hartmann), grating-based(Talbot).",
"enum": [
"Zernike phase contrast",
"Propagation-based",
"Grating-based(Hartmann)",
"Grating-based(Talbot)"
],
"type": "string"
},
"referenceImages": {
"additionalProperties": false,
"description": "(Optional) - Details on the reference images (if used) - number of flats/bright images and number of dark images.",
"properties": {
"numberOfBrightImages": {
"description": "(Optional) - Number of flats or bright images used as reference.",
"type": "number"
},
"numberOfDarkImages": {
"description": "(Optional) - Number of dark images used as reference.",
"type": "number"
}
},
"type": "object"
},
"scanningMode": {
"description": "(Optional) - The scanning mode used during acquisition - helical, raster scanning, fast CT.",
"enum": [
"Helical",
"Raster Scanning",
"Fast CT"
],
"type": "string"
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Start angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then startAngle is -180\u00b0. Typical unit - degree."
},
"totalAcquisitionTime": {
"description": "(Required) - Time taken for acquisition for the entire scan. This is the total scan time, i.e. number of projections multipled by exposure time, but including read-out time. calculated as EndTime-StartTime. Format: hh:mm:ss.",
"format": "time",
"pattern": "^(\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?)$",
"type": "string"
},
"useBadPixelMap": {
"description": "(Optional) - To be set to true if bad pixel map is used. This parameter is relevant for SEM based CT.",
"type": "boolean"
}
},
"required": [
"acquisitionScriptName",
"startAngle",
"endAngle",
"angularStepSize",
"acquisitionTimePerProjection",
"totalAcquisitionTime",
"largeFOV",
"contrastType"
],
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "degree",
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"angleSet": {
"additionalProperties": false,
"description": "(Optional) - Tilt angles alpha, beta and gamma decribing the three angular positions of an item.",
"properties": {
"alpha": {
"description": "(Optional) - Tilt angle alpha of the item.",
"type": "number"
},
"anglesUnit": {
"default": "degree",
"description": "(Optional) - unit of the angles (allowed units - degree or radian)",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"beta": {
"description": "(Optional) - Rotation angle beta of the item.",
"type": "number"
},
"gamma": {
"description": "(Optional) - Angle gamma of the item.",
"type": "number"
}
},
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"default": "\u00b5m",
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "pA",
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string.",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"data": {
"additionalProperties": false,
"description": "(Required) - Details about the data section of the measurement.",
"properties": {
"projections": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"cropping": {
"additionalProperties": false,
"description": "(Optional) - Details about cropping or clipping to select a region of interest(ROI).",
"properties": {
"ROI": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The size of the region of interest (ROI) in integer values of xPixels and yPixels."
},
"offset": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The offset applied to the origin (i.e., centre of the image) to select the region of interest in x and y coordinates."
}
},
"required": [
"ROI",
"offset"
],
"type": "object"
},
"projectionImageDataStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the data structure of the image data of the projections.",
"properties": {
"IOValue": {
"description": "(Required) - The IO value obtained from the metadata.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The dimension of the image as for integer values of xPixels and yPixels."
},
"fileLocation": {
"description": "(Required) - The location where the data file is stored. A URL is preferred if available.",
"type": "string"
},
"greyValueRepresentation": {
"description": "(Optional) - Description about the grey value representation.",
"type": "string"
},
"header": {
"additionalProperties": false,
"description": "(Required) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Required) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"imageCorrection": {
"additionalProperties": false,
"description": "(Optional) - Details about the image correction.",
"properties": {
"isImageCorrected": {
"description": "(Required) - To be set as true if image is corrected.",
"type": "boolean"
},
"linkToReferenceImages": {
"description": "(Required) - Link to the reference images (flats/darks).",
"format": "uri-reference",
"type": "string"
}
},
"required": [
"isImageCorrected",
"linkToReferenceImages"
],
"type": "object"
},
"imageFormats": {
"additionalProperties": false,
"description": "(Required) - The file formats of the images - tiff, png, jpeg. When more than one file formats are there, then the formats are to be entered as an array of strings.",
"properties": {
"fileFormats": {
"oneOf": [
{
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
{
"items": {
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"fileFormats"
],
"type": "object"
},
"imageID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the Image Data."
},
"isPreFiltered": {
"description": "(Optional) - To be set as true if image is prefiltered.",
"type": "boolean"
},
"name": {
"description": "(Required) - Name of the Projection Image Data.",
"type": "string"
},
"numberOfImages": {
"description": "(Required) - Number of images in the data set. It is same as the number of projections.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical x,y length imaged by a single pixel, normally expressed in \u00b5m."
}
},
"required": [
"fileLocation",
"name",
"imageFormats",
"header"
],
"type": "object"
}
},
"required": [
"projectionImageDataStructure"
],
"type": "object"
},
"reconstructedData": {
"additionalProperties": false,
"description": "(Required) - Details about the reconstructed slices. When multiple reconstructions of the same raw data (projections) are present, the corresponding data can be combined as an array of reconstruction data sets, else as a single reconstruction data set.",
"properties": {
"reconstruction": {
"oneOf": [
{
"$ref": "#/$defs/reconstruction"
},
{
"items": {
"$ref": "#/$defs/reconstruction"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"reconstruction"
],
"type": "object"
}
},
"required": [
"projections",
"reconstructedData"
],
"type": "object"
},
"detector": {
"additionalProperties": false,
"description": "gives the settings of a detector or multiple detectors.",
"properties": {
"detectorSettings": {
"oneOf": [
{
"$ref": "#/$defs/detectorSettings"
},
{
"items": {
"$ref": "#/$defs/detectorSettings"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"detectorSettings"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "(Required) - Gives the settings of a single detector.",
"properties": {
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each pixel or voxel in an image. The bit depth determines the number of possible intensity levels that can be assigned to each pixel or voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"cameraGain": {
"description": "(Optional) - The amplification (gain) of the signal from an image sensor in a camera.",
"type": "number"
},
"detectorCoolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Cooling temperature of the detector, if it cooled. Relevant for SEM based CT. Typical unit - K."
},
"detectorDimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Optional) - The dimensions of the detector in integer values of xPixels and yPixels."
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector."
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the detector (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"detectorMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - The motor positions of the detector in cartesian coordinates and tilt angles."
},
"detectorName": {
"description": "(Optional) - Name of the detector of datatype string.",
"type": "string"
},
"detectorPixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical length in cartesian coordinates imaged by a single pixel of the detector. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"detectorType": {
"description": "(Optional) - The type of detector to be selected from a controlled list consisting of CCD, Panel, PCXD, CMOS, Time-Delay Integration (TDI) and Direct Conversion.",
"enum": [
"CCD",
"Panel",
"PCXD",
"CMOS",
"Time-Delay Integration (TDI)",
"Direct Conversion"
],
"type": "string"
},
"energyThreshold": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - A specific energy level used to filter the detected radiation."
},
"exposureTimePerFrame": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Time for which the sample is exposed per frame. Typical unit - s."
},
"frameSkip": {
"additionalProperties": false,
"description": "(Optional) - A numerical representation indicating the number of frames that are skipped or omitted during the acquisition or recording process. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3. If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped.",
"properties": {
"value": {
"oneOf": [
{
"description": "(Optional) - Number of frames skipped during acquisition. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3.",
"type": "number"
},
{
"description": "(Optional) - Pattern of frames skipped during acquisition. E.g. - If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped like [1,3,5]",
"items": {
"type": "number"
},
"minItems": 1,
"type": "array"
}
]
}
},
"type": "object"
},
"framesPerSecond": {
"description": "(Optional) - The number of frames captured in a second.",
"type": "number"
},
"imagePixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical length in cartesian coordinates imaged by a single pixel of the image. It is the native pixel size divided by the total magnification. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"lens": {
"additionalProperties": false,
"description": "(Optional) - Details of a lens, if used with the detector.",
"properties": {
"hasLens": {
"description": "(Required) - To be set to true if the detector has a lens.",
"type": "boolean"
},
"lensFocalLength": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Focal length of the lens."
},
"lensID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the lens."
},
"lensMagnification": {
"description": "(Optional) - Magnification of the lens as a floating point number.",
"type": "number"
},
"lensManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the lens (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"lensName": {
"description": "(Optional) - Name of the lens of datatype string.",
"type": "string"
}
},
"required": [
"lensMagnification",
"lensFocalLength"
],
"type": "object"
},
"numberOfAveragedFramesPerProjection": {
"description": "(Optional) - The number of averaged frames per projection, if averaging is done.",
"type": "number"
},
"sensor": {
"additionalProperties": false,
"description": "(Optional) - Details about a sensor, if present.",
"properties": {
"hasSensor": {
"description": "(Required) - To be set to true if the detector has a sensor.",
"type": "boolean"
},
"sensorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the sensor."
},
"sensorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the sensor (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"sensorMaterial": {
"description": "(Optional) - Material of the sensor of datatype string.",
"type": "string"
},
"sensorName": {
"description": "(Optional) - Name of the sensor of datatype string.",
"type": "string"
},
"sensorThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the sensor."
},
"sensorType": {
"description": "(Optional) - The type of sensor as a string.",
"type": "string"
}
},
"required": [
"hasSensor"
],
"type": "object"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Temperature of the detector."
},
"totalCountsPerProjection": {
"description": "(Optional) - The sum of the intensity values recorded by the X-ray detector for a single projection during a scan.",
"type": "number"
}
},
"required": [
"detectorType",
"detectorManufacturer",
"binning",
"detectorMotorPositions",
"imagePixelSize"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ; default value - keV) of datatype string",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"entry": {
"additionalProperties": false,
"description": "Required) - The entry level is the root element of the schema. It contains all the metadata describing a CT measurement.",
"properties": {
"consumables": {
"description": "(Optional) - Auxiliary entity used during Fabrication, Sample Preparation or Measurement which has a limited time capacity or is limited in its number of uses before it is disposed of, necessary to the process itself and normally bought from third party manufacturers. Examples are: gloves, syringes, wipes, etching solutions, glass slides, spatulas, weighing paper, two-sided tape.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"data": {
"$ref": "#/$defs/data",
"description": "(Optional)- Details concerning the data section of the measurement."
},
"definition": {
"description": "(Required) - Name of the schema to which this entry conforms. In this case, lab_CT should be written.",
"type": "string"
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry usually provided by the project or the laboratory."
},
"equipment": {
"description": "(Optional) - Any kind of physical or virtual item, device, machine or other tools used to perform one or more Fabrication(s), Sample Preparation(s), Model Preparation(s), Data Acquisition(s) and/or any of the processes included in the Data Analysis Lifecycle. Usually, the Equipment is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. Equipment is usually an investment. According to this definition, an Instrument is a particular type of Equipment.",
"type": "string"
},
"experimentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the measurement usually provided by the project or the laboratory."
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings. Instrument is a physical or virtual identifiable piece of Equipment used to perform a Data Acquisition and to generate Raw Data. The Instrument is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. A virtual Instrument may be any computational resource or HPC infrastructure (cloud infrastructure or supercomputer) needed to perform Calculations or Simulations."
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure."
},
"measurementDescription": {
"description": "(Optional) - Description about the measurement.",
"type": "string"
},
"measurementPurpose": {
"description": "(Required) - Measurement is experimental Data Acquisition, typically performed on a Sample using an experimental Technique. It may also be performed during Fabrication or Sample Preparation, e.g., to characterise the intermediate stages and/or the final resulting Precursor(s) or Sample(s), respectively. A Measurement may require the use of Consumables.",
"enum": [
"assessment (to given categories or values)",
"completeness check (presence or absence of given properties)",
"correlative characterization (dedicated sample treatment to emphasise given features)",
"exploratory (routine check of known properties)",
"feasibility (quick check, rough estimate)",
"high quality measurement (precise, careful treatment)",
"test specific hypothesis (focus only on given aspects)",
"other (please specify in the comment)"
],
"type": "string"
},
"parents": {
"description": "(Required) - Parents of this metadata like the metadata document of the sample with which the measurement was performed.",
"items": {
"if": {
"properties": {
"parentType": {
"not": {
"const": "not applicable"
}
}
}
},
"properties": {
"parentReference": {
"description": "If type is 'MetaStore URI' it is possible to easily fill this field in a later stage",
"format": "uri-reference",
"type": "string"
},
"parentReferenceType": {
"default": "MetaStore URI",
"enum": [
"plain text",
"external URL",
"MetaStore URI"
],
"type": "string"
},
"parentType": {
"default": "sample",
"enum": [
"not applicable",
"sample"
],
"type": "string"
}
},
"required": [
"parentType"
],
"then": {
"required": [
"parentReferenceType",
"parentReference"
]
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition."
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format."
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"technique": {
"description": "(Required) - Any experimental, theoretical or computational method used during Data Acquisition or during any of the processes included in the Data Analysis Lifecycle to acquire, process or analyse Research Data about a System or a set of them with an Instrument, whihc is used to generate this metadata.",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement.",
"type": "string"
},
"user": {
"$ref": "#/$defs/user",
"description": "(Required)- The contact information of the user responsible for the measurement."
}
},
"required": [
"title",
"technique",
"definition",
"parents",
"measurementPurpose",
"startTime",
"endTime",
"program",
"user",
"instrument",
"data"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min) default value - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"geometry": {
"additionalProperties": false,
"description": "Describes the geometry of the CT instrument",
"properties": {
"beamGeometry": {
"additionalProperties": false,
"description": "(Required) - Details about beam geometry like beam geometry type and divergence angle.",
"properties": {
"beamGeometryType": {
"description": "(Required) - The type of the beam geometry to be selected between 'collimated' and 'divergent'.",
"enum": [
"collimated",
"divergent"
],
"type": "string"
},
"divergenceAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Angle of divergence when the beam geometry is divergent. Typical unit - degree."
}
},
"type": "object"
},
"geometricMagnification": {
"description": "(Required) - Geometric magnification refers to the ratio of the size of an object's image to the size of the object itself. It is a measure of how much larger the image appears compared to the actual object. Geometric magnification (M) is calculated using the formula M = (SID + SOD) / SID, where SID is the source-to-image distance and SOD is the source-to-object distance.",
"type": "number"
},
"objectToDetectorDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the object and the detector. Typical unit - \u00b5m."
},
"opticalMagnification": {
"description": "(Required) - Optical magnification is calculated as the ratio of the focal length of the objective lens to the focal length of the eyepiece (if an eyepiece is present) in a traditional optical microscope.",
"type": "number"
},
"sourceToObjectDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the source and the object. Typical unit - \u00b5m."
}
},
"required": [
"sourceToObjectDistance",
"objectToDetectorDistance",
"beamGeometry",
"geometricMagnification",
"opticalMagnification"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"CTAquisition": {
"$ref": "#/$defs/CTAquisition",
"description": "(Optional) - Details regarding the acquisition."
},
"calibration": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the calibration and the scaling factor.",
"properties": {
"calibrationType": {
"description": "(Optional) - Type of calibration as a string.",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (YYYY-MM-DDThh:mm:ss.sss) in the ISO 8601 date-time format",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"systemScaling": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scaling factor.",
"properties": {
"adjustSystemScaling": {
"description": "(Required) - To be set to true if system scaling is adjusted, else false.",
"type": "boolean"
},
"measuredScalingFactor": {
"description": "(Optional) - Value of the measured scaling factor.",
"type": "number"
},
"referenceScalingFactor": {
"description": "(Optional) - Value of the reference scaling factor, determined ususally during the data processing.",
"type": "number"
}
},
"required": [
"adjustSystemScaling"
],
"type": "object"
}
},
"type": "object"
},
"detector": {
"$ref": "#/$defs/detector",
"description": "(Optional) - Details regarding the detector."
},
"focalSpotMode": {
"additionalProperties": false,
"description": "(Optional) - Option for setting the size of the focal spot. Some sources have the option to select the target spot size, or focal spot size absolutely by setting a value, while some others give the option of selecting 'small', 'medium' or 'large'. Smaller spot size = higher resolution. Note that the power/current will change with this value. In addition, the detector settings will usually be selected in conjunction. (different scintillator/lens/magnification).",
"properties": {
"selection": {
"description": "(Optional) - Selection of the setting of the size of the focal spot when the option for setting the size of the focal spot by selecting 'small', 'medium' or 'large' according to predefined values set by the manufacturer.",
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the target spot when the option for setting the size of the focal spot absolutely by setting a value is available."
}
},
"type": "object"
},
"geometry": {
"$ref": "#/$defs/geometry",
"description": "(Optional) - Details regarding the geometry."
},
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"optics": {
"$ref": "#/$defs/optics",
"description": "(Optional) - Details about the optics and individual motor positions."
},
"sampleStage": {
"$ref": "#/$defs/sampleStage",
"description": "(Optional) - Details regarding the sample stage."
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray target in an SEM based CT set-up.",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required) - Details of the pressure maintained in the chamber of the SEM."
},
"electronBeamShift": {
"additionalProperties": false,
"description": "(Required) - The distance by which the electron beam is shifted in the x and y directions.",
"properties": {
"xShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the x direction. Typical unit - \u00b5m."
},
"yShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xShift",
"yShift"
],
"type": "object"
},
"electronProbeCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required) - The electron current measured at the probe. Typical unit - \u00b5A."
},
"objectiveLensAperture": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). Typically the diameter of the aperture is set in \u00b5m."
},
"target": {
"additionalProperties": false,
"description": "(Required) - Details regarding the target in SEM based CT, which upon interaction with the e-beam produces the X-rays.",
"properties": {
"targetDriftCorrection": {
"description": "(Required) - If drift correction is activated for the target, this parameter has to be set to true.",
"type": "boolean"
},
"targetMaterial": {
"description": "(Required) - Material with which the target is made.",
"type": "string"
},
"targetShape": {
"description": "(Optional) - Description of the shape or geometry of the target. e.g. - bulk, foil, needle.",
"type": "string"
},
"targetThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Thickness of the target (dimension in Z direction). Default unit - \u00b5m."
},
"targetTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the target is tilted. Typical unit - degree."
}
},
"required": [
"targetMaterial",
"targetThickness",
"targetDriftCorrection",
"targetTiltAngle",
"targetCurrent"
],
"type": "object"
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. In SEM based CT, the beam is focussed on the target material which emits the X-rays upon interaction with the electrons. Default unit - \u00b5m."
}
},
"required": [
"chamberPressure",
"electronBeamShift",
"workingDistance",
"objectiveLensAperture",
"electronProbeCurrent",
"target"
],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
},
"targetCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current measured at the X-ray target, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"sourceDrift": {
"additionalProperties": false,
"description": "(Optional) - Distance by which the source is shifted during the measurement (i.e., end position - start position).",
"properties": {
"xDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the x direction. Typical unit - \u00b5m."
},
"yDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xDrift",
"yDrift"
],
"type": "object"
},
"sourcePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the source."
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray enrgy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source",
"focalSpotMode",
"CTAquisition",
"geometry",
"sampleStage",
"detector"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer.",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"bioReactor": {
"additionalProperties": false,
"description": "(Optional) - Details of an in situ bioreactor.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in sterile conditions.",
"type": "boolean"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is decreased. Typical unit - K/min."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is increased, typically in K/min."
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"anvil": {
"description": "(Optional) - The type of anvil used in the in situ load frame (stage) for applying a particular type of force on the sample. Option to be selected from a controlled list consisting of - Compression, Diamond indentation 90\u00b0 cone, Diamond indentation cube corner, Diamond indentation wedge, Tension, Other. If 'Other' is selected, specify the name of the anvil with a description in the field 'otherAnvil'.",
"enum": [
"Compression",
"Diamond indentation 90\u00b0 cone",
"Diamond indentation cube corner",
"Diamond indentation wedge",
"Tension",
"Other"
],
"type": "string"
},
"blindAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - ed by the load frame(stage). Example: for a CT normally scanned over 180\u00b0 (e.g. -90\u00b0/+90\u00b0), a blind angle of 40\u00b0 due to the in situ cell implies that only 180\u00b0-40\u00b0=140\u00b0 (e.g. -70\u00b0/70\u00b0) is visible. NOTE: for a CT normally scanned over 360\u00b0 (e.g. -180\u00b0/+180\u00b0), a blind angle of 40\u00b0 would require the subtraction of the blind angle twice, implying two scan ranges of 140\u00b0 each (e.g. -160\u00b0/-20\u00b0 and +20\u00b0/+160\u00b0). Typical unit - degree."
},
"displacement": {
"additionalProperties": false,
"description": "(Optional) - Specification on how displacement is applied on the sample. Either 'displacementRate' in \u00b5m/min or 'displacementIncrement' in \u00b5m/acquisition need to be selected.",
"properties": {
"displacementIncrement": {
"description": "(Optional) - The step at which displacement is changed per acquisition in \u00b5m/acquisition.",
"type": "number"
},
"displacementRate": {
"description": "(Optional) - The rate at which displacement is applied on the sample in \u00b5m/min.",
"type": "number"
}
},
"type": "object"
},
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame or anvil (e.g. - size of anvil) relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
},
"maximumDisplacement": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - The maximum displacement allowed in the selected configuration. Typical unit - \u00b5m."
},
"maximumForce": {
"description": "(Optional) - The maximum force that can be applied to the sample in N.",
"type": "number"
},
"otherAnvil": {
"description": "(Optional) - If 'anvil' was selected as 'Other' from the controlled list as it was not listed, please specify the name of the anvil with a description in this field.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the vacuum chamber relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the vacuum chamber relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the vacuum chamber."
},
"chamberName": {
"description": "(Optional) - Name of the vacuum chamber.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"motorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchical level and direction of a motor.",
"properties": {
"motorDirection": {
"description": "(Required) - The direction of movement (for X,Y,Z,M motors) or axis of rotation (for rotating motors) expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the X-stage and perpendicular to the Y-stage. then beam direction = [1 0 0], X-stage-direction = [1 0 0] (positive movement direction away from source towards detector) or can be (-1 0 0) (towards source) and Y-stage-direction = [0 1 0] or can be [0 -1 0] (analogous interpretation). The parameters need to be individually determined for each instrument. For rotating motors, the directional vector of axis of rotation should be given in Cartesian coordinates (counterclockwise, right-hand rule).",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"motorLevel": {
"description": "(Required) - Hierarchy of the motor expressed as an integer.",
"type": "number"
}
},
"type": "object"
},
"motorPositions": {
"additionalProperties": false,
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the motor.",
"properties": {
"angles": {
"$ref": "#/$defs/angleSet",
"description": "(Optional) - The three tilt angles alpha, beta and gamma of the motors controlling the position of the item."
},
"xyzPositions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - The xyz coordinates describing the motor positions of the item."
}
},
"type": "object"
},
"optics": {
"additionalProperties": false,
"description": "(Optional) - Details about the optics and individual motor positions.",
"properties": {
"collimator": {
"additionalProperties": false,
"description": "(Optional) - Details about the collimator and its individual motor positions.",
"properties": {
"collimatorDetails": {
"description": "(Optional) - Details about the collimator relevant for the measurement.",
"type": "string"
},
"collimatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the collimator."
}
},
"type": "object"
},
"condenser": {
"additionalProperties": false,
"description": "(Optional) - Details about the condenser lens and its individual motor positions, if used.",
"properties": {
"condenserDetails": {
"description": "(Optional) - Details about the condenser relevant for the measurement.",
"type": "string"
},
"condenserPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the condenser."
}
},
"type": "object"
},
"fresnelZonePlate": {
"additionalProperties": false,
"description": "(Optional) - Details about the fresnel zone plate and its individual motor positions, if used.",
"properties": {
"fresnelZonePlateDetails": {
"description": "(Optional) - Details about the fresnel zone plate relevant for the measurement.",
"type": "string"
},
"fresnelZonePlatePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the fresnel zone plate."
}
},
"type": "object"
},
"monochromator": {
"additionalProperties": false,
"description": "(Required) - Details about the monochromator and individual motor positions, if used.",
"properties": {
"monochromatorDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the monochromator type type, material, energy and notes.",
"properties": {
"energy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Energy set in the monochromator. Typical unit - eV"
},
"material": {
"description": "(Optional) - Material of the monochromator.",
"type": "string"
},
"monochromatorType": {
"description": "(Optional) - Type of the monochromator.",
"type": "string"
},
"notes": {
"description": "(Optional) - Additional information about the monochromator relevant for the measurement."
}
},
"type": "object"
},
"monochromatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the monochromator."
},
"monochromatorUsed": {
"description": "(Required) - To be set to true if monochromator is used, else false.",
"type": "boolean"
}
},
"required": [
"monochromatorUsed"
],
"type": "object"
},
"phaseRing": {
"additionalProperties": false,
"description": "(Required) - Details about the phase ring and its individual motor positions, if inserted.",
"properties": {
"phaseRingDetails": {
"description": "(Optional) - Details about the phase ring relevant for the measurement.",
"type": "string"
},
"phaseRingPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the phase ring."
}
},
"type": "object"
}
},
"required": [
"monochromator"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes a parameter which can be split into number of pixels in x and y directions like the resolution",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm or \u00b5m, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "nm",
"description": "(Required) - the unit of the size of a single pixel (typical value - nm, \u00b5m) of datatype string",
"enum": [
"nm",
"\u00b5m"
],
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min, default value - max) of datatype string.",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"default": "W",
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW, default value - W) of datatype string.",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "Pa",
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"rampDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a rate at which temperature is increased or decreased.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K/min",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K/min, K/s)",
"enum": [
"K/min",
"K/s"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of temperature increase or decrease.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"reconstruction": {
"additionalProperties": false,
"description": "Data from one single reconstruction.",
"properties": {
"reconstructionDetails": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"additionalFilters": {
"beamHardeningCorrection": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"filterType": {
"description": "(Optional) - Type of the additional filter - Median or Gauss",
"enum": [
"Median",
"Gauss"
],
"type": "string"
},
"phaseRetrieval": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"ringFilter": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
}
},
"algorithm": {
"description": "(Required) - Algorithm used for reconstruction to be selected from FBP - Filtered Back Projection, ART - Algebraic Reconstruction Technique, 3dCT - 3D Computed Tomography and Gridrec.",
"enum": [
"FBP - Filtered Back Projection",
"ART - Algebraic Reconstruction Technique",
"3dCT - 3D Computed Tomography",
"Gridrec"
],
"type": "string"
},
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepthConversionMax": {
"description": "(Required) - Maximum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"bitDepthConversionMin": {
"description": "(Required) - Minimum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"hardwarePlatform": {
"description": "(Optional) - Hardware platform used for reconstruction to be selected between CPU and GPU.",
"enum": [
"CPU",
"GPU"
],
"type": "string"
},
"lastImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the last image for the reconstruction of the 3D Volume, typically an integer.",
"type": "string"
},
"projectionPadding": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the projection padding applied to the raw projection data to address certain issues in the reconstruction process.",
"properties": {
"paddingSize": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - Size of the projection padding used in pixels."
},
"paddingType": {
"description": "(Required) - Type of the projection padding used - Zero Padding, Linear Interpolation Padding, Sinc Interpolation Padding, Shepp-Logan Filtered Back Projection (SL-FBP), Gridding and Extended Field of View (FOV) Padding.",
"enum": [
"Zero Padding",
"Linear Interpolation Padding",
"Sinc Interpolation Padding",
"Shepp-Logan Filtered Back Projection (SL-FBP)",
"Gridding",
"Extended Field of View (FOV) Padding"
],
"type": "string"
}
},
"type": "object"
},
"reconstructionSoftware": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for reconstruction. It may be the same as the acquisition software or a different one."
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Scan angle at which the reconstruction of the 3D Volume starts. Typical unit - degree."
},
"startImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the start image for the reconstruction of the 3D Volume.",
"type": "string"
},
"tomographicProjectionFilter": {
"description": "(Optional) - Name of the tomographic projection filter used to be selected from Ram-Lak Filter, Butterworth Filter, Shepp-Logan Filter, Hann (Hanning) Filter, Gaussian Filter, Cosine Filter, Soft Filtration Method and Hard Filtration Method.",
"enum": [
"Ram-Lak Filter",
"Butterworth Filter",
"Shepp-Logan Filter",
"Hann (Hanning) Filter",
"Gaussian Filter",
"Cosine Filter",
"Soft Filtration Method",
"Hard Filtration Method"
],
"type": "string"
}
},
"required": [
"startImage",
"lastImage",
"startAngle",
"hardwarePlatform",
"algorithm",
"binning"
],
"type": "object"
},
"volumeStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each voxel in the 3D volume. The bit depth determines the number of possible intensity levels that can be assigned to each voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Required) - The dimension of the 3D volume in XYZ coordinates. If the length in Z dimension is not known and instead only the number of slices are known, they need to be separately entered in the field 'numberOfSlices'. Typical unit - \u00b5m."
},
"header": {
"additionalProperties": false,
"description": "(Optional) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Optional) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"name": {
"description": "(Required) - Name of the 3D volume structure (dataset).",
"type": "string"
},
"numberOfSlices": {
"description": "(Optional) - No. of slices which make up the 3D volume.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel/voxel, normally expressed in \u00b5m."
},
"volumeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry of the 3D reconstructed volume usually provided by the project or the laboratory."
}
},
"required": [
"name",
"dimensions",
"bitDepth",
"pixelSize"
],
"type": "object"
}
},
"required": [
"volumeStructure",
"reconstructionDetails"
],
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"sampleStage": {
"additionalProperties": false,
"description": "(Required) - Details about sample stage.",
"properties": {
"stageMotorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchy of the stage motors. This information is required to know how the motor movements affect the positions of the samples, particularly relevant for correlative characterization.",
"properties": {
"beamDirection": {
"description": "(Required) - The beam direction expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the Y-stage and perpendicular to the X-stage. then beam direction = [0 1 0].",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"mMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the M motor (stage) as a vector in cartesian coordiantes. The M motor is usually relevant only for SEM based CT. It is a special motor which counteracts the Z motor."
},
"rMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the R motor (stage) as a vector in cartesian coordiantes. R motor has rotation around z axis +1 (for anticlockwise)."
},
"tMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the T motor (stage) as a vector in cartesian coordiantes. The T motor is usually relevant only for SEM based CT."
},
"xMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the X motor (stage) as a vector in cartesian coordinates."
},
"yMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Y motor (stage) as a vector in cartesian coordinates."
},
"zMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Z motor (stage) as a vector in cartesian coordinates."
}
},
"required": [
"beamDirection",
"xMotor",
"yMotor",
"zMotor",
"rMotor"
],
"type": "object"
},
"stageMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the stage motors."
}
},
"required": [
"stageMotorHierarchy"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5s",
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s default value - \u00b5s) of datatype string",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"user": {
"description": "Basic schema for user description. It can be extended.",
"properties": {
"ORCID": {
"description": "(Optional) - Open Researcher and Contributor ID expressed as a URI",
"pattern": "^https://orcid\\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[X0-9]{1}$",
"type": "string"
},
"affiliation": {
"description": "(Optional) - Details of the institution to which the user is affiliated",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"description": "(Optional) -Identifier of the institution to which the user is affiliated",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be chosen from a controlled list of values (*ROR *GRID *ISNI *URL *DOI *Handle)",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"email": {
"description": "(Optional) - Email of the user",
"format": "email",
"type": "string"
},
"familyName": {
"description": "(Optional) - Family name of the user",
"type": "string"
},
"givenName": {
"description": "(Optional) - Given name of the user",
"type": "string"
},
"role": {
"description": "(Required) - Role of the research user",
"enum": [
"Data Curator",
"Instrument Scientist",
"Team Leader",
"Team Member"
],
"type": "string"
},
"userName": {
"description": "(Required) - Full name of the user in the format (Family Name, Given Name)",
"type": "string"
}
},
"required": [
"userName",
"role"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "kV",
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV default value - V) of datatype string.",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided. Contributors (in alphabetical order of last names): Alexey Boubnov, Rafaela Debastiani, Jonas Fell, Sarah Irvine, Reetu Elza Joseph.",
"properties": {
"entry": {
"$ref": "#/$defs/entry"
}
},
"required": [
"entry"
],
"title": "lab_CT",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 6399a829d6b478b27d31e729b1dcaadf617a64a9 | 2023-12-05T16:22:29 | SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "degree",
"description": "(Unit) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "pA",
"description": "(Optional) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string",
"enum": [
"pA",
"nA",
"uA",
"mA",
"A"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Optional) - Further notes about the value of datatype string",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"detectorDetails": {
"additionalProperties": false,
"description": "(Required) - describes the settings related to the detector with which the image set is acquired",
"properties": {
"detectorSettings": {
"$ref": "#/$defs/detectorSettings",
"description": "(Required) - Settings of the specific detector used. E.g., the Everhart Thornley detector (ETD), is a secondary electron and back-scattered electron detector used in scanning electron microscopes, whihc has then particular settings"
},
"detectorType": {
"description": "(Required) - Type of the detector used",
"enum": [
"ETD",
"CDEM",
"CBS",
"ECD",
"External",
"GBSD",
"GSED",
"ICE",
"LFD",
"LVD",
"LVSED",
"None",
"STEM3",
"STEM3_GMode",
"STEM4",
"T1",
"T2",
"T3",
"TLD"
],
"type": "string"
},
"name": {
"description": "(Optional) - Name of the detector used",
"type": "string"
}
},
"required": [
"detectorType"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "describes the parameters of a detector such as the Everhart Thornley detector (ETD), which is a secondary electron and back-scattered electron detector used in scanning electron microscopes",
"properties": {
"brightness": {
"description": "(Optional) - A number indicating the brightness",
"type": "number"
},
"brightnessdB": {
"description": "(Optional) - Describes the brightness in dB",
"type": "number"
},
"contrast": {
"description": "(Optional) - A number indicating the contrast",
"type": "number"
},
"contrastdB": {
"description": "(Optional) - Describes the contrast in dB",
"type": "number"
},
"enhancedContrast": {
"description": "(Optional) - Describes the enhancement in contrast",
"type": "number"
},
"frontEndVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Bias voltage applied to the front end of the detector "
},
"grid": {
"description": "(Optional) - A number indicating the number of grid elements",
"type": "number"
},
"gridVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage applied to the grid "
},
"minimumDwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Minimum possible dwell time for the detector. IRI: https://purls.helmholtz-metadaten.de/EMG/00000006 "
},
"mix": {
"description": "(Optional) - Signals from different detectors can be overlaid (mixed) and this should, in theory, be the percentage of this detectors contribution to the end result.",
"type": "number"
},
"setting": {
"description": "(Optional) - In case of ETD, this is the bias voltage applied to the detector grid. Note that this block looks different for different detectors. ",
"type": "number"
},
"signal": {
"description": "(Optional) - The signal used for detection",
"enum": [
"SE",
"BSE",
"SI"
],
"type": "string"
}
},
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"eBeamDetails": {
"additionalProperties": false,
"description": "(Required) - Describes the configuration of the electron beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000007",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The potential difference between anode and cathode. The acceleration voltage adds kinetic energy to the particles of the beam. IRI: https://purls.helmholtz-metadaten.de/EMG/00000001 It is defined separately as voltageDetails, (includes the voltage value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - uV, mv, V, kV, MV)"
},
"apertureSetting": {
"additionalProperties": false,
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size (diameter) of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails."
}
},
"type": "object"
},
"beamCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Electrical current which flows along the beam path. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003 It is defined separately as currentDetails (includes the current value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)."
},
"dynamicFocusIsOn": {
"description": "(Optional) - To bet set true if dynamic focus is on. IRI:https://purls.helmholtz-metadaten.de/emg/00000039",
"type": "boolean"
},
"dynamicWDIsOn": {
"description": "(Optional) - To bet set true if dynamic working distance is on. IRI: https://purls.helmholtz-metadaten.de/EMG/00000026",
"type": "boolean"
},
"horizontalFieldWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual horizontal length scanned on the sample defined separately as distanceDetails."
},
"imageMode": {
"description": "(Optional) - The type of image mode used. Could be a text or number depending on the instrument.",
"type": "string"
},
"lensMode": {
"description": "(Optional) - The type of image mode used",
"enum": [
"Field-Free",
"Immersion",
"EDS"
],
"type": "string"
},
"magnificationCorrection": {
"description": "(Optional) - To bet set true if magnification correction is on",
"type": "boolean"
},
"preTilt ": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Sometimes, pre-tilted holders are used and the pretilt angle must be given in the acquisition software because actual tilt = stage tilt plus pretilt."
},
"scanRotation": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Angle by which beam scanning direction is rotated"
},
"tiltCorrectionAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - If the sample is tilted, the image is compressed in the vertical direction, i.e. the pixels are not isotropic anymore. Tilt correction adapts the line spacing of the scanning to compensate for this. IRI:https://purls.helmholtz-metadaten.de/emg/00000037"
},
"tiltCorrectionIsOn": {
"description": "(Optional) - To bet set true if tilt correction is on. IRI:https://purls.helmholtz-metadaten.de/emg/00000037",
"type": "boolean"
},
"verticalFieldWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual vertical length scanned on the sample defined separately as distanceDetails."
}
},
"required": [
"accelerationVoltage",
"verticalFieldWidth",
"horizontalFieldWidth",
"apertureSetting",
"scanRotation"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "J",
"description": "(Optional) - the unit of the value to be selected from a controlled list (nJ, mJ, J, kJ, eV, meV default value - J) of datatype string",
"enum": [
"nJ",
"mJ",
"J",
"kJ",
"eV",
"meV"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"hotStageMEMSDetails": {
"additionalProperties": false,
"description": "describes the parameters related if a hot stage MEMS is used",
"properties": {
"actualTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Describes the actual Temperature measured in the hot stage MEMS"
},
"heatingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Describes the heating current used in the hot stage MEMS"
},
"heatingPower": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Describes the heating power used in the hot stage MEMS"
},
"heatingVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Describes the heating voltage used in the hot stage MEMS"
},
"sampleBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Describes the bias voltage applied to the sample in the hot stage MEMS"
},
"sampleResistance": {
"$ref": "#/$defs/resistanceDetails",
"description": "(Optional) - Describes the target Temperature used in the hot stage MEMS"
},
"targetTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Describes the target Temperature set in the hot stage MEMS"
}
},
"type": "object"
},
"iBeamDetails": {
"additionalProperties": false,
"description": "(Required) - Describes the configuration of the ion beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000016",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The potential difference between anode and cathode. The acceleration voltage adds kinetic energy to the particles of the beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000001 It is defined separately as voltageDetails, (includes the voltage value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - uV, mv, V, kV, MV)"
},
"millingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Electrical current used in SEM-FIB Tomography to mill/cut the sample. In this case this is the same as the beam current of the ion beam. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003 It is defined separately as currentDetails (includes the current value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)."
}
},
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"imageDetails": {
"additionalProperties": false,
"description": "(Required) - describes the settings related to imaging",
"properties": {
"digitalBrightness": {
"description": "(Required) - A number indicating the setting for digital brightness (a basic post-processing method)",
"type": "number"
},
"digitalContrast": {
"description": "(Required) - A number indicating the setting for digital contrast (a basic post-processing method)",
"type": "number"
},
"digitalGamma": {
"description": "(Required) - A number indicating the setting for digital Gamma (a basic post-processing method)",
"type": "number"
},
"driftcorrected": {
"description": "(Required) - To bet set true if drift correction is on",
"type": "boolean"
},
"numberOfPixels": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The number of x, y pixels of the image (Resolution), defined separately as pixelNumberType with separate entries for integer values of xPixels and yPixels"
},
"postprocessing": {
"description": "(Optional) - Describes the post-processing performed on the image",
"type": "string"
},
"transformation": {
"description": "(Optional) - Describes the transformations performed on the image",
"type": "string"
},
"zoomfactor": {
"description": "(Required) - A number indicating the zoom factor",
"type": "number"
}
},
"required": [
"digitalContrast",
"digitalBrightness",
"digitalGamma",
"numberOfPixels",
"driftcorrected",
"zoomfactor"
],
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"beamType": {
"description": "(Required) - The selected beam",
"enum": [
"EBeam",
"IBeam"
],
"type": "string"
},
"detector": {
"oneOf": [
{
"$ref": "#/$defs/detectorDetails",
"description": "(Required) - Details about the detector used for acquisition."
},
{
"description": "(Required) - Details about the detector(s) used for acquisition.",
"items": {
"$ref": "#/$defs/detectorDetails"
},
"minItems": 1,
"type": "array"
}
]
},
"eBeam": {
"$ref": "#/$defs/eBeamDetails",
"description": "(Required) - Details about the electron beam"
},
"hotStageMEMS": {
"$ref": "#/$defs/hotStageMEMSDetails",
"description": "(Optional) - Pressure maintained inside the chamber (in which the sample is housed) during the measurement"
},
"iBeam": {
"$ref": "#/$defs/iBeamDetails",
"description": "(Required) - Details about the ion beam"
},
"imaging": {
"$ref": "#/$defs/imageDetails",
"description": "(Optional) - Details about the imaging settings"
},
"numberOfDetectors": {
"description": "Number of detectors used for the acquisition",
"type": "number"
},
"scan": {
"$ref": "#/$defs/scanDetails",
"description": "(Required) - Details about the scan settings"
},
"spot": {
"description": "(Optional) - Qualitative index for beam current. Varies with current setting, i.e. 1.6 nA is spot = 1, 3.2 nA is spot = 2, 0.1 nA = spot =-3, so it can also be negative. May vary between different microscope models.",
"type": "number"
}
},
"required": [
"eBeam",
"scan",
"imaging",
"detector"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes the resolution of the image split into number of pixels in x and y directions.",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "describes a power",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "W",
"description": "(Optional) - the unit of the value to be selected from a controlled list (\u00b5W, mW, W, kW, MW default value - W) of datatype string",
"enum": [
"\u00b5W",
"mW",
"W",
"kW",
"MW"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The power expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "Pa",
"description": "(Optional) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"resistanceDetails": {
"additionalProperties": false,
"description": "describes a resistance",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "ohm",
"description": "(Optional) - the unit of the value to be selected from a controlled list (abohm, ohm, k ohm, M ohm default value - ohm) of datatype string; default unit is ohm",
"enum": [
"abohm",
"ohm",
"k ohm",
"M ohm"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The resistance expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"scanDetails": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scan settings.",
"properties": {
"average": {
"description": "(Optional) - Number of images averaged at each slice",
"type": "number"
},
"dwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time period during which the beam remains on one position/stationary. IRI: https://purls.helmholtz-metadaten.de/EMG/00000006 "
},
"eScan": {
"additionalProperties": false,
"description": "gives settings pertaining to electron beam scan",
"properties": {
"lineAveraging": {
"description": "(Optional) - Number of lines averaged",
"type": "number"
},
"lineIntegration": {
"description": "(Optional) - Number of lines integrated",
"type": "number"
},
"lineTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) -Time period during which a line is fully scanned."
},
"mainsLock": {
"description": "(Optional) - To bet set true if mains lock is on",
"type": "boolean"
},
"scanInterlacing": {
"description": "(Optional) - Number of scans interlaced. This setting splits an imaging area into blocks defined by the number of lines (from 2 to 8). In the first instance, the first line of each block is scanned, then the second one, etc. This imaging method significantly reduces charging.",
"type": "number"
}
},
"type": "object"
},
"frameTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) -Time period during which a frame is fully scanned. IRI: https://purls.helmholtz-metadaten.de/EMG/00000014 "
},
"horizontalFieldSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the actual horizontal length scanned on the sample defined separately as distanceDetails"
},
"integrate": {
"description": "(Optional) - Number of images integrated at each slice",
"type": "number"
},
"internalScan": {
"description": "(Optional) - To bet set true if internal scan is on",
"type": "boolean"
},
"pixelHeight": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual width of a pixel"
},
"pixelWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual width of a pixel"
},
"scanType": {
"description": "(Optional) - The type of scan E-Scan or I-Scan",
"enum": [
"EScan",
"IScan"
],
"type": "string"
},
"verticalFieldSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the actual vertical length scanned on the sample defined separately as distanceDetails"
}
},
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time period. IRI:https://purls.helmholtz-metadaten.de/EMG/00000024",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "us",
"description": "(Optional) - the unit of the value to be selected from a controlled list (ps, ns, us, ms, s default value - us) of datatype string",
"enum": [
"ps",
"ns",
"us",
"ms",
"s"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "kV",
"description": "(Optional) - the unit of the value to be selected from a controlled list (uV, mV, V, kV, MV, GV default value - V) of datatype string",
"enum": [
"uV",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The voltage expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes a set of images acquired during the course of a SEM/FIB Tomography experiment. The images in each dataset is taken using a detector (SE, BSE, EDS, EBSD) using a specific configuration. This Schema contains only the parameters which are specific to the entire dataset. The parameters which are particular to each image is located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json. The units are by default to be considred as the SI units unless otherwise specified",
"properties": {
"columns": {
"description": "(Optional) - Number of column in the tiled image grab setting",
"type": "number"
},
"datasetType": {
"default": "SEM",
"description": "(Optional) - To be selected from the enumerated list depending on the detector and the angle at which the sample is measured: * SEM Image * SEM Image 2 * EDS * EBSD * BSE * ISE * ISI * SI * InLens * SESI",
"enum": [
"SEM Image",
"SEM Image 2",
"SEM Image 3",
"SEM Image 4",
"SEM Image 5",
"EDS",
"EBSD",
"BSE",
"ISE Image",
"ISI Image",
"SI Image",
"InLens",
"SESI"
],
"type": "string"
},
"definition": {
"description": "(Optional)- Name of the schema to which this entry conforms. In this case, acquisition_dataset is to be written",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Identifier of the dataset. It could be the PID of location where the entire dataset is stored"
},
"images": {
"desription": "(Required) - Array containing the images and their specific parameters. No. of images in the array is described by the numberOfItems parameter at the entry level of this schema",
"items": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json"
},
"type": "array"
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings"
},
"numberOfItems": {
"description": "(Required) - Number of Items (images, files). Depends on the number of slices",
"type": "number"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required)- Details concerning the program (or software) used for aquisition"
},
"rows": {
"description": "(Optional) - Number of rows in the tiled image grab setting",
"type": "number"
},
"tileColumn": {
"description": "(Optional) - The selected column in the tiled image grab setting",
"type": "number"
},
"tileRow": {
"description": "(Optional) - The selected row in the tiled image grab setting",
"type": "number"
},
"user": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/user_description.json",
"description": "(Optional)- The contact information of the user responsible for the measurement"
}
},
"required": [
"program",
"instrument",
"datasetType",
"images",
"numberOfItems"
],
"title": "acquisition_dataset",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 3c305f9b387d745de2790d83d7ea6d27ba67b0d9 | 2023-11-24T16:32:34 | SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "degree",
"description": "(Unit) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "pA",
"description": "(Optional) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string",
"enum": [
"pA",
"nA",
"uA",
"mA",
"A"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Optional) - Further notes about the value of datatype string",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"detectorDetails": {
"additionalProperties": false,
"description": "(Required) - describes the settings related to the detector with which the image set is acquired",
"properties": {
"detectorSettings": {
"$ref": "#/$defs/detectorSettings",
"description": "(Required) - Settings of the specific detector used. E.g., the Everhart Thornley detector (ETD), is a secondary electron and back-scattered electron detector used in scanning electron microscopes, whihc has then particular settings"
},
"detectorType": {
"description": "(Required) - Type of the detector used",
"enum": [
"ETD",
"CDEM",
"CBS",
"ECD",
"External",
"GBSD",
"GSED",
"ICE",
"LFD",
"LVD",
"LVSED",
"None",
"STEM3",
"STEM3_GMode",
"STEM4",
"T1",
"T2",
"T3",
"TLD"
],
"type": "string"
},
"name": {
"description": "(Optional) - Name of the detector used",
"type": "string"
}
},
"required": [
"detectorType"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "describes the parameters of a detector such as the Everhart Thornley detector (ETD), which is a secondary electron and back-scattered electron detector used in scanning electron microscopes",
"properties": {
"brightness": {
"description": "(Optional) - A number indicating the brightness",
"type": "number"
},
"brightnessdB": {
"description": "(Optional) - Describes the brightness in dB",
"type": "number"
},
"contrast": {
"description": "(Optional) - A number indicating the contrast",
"type": "number"
},
"contrastdB": {
"description": "(Optional) - Describes the contrast in dB",
"type": "number"
},
"enhancedContrast": {
"description": "(Optional) - Describes the enhancement in contrast",
"type": "number"
},
"frontEndVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Bias voltage applied to the front end of the detector "
},
"grid": {
"description": "(Optional) - A number indicating the number of grid elements",
"type": "number"
},
"gridVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage applied to the grid "
},
"minimumDwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Minimum possible dwell time for the detector. IRI: https://purls.helmholtz-metadaten.de/EMG/00000006 "
},
"mix": {
"description": "(Optional) - Signals from different detectors can be overlaid (mixed) and this should, in theory, be the percentage of this detectors contribution to the end result.",
"type": "number"
},
"setting": {
"description": "(Optional) - In case of ETD, this is the bias voltage applied to the detector grid. Note that this block looks different for different detectors. ",
"type": "string"
},
"signal": {
"description": "(Optional) - The signal used for detection",
"enum": [
"SE",
"BSE",
"SI"
],
"type": "string"
}
},
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"eBeamDetails": {
"additionalProperties": false,
"description": "(Required) - Describes the configuration of the electron beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000007",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The potential difference between anode and cathode. The acceleration voltage adds kinetic energy to the particles of the beam. IRI: https://purls.helmholtz-metadaten.de/EMG/00000001 It is defined separately as voltageDetails, (includes the voltage value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - uV, mv, V, kV, MV)"
},
"apertureSetting": {
"additionalProperties": false,
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size (diameter) of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails."
}
},
"type": "object"
},
"beamCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Electrical current which flows along the beam path. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003 It is defined separately as currentDetails (includes the current value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)."
},
"dynamicFocusIsOn": {
"description": "(Optional) - To bet set true if dynamic focus is on. IRI:https://purls.helmholtz-metadaten.de/emg/00000039",
"type": "boolean"
},
"dynamicWDIsOn": {
"description": "(Optional) - To bet set true if dynamic working distance is on. IRI: https://purls.helmholtz-metadaten.de/EMG/00000026",
"type": "boolean"
},
"horizontalFieldWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual horizontal length scanned on the sample defined separately as distanceDetails."
},
"imageMode": {
"description": "(Optional) - The type of image mode used. Could be a text or number depending on the instrument.",
"type": "string"
},
"lensMode": {
"description": "(Optional) - The type of image mode used",
"enum": [
"Field-Free",
"Immersion",
"EDS"
],
"type": "string"
},
"magnificationCorrection": {
"description": "(Optional) - To bet set true if magnification correction is on",
"type": "boolean"
},
"preTilt ": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Sometimes, pre-tilted holders are used and the pretilt angle must be given in the acquisition software because actual tilt = stage tilt plus pretilt."
},
"scanRotation": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Angle by which beam scanning direction is rotated"
},
"tiltCorrectionAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - If the sample is tilted, the image is compressed in the vertical direction, i.e. the pixels are not isotropic anymore. Tilt correction adapts the line spacing of the scanning to compensate for this. IRI:https://purls.helmholtz-metadaten.de/emg/00000037"
},
"tiltCorrectionIsOn": {
"description": "(Optional) - To bet set true if tilt correction is on. IRI:https://purls.helmholtz-metadaten.de/emg/00000037",
"type": "boolean"
},
"verticalFieldWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual vertical length scanned on the sample defined separately as distanceDetails."
}
},
"required": [
"accelerationVoltage",
"verticalFieldWidth",
"horizontalFieldWidth",
"apertureSetting",
"scanRotation"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "J",
"description": "(Optional) - the unit of the value to be selected from a controlled list (nJ, mJ, J, kJ, eV, meV default value - J) of datatype string",
"enum": [
"nJ",
"mJ",
"J",
"kJ",
"eV",
"meV"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"hotStageMEMSDetails": {
"additionalProperties": false,
"description": "describes the parameters related if a hot stage MEMS is used",
"properties": {
"actualTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Describes the actual Temperature measured in the hot stage MEMS"
},
"heatingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Describes the heating current used in the hot stage MEMS"
},
"heatingPower": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Describes the heating power used in the hot stage MEMS"
},
"heatingVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Describes the heating voltage used in the hot stage MEMS"
},
"sampleBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Describes the bias voltage applied to the sample in the hot stage MEMS"
},
"sampleResistance": {
"$ref": "#/$defs/resistanceDetails",
"description": "(Optional) - Describes the target Temperature used in the hot stage MEMS"
},
"targetTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Describes the target Temperature set in the hot stage MEMS"
}
},
"type": "object"
},
"iBeamDetails": {
"additionalProperties": false,
"description": "(Required) - Describes the configuration of the ion beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000016",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The potential difference between anode and cathode. The acceleration voltage adds kinetic energy to the particles of the beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000001 It is defined separately as voltageDetails, (includes the voltage value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - uV, mv, V, kV, MV)"
},
"millingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Electrical current used in SEM-FIB Tomography to mill/cut the sample. In this case this is the same as the beam current of the ion beam. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003 It is defined separately as currentDetails (includes the current value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)."
}
},
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"imageDetails": {
"additionalProperties": false,
"description": "(Required) - describes the settings related to imaging",
"properties": {
"digitalBrightness": {
"description": "(Required) - A number indicating the setting for digital brightness (a basic post-processing method)",
"type": "number"
},
"digitalContrast": {
"description": "(Required) - A number indicating the setting for digital contrast (a basic post-processing method)",
"type": "number"
},
"digitalGamma": {
"description": "(Required) - A number indicating the setting for digital Gamma (a basic post-processing method)",
"type": "number"
},
"driftcorrected": {
"description": "(Required) - To bet set true if drift correction is on",
"type": "boolean"
},
"numberOfPixels": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The number of x, y pixels of the image (Resolution), defined separately as pixelNumberType with separate entries for integer values of xPixels and yPixels"
},
"postprocessing": {
"description": "(Optional) - Describes the post-processing performed on the image",
"type": "string"
},
"transformation": {
"description": "(Optional) - Describes the transformations performed on the image",
"type": "string"
},
"zoomfactor": {
"description": "(Required) - A number indicating the zoom factor",
"type": "number"
}
},
"required": [
"digitalContrast",
"digitalBrightness",
"digitalGamma",
"numberOfPixels",
"driftcorrected",
"zoomfactor"
],
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"beamType": {
"description": "(Required) - The selected beam",
"enum": [
"EBeam",
"IBeam"
],
"type": "string"
},
"detector": {
"oneOf": [
{
"$ref": "#/$defs/detectorDetails",
"description": "(Required) - Details about the detector used for acquisition."
},
{
"description": "(Required) - Details about the detector(s) used for acquisition.",
"items": {
"$ref": "#/$defs/detectorDetails"
},
"minItems": 1,
"type": "array"
}
]
},
"eBeam": {
"$ref": "#/$defs/eBeamDetails",
"description": "(Required) - Details about the electron beam"
},
"hotStageMEMS": {
"$ref": "#/$defs/hotStageMEMSDetails",
"description": "(Optional) - Pressure maintained inside the chamber (in which the sample is housed) during the measurement"
},
"iBeam": {
"$ref": "#/$defs/iBeamDetails",
"description": "(Required) - Details about the ion beam"
},
"imaging": {
"$ref": "#/$defs/imageDetails",
"description": "(Optional) - Details about the imaging settings"
},
"numberOfDetectors": {
"description": "Number of detectors used for the acquisition",
"type": "number"
},
"scan": {
"$ref": "#/$defs/scanDetails",
"description": "(Required) - Details about the scan settings"
},
"spot": {
"description": "(Optional) - Qualitative index for beam current. Varies with current setting, i.e. 1.6 nA is spot = 1, 3.2 nA is spot = 2, 0.1 nA = spot =-3, so it can also be negative. May vary between different microscope models.",
"type": "number"
}
},
"required": [
"eBeam",
"scan",
"imaging",
"detector"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes the resolution of the image split into number of pixels in x and y directions.",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "describes a power",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "W",
"description": "(Optional) - the unit of the value to be selected from a controlled list (\u00b5W, mW, W, kW, MW default value - W) of datatype string",
"enum": [
"\u00b5W",
"mW",
"W",
"kW",
"MW"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The power expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "Pa",
"description": "(Optional) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"resistanceDetails": {
"additionalProperties": false,
"description": "describes a resistance",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "ohm",
"description": "(Optional) - the unit of the value to be selected from a controlled list (abohm, ohm, k ohm, M ohm default value - ohm) of datatype string; default unit is ohm",
"enum": [
"abohm",
"ohm",
"k ohm",
"M ohm"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The resistance expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"scanDetails": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scan settings.",
"properties": {
"average": {
"description": "(Optional) - Number of images averaged at each slice",
"type": "number"
},
"dwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time period during which the beam remains on one position/stationary. IRI: https://purls.helmholtz-metadaten.de/EMG/00000006 "
},
"eScan": {
"additionalProperties": false,
"description": "gives settings pertaining to electron beam scan",
"properties": {
"lineAveraging": {
"description": "(Optional) - Number of lines averaged",
"type": "number"
},
"lineIntegration": {
"description": "(Optional) - Number of lines integrated",
"type": "number"
},
"lineTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) -Time period during which a line is fully scanned."
},
"mainsLock": {
"description": "(Optional) - To bet set true if mains lock is on",
"type": "boolean"
},
"scanInterlacing": {
"description": "(Optional) - Number of scans interlaced. This setting splits an imaging area into blocks defined by the number of lines (from 2 to 8). In the first instance, the first line of each block is scanned, then the second one, etc. This imaging method significantly reduces charging.",
"type": "number"
}
},
"type": "object"
},
"frameTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) -Time period during which a frame is fully scanned. IRI: https://purls.helmholtz-metadaten.de/EMG/00000014 "
},
"horizontalFieldSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the actual horizontal length scanned on the sample defined separately as distanceDetails"
},
"integrate": {
"description": "(Optional) - Number of images integrated at each slice",
"type": "number"
},
"internalScan": {
"description": "(Optional) - To bet set true if internal scan is on",
"type": "boolean"
},
"pixelHeight": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual width of a pixel"
},
"pixelWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual width of a pixel"
},
"scanType": {
"description": "(Optional) - The type of scan E-Scan or I-Scan",
"enum": [
"EScan",
"IScan"
],
"type": "string"
},
"verticalFieldSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the actual vertical length scanned on the sample defined separately as distanceDetails"
}
},
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time period. IRI:https://purls.helmholtz-metadaten.de/EMG/00000024",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "us",
"description": "(Optional) - the unit of the value to be selected from a controlled list (ps, ns, us, ms, s default value - us) of datatype string",
"enum": [
"ps",
"ns",
"us",
"ms",
"s"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"user": {
"description": "Contact information of the user responsible for the measurement.",
"properties": {
"ORCID": {
"description": "(Optional) - Open Researcher and Contributor ID expressed as a URI",
"pattern": "^https://orcid\\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[X0-9]{1}$",
"type": "string"
},
"affiliation": {
"description": "(Optional) - Details of the institution to which the user is affiliated",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"description": "(Optional) -Identifier of the institution to which the user is affiliated",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be chosen from a controlled list of values (*ROR *GRID *ISNI *URL *DOI *Handle)",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"email": {
"description": "(Optional) - Email of the user",
"format": "email",
"type": "string"
},
"familyName": {
"description": "(Optional) - Family name of the user",
"type": "string"
},
"givenName": {
"description": "(Optional) - Given name of the user",
"type": "string"
},
"role": {
"description": "(Optional) - Role of the user to be selected from: *Data Curator *Instrument Scientist *Team Leader *Team Member",
"enum": [
"Data Curator",
"Instrument Scientist",
"Team Leader",
"Team Member"
],
"type": "string"
},
"userName": {
"description": "(Required) - Full name of the user recommended in the format (Family Name, Given Name)",
"type": "string"
}
},
"required": [
"userName"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "kV",
"description": "(Optional) - the unit of the value to be selected from a controlled list (uV, mV, V, kV, MV, GV default value - V) of datatype string",
"enum": [
"uV",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The voltage expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes a set of images acquired during the course of a SEM/FIB Tomography experiment. The images in each dataset is taken using a detector (SE, BSE, EDS, EBSD) using a specific configuration. This Schema contains only the parameters which are specific to the entire dataset. The parameters which are particular to each image is located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json. The units are by default to be considred as the SI units unless otherwise specified",
"properties": {
"columns": {
"description": "(Optional) - Number of column in the tiled image grab setting",
"type": "number"
},
"datasetType": {
"default": "SEM",
"description": "(Optional) - To be selected from the enumerated list depending on the detector and the angle at which the sample is measured: * SEM Image * SEM Image 2 * EDS * EBSD * BSE * ISE * ISI * SI * InLens * SESI",
"enum": [
"SEM Image",
"SEM Image 2",
"SEM Image 3",
"SEM Image 4",
"SEM Image 5",
"EDS",
"EBSD",
"BSE",
"ISE Image",
"ISI Image",
"SI Image",
"InLens",
"SESI"
],
"type": "string"
},
"definition": {
"description": "(Optional)- Name of the schema to which this entry conforms. In this case, acquisition_dataset is to be written",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Identifier of the dataset. It could be the PID of location where the entire dataset is stored"
},
"images": {
"desription": "(Required) - Array containing the images and their specific parameters. No. of images in the array is described by the numberOfItems parameter at the entry level of this schema",
"items": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json"
},
"type": "array"
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings"
},
"numberOfItems": {
"description": "(Required) - Number of Items (images, files). Depends on the number of slices",
"type": "number"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required)- Details concerning the program (or software) used for aquisition"
},
"rows": {
"description": "(Optional) - Number of rows in the tiled image grab setting",
"type": "number"
},
"tileColumn": {
"description": "(Optional) - The selected column in the tiled image grab setting",
"type": "number"
},
"tileRow": {
"description": "(Optional) - The selected row in the tiled image grab setting",
"type": "number"
},
"user": {
"$ref": "#/$defs/user",
"description": "(Optional)- The contact information of the user responsible for the measurement"
}
},
"required": [
"program",
"instrument",
"datasetType",
"images",
"numberOfItems"
],
"title": "acquisition_dataset",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | da2c86e8c1cb94c662cdc9be1f47aeb64557d914 | 2023-12-14T14:32:25 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"CTAquisition": {
"additionalProperties": false,
"description": "(Required) - Details about the acquisition.",
"properties": {
"acquisitionScriptName": {
"description": "(Required) - Name of the script used for acquisition.",
"type": "string"
},
"acquisitionTimePerProjection": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time taken for acquisition of a single projection. Typical unit - s."
},
"angularStepSize": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Step size of the rotation of the sample during the CT. Typical unit - degree."
},
"contrastType": {
"description": "(Required) - The contrast type(mode) used - Absorption Contrast or Phase Contrast. If 'Phase Contrast' is selected, please indicate the used Phase Contrast Mode under the field phaseContrastMode.",
"enum": [
"Absorption Contrast",
"Phase Contrast"
],
"type": "string"
},
"endAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - End angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then endAngle is 180\u00b0. Typical unit - degree."
},
"largeFOV": {
"description": "(Required) - To be set to true if large field of view or wide field of view is used.",
"type": "boolean"
},
"numberOfProjections": {
"description": "(Required) - Number of projections acquired during the CT.",
"type": "number"
},
"phaseContrastMode": {
"description": "(Optional) - The phase contrast mode used during acquisition - Zernike phase contrast, propagation-based, grating-based(Hartmann), grating-based(Talbot).",
"enum": [
"Zernike phase contrast",
"Propagation-based",
"Grating-based(Hartmann)",
"Grating-based(Talbot)"
],
"type": "string"
},
"referenceImages": {
"additionalProperties": false,
"description": "(Optional) - Details on the reference images (if used) - number of flats/bright images and number of dark images.",
"properties": {
"numberOfBrightImages": {
"description": "(Optional) - Number of flats or bright images used as reference.",
"type": "number"
},
"numberOfDarkImages": {
"description": "(Optional) - Number of dark images used as reference.",
"type": "number"
}
},
"type": "object"
},
"scanningMode": {
"description": "(Optional) - The scanning mode used during acquisition - helical, raster scanning, fast CT.",
"enum": [
"Helical",
"Raster Scanning",
"Fast CT"
],
"type": "string"
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Start angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then startAngle is -180\u00b0. Typical unit - degree."
},
"totalAcquisitionTime": {
"description": "(Required) - Time taken for acquisition for the entire scan. This is the total scan time, i.e. number of projections multipled by exposure time, but including read-out time. calculated as EndTime-StartTime. Format: hh:mm:ss.",
"format": "time",
"pattern": "^(\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?)$",
"type": "string"
},
"useBadPixelMap": {
"description": "(Optional) - To be set to true if bad pixel map is used. This parameter is relevant for SEM based CT.",
"type": "boolean"
}
},
"required": [
"acquisitionScriptName",
"startAngle",
"endAngle",
"angularStepSize",
"acquisitionTimePerProjection",
"totalAcquisitionTime",
"largeFOV",
"contrastType"
],
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "degree",
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"angleSet": {
"additionalProperties": false,
"description": "(Optional) - Tilt angles alpha, beta and gamma decribing the three angular positions of an item.",
"properties": {
"alpha": {
"description": "(Optional) - Tilt angle alpha of the item.",
"type": "number"
},
"anglesUnit": {
"default": "degree",
"description": "(Optional) - unit of the angles (allowed units - degree or radian)",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"beta": {
"description": "(Optional) - Rotation angle beta of the item.",
"type": "number"
},
"gamma": {
"description": "(Optional) - Angle gamma of the item.",
"type": "number"
}
},
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"default": "\u00b5m",
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "pA",
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string.",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"data": {
"additionalProperties": false,
"description": "(Required) - Details about the data section of the measurement.",
"properties": {
"projections": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"cropping": {
"additionalProperties": false,
"description": "(Optional) - Details about cropping or clipping to select a region of interest(ROI).",
"properties": {
"ROI": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The size of the region of interest (ROI) in integer values of xPixels and yPixels."
},
"offset": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The offset applied to the origin (i.e., centre of the image) to select the region of interest in x and y coordinates."
}
},
"required": [
"ROI",
"offset"
],
"type": "object"
},
"projectionImageDataStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the data structure of the image data of the projections.",
"properties": {
"IOValue": {
"description": "(Required) - The IO value obtained from the metadata.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The dimension of the image as for integer values of xPixels and yPixels."
},
"fileLocation": {
"description": "(Required) - The location where the data file is stored. A URL is preferred if available.",
"type": "string"
},
"greyValueRepresentation": {
"description": "(Optional) - Description about the grey value representation.",
"type": "string"
},
"header": {
"additionalProperties": false,
"description": "(Required) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Required) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"imageCorrection": {
"additionalProperties": false,
"description": "(Optional) - Details about the image correction.",
"properties": {
"isImageCorrected": {
"description": "(Required) - To be set as true if image is corrected.",
"type": "boolean"
},
"linkToReferenceImages": {
"description": "(Required) - Link to the reference images (flats/darks).",
"format": "uri-reference",
"type": "string"
}
},
"required": [
"isImageCorrected",
"linkToReferenceImages"
],
"type": "object"
},
"imageFormats": {
"additionalProperties": false,
"description": "(Required) - The file formats of the images - tiff, png, jpeg. When more than one file formats are there, then the formats are to be entered as an array of strings.",
"properties": {
"fileFormats": {
"oneOf": [
{
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
{
"items": {
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
"type": "array"
}
]
}
},
"required": [
"fileFormats"
],
"type": "object"
},
"imageID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the Image Data."
},
"isPreFiltered": {
"description": "(Optional) - To be set as true if image is prefiltered.",
"type": "boolean"
},
"name": {
"description": "(Required) - Name of the Projection Image Data.",
"type": "string"
},
"numberOfImages": {
"description": "(Required) - Number of images in the data set. It is same as the number of projections.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical x,y length imaged by a single pixel, normally expressed in \u00b5m."
}
},
"required": [
"fileLocation",
"name",
"imageFormats",
"header"
],
"type": "object"
}
},
"required": [
"projectionImageDataStructure"
],
"type": "object"
},
"reconstructedData": {
"additionalProperties": false,
"description": "(Required) - Details about the reconstructed slices. When multiple reconstructions of the same raw data (projections) are present, the corresponding data can be combined as an array of reconstruction data sets, else as a single reconstruction data set.",
"properties": {
"reconstruction": {
"oneOf": [
{
"$ref": "#/$defs/reconstruction"
},
{
"items": {
"$ref": "#/$defs/reconstruction"
},
"type": "array"
}
]
}
},
"required": [
"reconstruction"
],
"type": "object"
}
},
"required": [
"projections",
"reconstructedData"
],
"type": "object"
},
"detector": {
"additionalProperties": false,
"description": "gives the settings of a detector or multiple detectors.",
"properties": {
"detectorSettings": {
"oneOf": [
{
"$ref": "#/$defs/detectorSettings"
},
{
"items": {
"$ref": "#/$defs/detectorSettings"
},
"type": "array"
}
]
}
},
"required": [
"detectorSettings"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "(Required) - Gives the settings of a single detector.",
"properties": {
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each pixel or voxel in an image. The bit depth determines the number of possible intensity levels that can be assigned to each pixel or voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"cameraGain": {
"description": "(Optional) - The amplification (gain) of the signal from an image sensor in a camera.",
"type": "number"
},
"detectorCoolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Cooling temperature of the detector, if it cooled. Relevant for SEM based CT. Typical unit - K."
},
"detectorDimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Optional) - The dimensions of the detector in integer values of xPixels and yPixels."
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector."
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the detector (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"detectorMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - The motor positions of the detector in cartesian coordinates and tilt angles."
},
"detectorName": {
"description": "(Optional) - Name of the detector of datatype string.",
"type": "string"
},
"detectorPixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical length in cartesian coordinates imaged by a single pixel of the detector. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"detectorType": {
"description": "(Optional) - The type of detector to be selected from a controlled list consisting of CCD, Panel, PCXD, CMOS, Time-Delay Integration (TDI) and Direct Conversion.",
"enum": [
"CCD",
"Panel",
"PCXD",
"CMOS",
"Time-Delay Integration (TDI)",
"Direct Conversion"
],
"type": "string"
},
"energyThreshold": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - A specific energy level used to filter the detected radiation."
},
"exposureTimePerFrame": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Time for which the sample is exposed per frame. Typical unit - s."
},
"frameSkip": {
"additionalProperties": false,
"description": "(Optional) - A numerical representation indicating the number of frames that are skipped or omitted during the acquisition or recording process. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3. If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped.",
"properties": {
"value": {
"oneOf": [
{
"description": "(Optional) - Number of frames skipped during acquisition. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3.",
"type": "number"
},
{
"description": "(Optional) - Pattern of frames skipped during acquisition. E.g. - If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped like [1,3,5]",
"items": {
"type": "number"
},
"type": "array"
}
]
}
},
"type": "object"
},
"framesPerSecond": {
"description": "(Optional) - The number of frames captured in a second.",
"type": "number"
},
"imagePixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical length in cartesian coordinates imaged by a single pixel of the image. It is the native pixel size divided by the total magnification. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"lens": {
"additionalProperties": false,
"description": "(Optional) - Details of a lens, if used with the detector.",
"properties": {
"hasLens": {
"description": "(Required) - To be set to true if the detector has a lens.",
"type": "boolean"
},
"lensFocalLength": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Focal length of the lens."
},
"lensID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the lens."
},
"lensMagnification": {
"description": "(Optional) - Magnification of the lens as a floating point number.",
"type": "number"
},
"lensManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the lens (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"lensName": {
"description": "(Optional) - Name of the lens of datatype string.",
"type": "string"
}
},
"required": [
"lensMagnification",
"lensFocalLength"
],
"type": "object"
},
"numberOfAveragedFramesPerProjection": {
"description": "(Optional) - The number of averaged frames per projection, if averaging is done.",
"type": "number"
},
"sensor": {
"additionalProperties": false,
"description": "(Optional) - Details about a sensor, if present.",
"properties": {
"hasSensor": {
"description": "(Required) - To be set to true if the detector has a sensor.",
"type": "boolean"
},
"sensorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the sensor."
},
"sensorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the sensor (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"sensorMaterial": {
"description": "(Optional) - Material of the sensor of datatype string.",
"type": "string"
},
"sensorName": {
"description": "(Optional) - Name of the sensor of datatype string.",
"type": "string"
},
"sensorThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the sensor."
},
"sensorType": {
"description": "(Optional) - The type of sensor as a string.",
"type": "string"
}
},
"required": [
"hasSensor"
],
"type": "object"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Temperature of the detector."
},
"totalCountsPerProjection": {
"description": "(Optional) - The sum of the intensity values recorded by the X-ray detector for a single projection during a scan.",
"type": "number"
}
},
"required": [
"detectorType",
"detectorManufacturer",
"binning",
"detectorMotorPositions",
"imagePixelSize"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ; default value - keV) of datatype string",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"entry": {
"additionalProperties": false,
"description": "Required) - The entry level is the root element of the schema. It contains all the metadata describing a CT measurement.",
"properties": {
"consumables": {
"description": "(Optional) - Auxiliary entity used during Fabrication, Sample Preparation or Measurement which has a limited time capacity or is limited in its number of uses before it is disposed of, necessary to the process itself and normally bought from third party manufacturers. Examples are: gloves, syringes, wipes, etching solutions, glass slides, spatulas, weighing paper, two-sided tape.",
"items": {
"type": "string"
},
"type": "array"
},
"data": {
"$ref": "#/$defs/data",
"description": "(Optional)- Details concerning the data section of the measurement."
},
"definition": {
"description": "(Required) - Name of the schema to which this entry conforms. In this case, lab_CT should be written.",
"type": "string"
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry usually provided by the project or the laboratory."
},
"equipment": {
"description": "(Optional) - Any kind of physical or virtual item, device, machine or other tools used to perform one or more Fabrication(s), Sample Preparation(s), Model Preparation(s), Data Acquisition(s) and/or any of the processes included in the Data Analysis Lifecycle. Usually, the Equipment is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. Equipment is usually an investment. According to this definition, an Instrument is a particular type of Equipment.",
"type": "string"
},
"experimentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the measurement usually provided by the project or the laboratory."
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings. Instrument is a physical or virtual identifiable piece of Equipment used to perform a Data Acquisition and to generate Raw Data. The Instrument is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. A virtual Instrument may be any computational resource or HPC infrastructure (cloud infrastructure or supercomputer) needed to perform Calculations or Simulations."
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure."
},
"measurementDescription": {
"description": "(Optional) - Description about the measurement.",
"type": "string"
},
"measurementPurpose": {
"description": "(Required) - Measurement is experimental Data Acquisition, typically performed on a Sample using an experimental Technique. It may also be performed during Fabrication or Sample Preparation, e.g., to characterise the intermediate stages and/or the final resulting Precursor(s) or Sample(s), respectively. A Measurement may require the use of Consumables.",
"enum": [
"assessment (to given categories or values)",
"completeness check (presence or absence of given properties)",
"correlative characterization (dedicated sample treatment to emphasise given features)",
"exploratory (routine check of known properties)",
"feasibility (quick check, rough estimate)",
"high quality measurement (precise, careful treatment)",
"test specific hypothesis (focus only on given aspects)",
"other (please specify in the comment)"
],
"type": "string"
},
"parents": {
"description": "(Required) - Parents of this metadata like the metadata document of the sample with which the measurement was performed.",
"items": {
"if": {
"properties": {
"parentType": {
"not": {
"const": "not applicable"
}
}
}
},
"properties": {
"parentReference": {
"description": "If type is 'MetaStore URI' it is possible to easily fill this field in a later stage",
"format": "uri-reference",
"type": "string"
},
"parentReferenceType": {
"enum": [
"plain text",
"external URL",
"MetaStore URI"
],
"type": "string"
},
"parentType": {
"enum": [
"not applicable",
"sample"
],
"type": "string"
}
},
"required": [
"parentType"
],
"then": {
"required": [
"parentReferenceType",
"parentReference"
]
},
"type": "object"
},
"type": "array"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition."
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format."
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"technique": {
"description": "(Required) - Any experimental, theoretical or computational method used during Data Acquisition or during any of the processes included in the Data Analysis Lifecycle to acquire, process or analyse Research Data about a System or a set of them with an Instrument, whihc is used to generate this metadata.",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement.",
"type": "string"
},
"user": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/user_description.json",
"description": "(Required)- The contact information of the user responsible for the measurement."
}
},
"required": [
"title",
"technique",
"definition",
"parents",
"measurementPurpose",
"startTime",
"endTime",
"program",
"user",
"instrument",
"data"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min) default value - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"geometry": {
"additionalProperties": false,
"description": "Describes the geometry of the CT instrument",
"properties": {
"beamGeometry": {
"additionalProperties": false,
"description": "(Required) - Details about beam geometry like beam geometry type and divergence angle.",
"properties": {
"beamGeometryType": {
"description": "(Required) - The type of the beam geometry to be selected between 'collimated' and 'divergent'.",
"enum": [
"collimated",
"divergent"
],
"type": "string"
},
"divergenceAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Angle of divergence when the beam geometry is divergent. Typical unit - degree."
}
},
"type": "object"
},
"geometricMagnification": {
"description": "(Required) - Geometric magnification refers to the ratio of the size of an object's image to the size of the object itself. It is a measure of how much larger the image appears compared to the actual object. Geometric magnification (M) is calculated using the formula M = (SID + SOD) / SID, where SID is the source-to-image distance and SOD is the source-to-object distance.",
"type": "number"
},
"objectToDetectorDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the object and the detector. Typical unit - \u00b5m."
},
"opticalMagnification": {
"description": "(Required) - Optical magnification is calculated as the ratio of the focal length of the objective lens to the focal length of the eyepiece (if an eyepiece is present) in a traditional optical microscope.",
"type": "number"
},
"sourceToObjectDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the source and the object. Typical unit - \u00b5m."
}
},
"required": [
"sourceToObjectDistance",
"objectToDetectorDistance",
"beamGeometry",
"geometricMagnification",
"opticalMagnification"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"CTAquisition": {
"$ref": "#/$defs/CTAquisition",
"description": "(Optional) - Details regarding the acquisition."
},
"calibration": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the calibration and the scaling factor.",
"properties": {
"calibrationType": {
"description": "(Optional) - Type of calibration as a string.",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (YYYY-MM-DDThh:mm:ss.sss) in the ISO 8601 date-time format",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"systemScaling": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scaling factor.",
"properties": {
"adjustSystemScaling": {
"description": "(Required) - To be set to true if system scaling is adjusted, else false.",
"type": "boolean"
},
"measuredScalingFactor": {
"description": "(Optional) - Value of the measured scaling factor.",
"type": "number"
},
"referenceScalingFactor": {
"description": "(Optional) - Value of the reference scaling factor, determined ususally during the data processing.",
"type": "number"
}
},
"required": [
"adjustSystemScaling"
],
"type": "object"
}
},
"type": "object"
},
"detector": {
"$ref": "#/$defs/detector",
"description": "(Optional) - Details regarding the detector."
},
"focalSpotMode": {
"additionalProperties": false,
"description": "(Optional) - Option for setting the size of the focal spot. Some sources have the option to select the target spot size, or focal spot size absolutely by setting a value, while some others give the option of selecting 'small', 'medium' or 'large'. Smaller spot size = higher resolution. Note that the power/current will change with this value. In addition, the detector settings will usually be selected in conjunction. (different scintillator/lens/magnification).",
"properties": {
"selection": {
"description": "(Optional) - Selection of the setting of the size of the focal spot when the option for setting the size of the focal spot by selecting 'small', 'medium' or 'large' according to predefined values set by the manufacturer.",
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the target spot when the option for setting the size of the focal spot absolutely by setting a value is available."
}
},
"type": "object"
},
"geometry": {
"$ref": "#/$defs/geometry",
"description": "(Optional) - Details regarding the geometry."
},
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"optics": {
"$ref": "#/$defs/optics",
"description": "(Optional) - Details about the optics and individual motor positions."
},
"sampleStage": {
"$ref": "#/$defs/sampleStage",
"description": "(Optional) - Details regarding the sample stage."
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray target in an SEM based CT set-up.",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required) - Details of the pressure maintained in the chamber of the SEM."
},
"electronBeamShift": {
"additionalProperties": false,
"description": "(Required) - The distance by which the electron beam is shifted in the x and y directions.",
"properties": {
"xShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the x direction. Typical unit - \u00b5m."
},
"yShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xShift",
"yShift"
],
"type": "object"
},
"electronProbeCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required) - The electron current measured at the probe. Typical unit - \u00b5A."
},
"objectiveLensAperture": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). Typically the diameter of the aperture is set in \u00b5m."
},
"target": {
"additionalProperties": false,
"description": "(Required) - Details regarding the target in SEM based CT, which upon interaction with the e-beam produces the X-rays.",
"properties": {
"targetDriftCorrection": {
"description": "(Required) - If drift correction is activated for the target, this parameter has to be set to true.",
"type": "boolean"
},
"targetMaterial": {
"description": "(Required) - Material with which the target is made.",
"type": "string"
},
"targetShape": {
"description": "(Optional) - Description of the shape or geometry of the target. e.g. - bulk, foil, needle.",
"type": "string"
},
"targetThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Thickness of the target (dimension in Z direction). Default unit - \u00b5m."
},
"targetTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the target is tilted. Typical unit - degree."
}
},
"required": [
"targetMaterial",
"targetThickness",
"targetDriftCorrection",
"targetTiltAngle",
"targetCurrent"
],
"type": "object"
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. In SEM based CT, the beam is focussed on the target material which emits the X-rays upon interaction with the electrons. Default unit - \u00b5m."
}
},
"required": [
"chamberPressure",
"electronBeamShift",
"workingDistance",
"objectiveLensAperture",
"electronProbeCurrent",
"target"
],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
},
"targetCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current measured at the X-ray target, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"sourceDrift": {
"additionalProperties": false,
"description": "(Optional) - Distance by which the source is shifted during the measurement (i.e., end position - start position).",
"properties": {
"xDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the x direction. Typical unit - \u00b5m."
},
"yDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xDrift",
"yDrift"
],
"type": "object"
},
"sourcePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the source."
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray enrgy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source",
"focalSpotMode",
"CTAquisition",
"geometry",
"sampleStage",
"detector"
],
"type": "object"
},
"lifetimeDetails": {
"additionalProperties": false,
"description": "describes a lifetime.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5Ah",
"description": "(Required) - the unit of the value (default value - \u00b5Ah) of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The lifetime of the source expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer.",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"bioReactor": {
"additionalProperties": false,
"description": "(Optional) - Details of an in situ bioreactor.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in sterile conditions.",
"type": "boolean"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is decreased. Typical unit - K/min."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is increased, typically in K/min."
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"anvil": {
"description": "(Optional) - The type of anvil used in the in situ load frame (stage) for applying a particular type of force on the sample. Option to be selected from a controlled list consisting of - Compression, Diamond indentation 90\u00b0 cone, Diamond indentation cube corner, Diamond indentation wedge, Tension, Other. If 'Other' is selected, specify the name of the anvil with a description in the field 'otherAnvil'.",
"enum": [
"Compression",
"Diamond indentation 90\u00b0 cone",
"Diamond indentation cube corner",
"Diamond indentation wedge",
"Tension",
"Other"
],
"type": "string"
},
"blindAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - ed by the load frame(stage). Example: for a CT normally scanned over 180\u00b0 (e.g. -90\u00b0/+90\u00b0), a blind angle of 40\u00b0 due to the in situ cell implies that only 180\u00b0-40\u00b0=140\u00b0 (e.g. -70\u00b0/70\u00b0) is visible. NOTE: for a CT normally scanned over 360\u00b0 (e.g. -180\u00b0/+180\u00b0), a blind angle of 40\u00b0 would require the subtraction of the blind angle twice, implying two scan ranges of 140\u00b0 each (e.g. -160\u00b0/-20\u00b0 and +20\u00b0/+160\u00b0). Typical unit - degree."
},
"displacement": {
"additionalProperties": false,
"description": "(Optional) - Specification on how displacement is applied on the sample. Either 'displacementRate' in \u00b5m/min or 'displacementIncrement' in \u00b5m/acquisition need to be selected.",
"properties": {
"displacementIncrement": {
"description": "(Optional) - The step at which displacement is changed per acquisition in \u00b5m/acquisition.",
"type": "number"
},
"displacementRate": {
"description": "(Optional) - The rate at which displacement is applied on the sample in \u00b5m/min.",
"type": "number"
}
},
"type": "object"
},
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame or anvil (e.g. - size of anvil) relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
},
"maximumDisplacement": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - The maximum displacement allowed in the selected configuration. Typical unit - \u00b5m."
},
"maximumForce": {
"description": "(Optional) - The maximum force that can be applied to the sample in N.",
"type": "number"
},
"otherAnvil": {
"description": "(Optional) - If 'anvil' was selected as 'Other' from the controlled list as it was not listed, please specify the name of the anvil with a description in this field.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"chamberName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"motorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchical level and direction of a motor.",
"properties": {
"motorDirection": {
"description": "(Required) - The direction of movement (for X,Y,Z,M motors) or axis of rotation (for rotating motors) expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the X-stage and perpendicular to the Y-stage. then beam direction = [1 0 0], X-stage-direction = [1 0 0] (positive movement direction away from source towards detector) or can be (-1 0 0) (towards source) and Y-stage-direction = [0 1 0] or can be [0 -1 0] (analogous interpretation). The parameters need to be individually determined for each instrument. For rotating motors, the directional vector of axis of rotation should be given in Cartesian coordinates (counterclockwise, right-hand rule).",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"motorLevel": {
"description": "(Required) - Hierarchy of the motor expressed as an integer.",
"type": "number"
}
},
"type": "object"
},
"motorPositions": {
"additionalProperties": false,
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the motor.",
"properties": {
"angles": {
"$ref": "#/$defs/angleSet",
"description": "(Optional) - The three tilt angles alpha, beta and gamma of the motors controlling the position of the item."
},
"xyzPositions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - The xyz coordinates describing the motor positions of the item."
}
},
"type": "object"
},
"optics": {
"additionalProperties": false,
"description": "(Optional) - Details about the optics and individual motor positions.",
"properties": {
"collimator": {
"additionalProperties": false,
"description": "(Optional) - Details about the collimator and its individual motor positions.",
"properties": {
"collimatorDetails": {
"description": "(Optional) - Details about the collimator relevant for the measurement.",
"type": "string"
},
"collimatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the collimator."
}
},
"type": "object"
},
"condenser": {
"additionalProperties": false,
"description": "(Optional) - Details about the condenser lens and its individual motor positions, if used.",
"properties": {
"condenserDetails": {
"description": "(Optional) - Details about the condenser relevant for the measurement.",
"type": "string"
},
"condenserPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the condenser."
}
},
"type": "object"
},
"fresnelZonePlate": {
"additionalProperties": false,
"description": "(Optional) - Details about the fresnel zone plate and its individual motor positions, if used.",
"properties": {
"fresnelZonePlateDetails": {
"description": "(Optional) - Details about the fresnel zone plate relevant for the measurement.",
"type": "string"
},
"fresnelZonePlatePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the fresnel zone plate."
}
},
"type": "object"
},
"monochromator": {
"additionalProperties": false,
"description": "(Required) - Details about the monochromator and individual motor positions, if used.",
"properties": {
"monochromatorDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the monochromator type type, material, energy and notes.",
"properties": {
"energy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Energy set in the monochromator. Typical unit - eV"
},
"material": {
"description": "(Optional) - Material of the monochromator.",
"type": "string"
},
"monochromatorType": {
"description": "(Optional) - Type of the monochromator.",
"type": "string"
},
"notes": {
"description": "(Optional) - Additional information about the monochromator relevant for the measurement."
}
},
"type": "object"
},
"monochromatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the monochromator."
},
"monochromatorUsed": {
"description": "(Required) - To be set to true if monochromator is used, else false.",
"type": "boolean"
}
},
"required": [
"monochromatorUsed"
],
"type": "object"
},
"phaseRing": {
"additionalProperties": false,
"description": "(Required) - Details about the phase ring and its individual motor positions, if inserted.",
"properties": {
"phaseRingDetails": {
"description": "(Optional) - Details about the phase ring relevant for the measurement.",
"type": "string"
},
"phaseRingPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the phase ring."
}
},
"type": "object"
}
},
"required": [
"monochromator"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes a parameter which can be split into number of pixels in x and y directions like the resolution",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm or \u00b5m, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "nm",
"description": "(Required) - the unit of the size of a single pixel (typical value - nm, \u00b5m) of datatype string",
"enum": [
"nm",
"\u00b5m"
],
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min, default value - max) of datatype string.",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"default": "W",
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW, default value - W) of datatype string.",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "Pa",
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"rampDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a rate at which temperature is increased or decreased.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K/min",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K/min, K/s)",
"enum": [
"K/min",
"K/s"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of temperature increase or decrease.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"reconstruction": {
"additionalProperties": false,
"description": "Data from one single reconstruction.",
"properties": {
"reconstructionDetails": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"additionalFilters": {
"beamHardeningCorrection": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"filterType": {
"description": "(Optional) - Type of the additional filter - Median or Gauss",
"enum": [
"Median",
"Gauss"
],
"type": "string"
},
"phaseRetrieval": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"ringFilter": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
}
},
"algorithm": {
"description": "(Required) - Algorithm used for reconstruction to be selected from FBP - Filtered Back Projection, ART - Algebraic Reconstruction Technique, 3dCT - 3D Computed Tomography and Gridrec.",
"enum": [
"FBP - Filtered Back Projection",
"ART - Algebraic Reconstruction Technique",
"3dCT - 3D Computed Tomography",
"Gridrec"
],
"type": "string"
},
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepthConversionMax": {
"description": "(Required) - Maximum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"bitDepthConversionMin": {
"description": "(Required) - Minimum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"hardwarePlatform": {
"description": "(Optional) - Hardware platform used for reconstruction to be selected between CPU and GPU.",
"enum": [
"CPU",
"GPU"
],
"type": "string"
},
"lastImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the last image for the reconstruction of the 3D Volume, typically an integer.",
"type": "string"
},
"projectionPadding": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the projection padding applied to the raw projection data to address certain issues in the reconstruction process.",
"properties": {
"paddingSize": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - Size of the projection padding used in pixels."
},
"paddingType": {
"description": "(Required) - Type of the projection padding used - Zero Padding, Linear Interpolation Padding, Sinc Interpolation Padding, Shepp-Logan Filtered Back Projection (SL-FBP), Gridding and Extended Field of View (FOV) Padding.",
"enum": [
"Zero Padding",
"Linear Interpolation Padding",
"Sinc Interpolation Padding",
"Shepp-Logan Filtered Back Projection (SL-FBP)",
"Gridding",
"Extended Field of View (FOV) Padding"
],
"type": "string"
}
},
"type": "object"
},
"reconstructionSoftware": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for reconstruction. It may be the same as the acquisition software or a different one."
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Scan angle at which the reconstruction of the 3D Volume starts. Typical unit - degree."
},
"startImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the start image for the reconstruction of the 3D Volume.",
"type": "string"
},
"tomographicProjectionFilter": {
"description": "(Optional) - Name of the tomographic projection filter used to be selected from Ram-Lak Filter, Butterworth Filter, Shepp-Logan Filter, Hann (Hanning) Filter, Gaussian Filter, Cosine Filter, Soft Filtration Method and Hard Filtration Method.",
"enum": [
"Ram-Lak Filter",
"Butterworth Filter",
"Shepp-Logan Filter",
"Hann (Hanning) Filter",
"Gaussian Filter",
"Cosine Filter",
"Soft Filtration Method",
"Hard Filtration Method"
],
"type": "string"
}
},
"required": [
"startImage",
"lastImage",
"startAngle",
"hardwarePlatform",
"algorithm",
"binning"
],
"type": "object"
},
"volumeStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each voxel in the 3D volume. The bit depth determines the number of possible intensity levels that can be assigned to each voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Required) - The dimension of the 3D volume in XYZ coordinates. If the length in Z dimension is not known and instead only the number of slices are known, they need to be separately entered in the field 'numberOfSlices'. Typical unit - \u00b5m."
},
"header": {
"additionalProperties": false,
"description": "(Optional) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Optional) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"name": {
"description": "(Required) - Name of the 3D volume structure (dataset).",
"type": "string"
},
"numberOfSlices": {
"description": "(Optional) - No. of slices which make up the 3D volume.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel/voxel, normally expressed in \u00b5m."
},
"volumeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry of the 3D reconstructed volume usually provided by the project or the laboratory."
}
},
"required": [
"name",
"dimensions",
"bitDepth",
"pixelSize"
],
"type": "object"
}
},
"required": [
"volumeStructure",
"reconstructionDetails"
],
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"samplePrepType": {
"additionalProperties": false,
"description": "(Optional) - Describes the sample preparation process.",
"properties": {
"preparationDate": {
"description": "(Optional) - Date of the sample preparation in the ISO 8601 format.",
"format": "date",
"type": "string"
},
"preparationDescription": {
"description": "(Optional) - Short description of the sample preparation.",
"type": "string"
},
"preparationID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the sample preparation."
}
},
"type": "object"
},
"sampleStage": {
"additionalProperties": false,
"description": "(Required) - Details about sample stage.",
"properties": {
"stageMotorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchy of the stage motors. This information is required to know how the motor movements affect the positions of the samples, particularly relevant for correlative characterization.",
"properties": {
"beamDirection": {
"description": "(Required) - The beam direction expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the Y-stage and perpendicular to the X-stage. then beam direction = [0 1 0].",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"mMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the M motor (stage) as a vector in cartesian coordiantes. The M motor is usually relevant only for SEM based CT. It is a special motor which counteracts the Z motor."
},
"rMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the R motor (stage) as a vector in cartesian coordiantes. R motor has rotation around z axis +1 (for anticlockwise)."
},
"tMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the T motor (stage) as a vector in cartesian coordiantes. The T motor is usually relevant only for SEM based CT."
},
"xMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the X motor (stage) as a vector in cartesian coordinates."
},
"yMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Y motor (stage) as a vector in cartesian coordinates."
},
"zMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Z motor (stage) as a vector in cartesian coordinates."
}
},
"required": [
"beamDirection",
"xMotor",
"yMotor",
"zMotor",
"rMotor"
],
"type": "object"
},
"stageMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the stage motors."
}
},
"required": [
"stageMotorHierarchy"
],
"type": "object"
},
"stageDetails": {
"additionalProperties": false,
"description": "describes the stage settings during a measurement.",
"properties": {
"coordinateReference": {
"default": "origin at centre of sample",
"description": "(Optional) - description of the reference used for defining the coordinates (for eg. - origin at centre of sample, distances from two edges, etc.)",
"type": "string"
},
"coordinates": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - the xyz coordinates of a point expressed separately as coordinateSet which allows entering each of the xyz coordinates along with their optional uncertainties. If correllation images (two reference spots) are available, the coordinates enable correlative microscopy and they need to be entered"
},
"eBeamWorkingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the distance at which the beam is focussed (when the sample is in focus, this will be the distance between the bottom end of the pole-piece of the objective lens and the sample) defined separately as distanceDetails, with the distance value, optional uncertainty, optional notes, optional qualifier and choice of units between nm, um, mm, cm and m"
},
"isCorrelationImage": {
"description": "(Optional) - Whether the image is used for correlating in xyz coordinates with another image? Check if true. If true the coordinates have to be entered for the sake of correlative characterization of datatype boolean",
"type": "boolean"
},
"preTilt": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - predefined angle of a tilted sample holder which is tilted by design defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"stageAlignmentDone": {
"description": "(Optional) - was stage alignment done? (check if true)",
"type": "boolean"
},
"stageTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the stage is actually tilted (Stage at T) defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"tiltCorrectionAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - angle used to correct the tilt of the sample defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"tiltCorrectionType": {
"default": "none",
"description": "(Optional) - the tilt correction type applied to the image to compensate for the tilting, for e.g., sample surface, cross-section, none or manual, default value- none of datatype string",
"type": "string"
}
},
"required": [
"eBeamWorkingDistance",
"stageTiltAngle"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5s",
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s default value - \u00b5s) of datatype string",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "kV",
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV default value - V) of datatype string.",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"voxelDetails": {
"additionalProperties": false,
"description": "describes the size of a voxel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "mm",
"description": "(Required) - the unit of the value of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The voxel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"weightDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a weight.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "\u00b5g",
"description": "(Required) - Unit of the value to be selected from a controlled list (ng, \u00b5g, mg, g, kg, default value - ug)",
"enum": [
"ng",
"\u00b5g",
"mg",
"g",
"kg"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the weight",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided. Contributors (in alphabetical order of last names): Alexey Boubnov, Rafaela Debastiani, Jonas Fell, Sarah Irvine, Reetu Elza Joseph",
"properties": {
"entry": {
"$ref": "#/$defs/entry"
}
},
"required": [
"entry"
],
"title": "lab_CT",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 885ac5abd4d6d00c2e90c9af0caae9257e15747d | 2024-03-05T21:45:52 | SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Unit) - the unit of the value to be selected from a controlled list (degree, radian).",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A).",
"enum": [
"pA",
"nA",
"uA",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"detectorDetails": {
"additionalProperties": false,
"description": "(Required) - describes the settings related to the detector with which the image set is acquired",
"properties": {
"detectorSettings": {
"$ref": "#/$defs/detectorSettings",
"description": "(Optional) - Settings of the specific detector used. E.g., the Everhart Thornley detector (ETD), is a secondary electron and back-scattered electron detector used in scanning electron microscopes, whihc has then particular settings"
},
"detectorType": {
"description": "(Required) - Type of the detector used",
"enum": [
"ETD",
"CDEM",
"CBS",
"ECD",
"External",
"GBSD",
"GSED",
"ICE",
"LFD",
"LVD",
"LVSED",
"None",
"STEM3",
"STEM3_GMode",
"STEM4",
"T1",
"T2",
"T3",
"TLD"
],
"type": "string"
},
"name": {
"description": "(Optional) - Name of the detector used",
"type": "string"
}
},
"required": [
"detectorType"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "describes the parameters of a detector such as the Everhart Thornley detector (ETD), which is a secondary electron and back-scattered electron detector used in scanning electron microscopes",
"properties": {
"brightness": {
"description": "(Optional) - A number indicating the brightness",
"type": "number"
},
"brightnessdB": {
"description": "(Optional) - Describes the brightness in dB",
"type": "number"
},
"contrast": {
"description": "(Optional) - A number indicating the contrast",
"type": "number"
},
"contrastdB": {
"description": "(Optional) - Describes the contrast in dB",
"type": "number"
},
"enhancedContrast": {
"description": "(Optional) - Describes the enhancement in contrast",
"type": "number"
},
"frontEndVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Bias voltage applied to the front end of the detector "
},
"grid": {
"description": "(Optional) - A number indicating the number of grid elements",
"type": "number"
},
"gridVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage applied to the grid "
},
"minimumDwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Minimum possible dwell time for the detector. IRI: https://purls.helmholtz-metadaten.de/EMG/00000006 "
},
"mix": {
"description": "(Optional) - Signals from different detectors can be overlaid (mixed) and this should, in theory, be the percentage of this detectors contribution to the end result.",
"type": "number"
},
"setting": {
"description": "(Optional) - In case of ETD, this is the bias voltage applied to the detector grid. Note that this block looks different for different detectors. ",
"type": "number"
},
"signal": {
"description": "(Optional) - The signal used for detection",
"enum": [
"SE",
"BSE",
"SI"
],
"type": "string"
}
},
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m).",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"eBeamDetails": {
"additionalProperties": false,
"description": "(Required) - Describes the configuration of the electron beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000007",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The potential difference between anode and cathode. The acceleration voltage adds kinetic energy to the particles of the beam. IRI: https://purls.helmholtz-metadaten.de/EMG/00000001 It is defined separately as voltageDetails, (includes the voltage value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - uV, mv, V, kV, MV)"
},
"apertureSetting": {
"additionalProperties": false,
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size (diameter) of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails."
}
},
"type": "object"
},
"beamCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Electrical current which flows along the beam path. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003 It is defined separately as currentDetails (includes the current value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)."
},
"dynamicFocusIsOn": {
"description": "(Optional) - To bet set true if dynamic focus is on. IRI:https://purls.helmholtz-metadaten.de/emg/00000039",
"type": "boolean"
},
"dynamicWDIsOn": {
"description": "(Optional) - To bet set true if dynamic working distance is on. IRI: https://purls.helmholtz-metadaten.de/EMG/00000026",
"type": "boolean"
},
"horizontalFieldWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual horizontal length scanned on the sample defined separately as distanceDetails."
},
"imageMode": {
"description": "(Optional) - The type of image mode used. Could be a text or number depending on the instrument.",
"type": "string"
},
"lensMode": {
"description": "(Optional) - The type of image mode used",
"enum": [
"Field-Free",
"Immersion",
"EDS"
],
"type": "string"
},
"magnificationCorrection": {
"description": "(Optional) - To bet set true if magnification correction is on",
"type": "boolean"
},
"preTilt ": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Sometimes, pre-tilted holders are used and the pretilt angle must be given in the acquisition software because actual tilt = stage tilt plus pretilt."
},
"scanRotation": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Angle by which beam scanning direction is rotated"
},
"tiltCorrectionAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - If the sample is tilted, the image is compressed in the vertical direction, i.e. the pixels are not isotropic anymore. Tilt correction adapts the line spacing of the scanning to compensate for this. IRI:https://purls.helmholtz-metadaten.de/emg/00000037"
},
"tiltCorrectionIsOn": {
"description": "(Optional) - To bet set true if tilt correction is on. IRI:https://purls.helmholtz-metadaten.de/emg/00000037",
"type": "boolean"
},
"verticalFieldWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual vertical length scanned on the sample defined separately as distanceDetails."
}
},
"required": [
"accelerationVoltage",
"verticalFieldWidth",
"horizontalFieldWidth",
"apertureSetting",
"scanRotation"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (nJ, mJ, J, kJ, eV, meV).",
"enum": [
"nJ",
"mJ",
"J",
"kJ",
"eV",
"meV"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"hotStageMEMSDetails": {
"additionalProperties": false,
"description": "describes the parameters related if a hot stage MEMS is used",
"properties": {
"actualTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Describes the actual Temperature measured in the hot stage MEMS"
},
"heatingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Describes the heating current used in the hot stage MEMS"
},
"heatingPower": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Describes the heating power used in the hot stage MEMS"
},
"heatingVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Describes the heating voltage used in the hot stage MEMS"
},
"sampleBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Describes the bias voltage applied to the sample in the hot stage MEMS"
},
"sampleResistance": {
"$ref": "#/$defs/resistanceDetails",
"description": "(Optional) - Describes the target Temperature used in the hot stage MEMS"
},
"targetTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Describes the target Temperature set in the hot stage MEMS"
}
},
"type": "object"
},
"iBeamDetails": {
"additionalProperties": false,
"description": "(Required) - Describes the configuration of the ion beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000016",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The potential difference between anode and cathode. The acceleration voltage adds kinetic energy to the particles of the beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000001 It is defined separately as voltageDetails, (includes the voltage value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - uV, mv, V, kV, MV)"
},
"millingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Electrical current used in SEM-FIB Tomography to mill/cut the sample. In this case this is the same as the beam current of the ion beam. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003 It is defined separately as currentDetails (includes the current value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)."
}
},
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"imageDetails": {
"additionalProperties": false,
"description": "(Required) - describes the settings related to imaging",
"properties": {
"digitalBrightness": {
"description": "(Required) - A number indicating the setting for digital brightness (a basic post-processing method)",
"type": "number"
},
"digitalContrast": {
"description": "(Required) - A number indicating the setting for digital contrast (a basic post-processing method)",
"type": "number"
},
"digitalGamma": {
"description": "(Required) - A number indicating the setting for digital Gamma (a basic post-processing method)",
"type": "number"
},
"driftcorrected": {
"description": "(Required) - To bet set true if drift correction is on",
"type": "boolean"
},
"numberOfPixels": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The number of x, y pixels of the image (Resolution), defined separately as pixelNumberType with separate entries for integer values of xPixels and yPixels"
},
"postprocessing": {
"description": "(Optional) - Describes the post-processing performed on the image",
"type": "string"
},
"transformation": {
"description": "(Optional) - Describes the transformations performed on the image",
"type": "string"
},
"zoomfactor": {
"description": "(Required) - A number indicating the zoom factor",
"type": "number"
}
},
"required": [
"digitalContrast",
"digitalBrightness",
"digitalGamma",
"numberOfPixels",
"driftcorrected",
"zoomfactor"
],
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"beamType": {
"description": "(Required) - The selected beam",
"enum": [
"EBeam",
"IBeam"
],
"type": "string"
},
"detector": {
"oneOf": [
{
"$ref": "#/$defs/detectorDetails",
"description": "(Required) - Details about the detector used for acquisition."
},
{
"description": "(Required) - Details about the detector(s) used for acquisition.",
"items": {
"$ref": "#/$defs/detectorDetails"
},
"minItems": 1,
"type": "array"
}
]
},
"eBeam": {
"$ref": "#/$defs/eBeamDetails",
"description": "(Optional) - Details about the electron beam"
},
"hotStageMEMS": {
"$ref": "#/$defs/hotStageMEMSDetails",
"description": "(Optional) - Pressure maintained inside the chamber (in which the sample is housed) during the measurement"
},
"iBeam": {
"$ref": "#/$defs/iBeamDetails",
"description": "(Optional) - Details about the ion beam"
},
"imaging": {
"$ref": "#/$defs/imageDetails",
"description": "(Optional) - Details about the imaging settings"
},
"numberOfDetectors": {
"description": "Number of detectors used for the acquisition",
"type": "number"
},
"scan": {
"$ref": "#/$defs/scanDetails",
"description": "(Required) - Details about the scan settings"
},
"spot": {
"description": "(Optional) - Qualitative index for beam current. Varies with current setting, i.e. 1.6 nA is spot = 1, 3.2 nA is spot = 2, 0.1 nA = spot =-3, so it can also be negative. May vary between different microscope models.",
"type": "number"
}
},
"required": [
"scan",
"imaging",
"detector"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes the resolution of the image split into number of pixels in x and y directions.",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "describes a power",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (\u00b5W, mW, W, kW, MW).",
"enum": [
"\u00b5W",
"mW",
"W",
"kW",
"MW"
],
"type": "string"
},
"value": {
"description": "(Required) - The power expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi).",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"resistanceDetails": {
"additionalProperties": false,
"description": "describes a resistance",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (abohm, ohm, k ohm, M ohm).",
"enum": [
"abohm",
"ohm",
"k ohm",
"M ohm"
],
"type": "string"
},
"value": {
"description": "(Required) - The resistance expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"scanDetails": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scan settings.",
"properties": {
"average": {
"description": "(Optional) - Number of images averaged at each slice",
"type": "number"
},
"dwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time period during which the beam remains on one position/stationary. IRI: https://purls.helmholtz-metadaten.de/EMG/00000006 "
},
"eScan": {
"additionalProperties": false,
"description": "gives settings pertaining to electron beam scan",
"properties": {
"lineAveraging": {
"description": "(Optional) - Number of lines averaged",
"type": "number"
},
"lineIntegration": {
"description": "(Optional) - Number of lines integrated",
"type": "number"
},
"lineTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) -Time period during which a line is fully scanned."
},
"mainsLock": {
"description": "(Optional) - To bet set true if mains lock is on",
"type": "boolean"
},
"scanInterlacing": {
"description": "(Optional) - Number of scans interlaced. This setting splits an imaging area into blocks defined by the number of lines (from 2 to 8). In the first instance, the first line of each block is scanned, then the second one, etc. This imaging method significantly reduces charging.",
"type": "number"
}
},
"type": "object"
},
"frameTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) -Time period during which a frame is fully scanned. IRI: https://purls.helmholtz-metadaten.de/EMG/00000014 "
},
"horizontalFieldSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the actual horizontal length scanned on the sample defined separately as distanceDetails"
},
"integrate": {
"description": "(Optional) - Number of images integrated at each slice",
"type": "number"
},
"internalScan": {
"description": "(Optional) - To bet set true if internal scan is on",
"type": "boolean"
},
"pixelHeight": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual width of a pixel"
},
"pixelWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual width of a pixel"
},
"scanType": {
"description": "(Optional) - The type of scan E-Scan or I-Scan",
"enum": [
"EScan",
"IScan"
],
"type": "string"
},
"verticalFieldSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the actual vertical length scanned on the sample defined separately as distanceDetails"
}
},
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF).",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time period. IRI:https://purls.helmholtz-metadaten.de/EMG/00000024",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (ps, ns, us, ms, s).",
"enum": [
"ps",
"ns",
"us",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (uV, mV, V, kV, MV, GV).",
"enum": [
"uV",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes a set of images acquired during the course of a SEM/FIB Tomography experiment. The images in each dataset is taken using a detector (SE, BSE, EDS, EBSD) using a specific configuration. This Schema contains only the parameters which are specific to the entire dataset. The parameters which are particular to each image is located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json. The units are by default to be considred as the SI units unless otherwise specified",
"properties": {
"columns": {
"description": "(Optional) - Number of column in the tiled image grab setting",
"type": "number"
},
"datasetType": {
"description": "(Optional) - To be selected from the enumerated list depending on the detector and the angle at which the sample is measured: * SEM Image * SEM Image 2 * EDS * EBSD * BSE * ISE * ISI * SI * InLens * SESI",
"enum": [
"SEM Image",
"SEM Image 2",
"SEM Image 3",
"SEM Image 4",
"SEM Image 5",
"EDS",
"EBSD",
"BSE",
"ISE Image",
"ISI Image",
"SI Image",
"InLens",
"SESI",
"FIB Image",
"FIB Multi-Detector Image-Q1",
"FIB Multi-Detector Image-Q2",
"SEM Multi-Detector Image-Q1",
"SEM Multi-Detector Image-Q2"
],
"type": "string"
},
"definition": {
"description": "(Optional)- Name of the schema to which this entry conforms. In this case, acquisition_dataset is to be written",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Identifier of the dataset. It could be the PID of location where the entire dataset is stored"
},
"images": {
"desription": "(Required) - Array containing the images and their specific parameters. No. of images in the array is described by the numberOfItems parameter at the entry level of this schema",
"items": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json"
},
"type": "array"
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings"
},
"numberOfItems": {
"description": "(Required) - Number of Items (images, files). Depends on the number of slices",
"type": "number"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required)- Details concerning the program (or software) used for aquisition"
},
"rows": {
"description": "(Optional) - Number of rows in the tiled image grab setting",
"type": "number"
},
"tileColumn": {
"description": "(Optional) - The selected column in the tiled image grab setting",
"type": "number"
},
"tileRow": {
"description": "(Optional) - The selected row in the tiled image grab setting",
"type": "number"
},
"user": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/user_description.json",
"description": "(Optional)- The contact information of the user responsible for the measurement"
}
},
"required": [
"program",
"instrument",
"datasetType",
"images",
"numberOfItems"
],
"title": "acquisition_dataset",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 09ac5b72fecab6b5a0008c4e0de1847a2f059be9 | 2024-03-05T21:14:20 | SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Unit) - the unit of the value to be selected from a controlled list (degree, radian).",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A).",
"enum": [
"pA",
"nA",
"uA",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"detectorDetails": {
"additionalProperties": false,
"description": "(Required) - describes the settings related to the detector with which the image set is acquired",
"properties": {
"detectorSettings": {
"$ref": "#/$defs/detectorSettings",
"description": "(Optional) - Settings of the specific detector used. E.g., the Everhart Thornley detector (ETD), is a secondary electron and back-scattered electron detector used in scanning electron microscopes, whihc has then particular settings"
},
"detectorType": {
"description": "(Required) - Type of the detector used",
"enum": [
"ETD",
"CDEM",
"CBS",
"ECD",
"External",
"GBSD",
"GSED",
"ICE",
"LFD",
"LVD",
"LVSED",
"None",
"STEM3",
"STEM3_GMode",
"STEM4",
"T1",
"T2",
"T3",
"TLD"
],
"type": "string"
},
"name": {
"description": "(Optional) - Name of the detector used",
"type": "string"
}
},
"required": [
"detectorType"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "describes the parameters of a detector such as the Everhart Thornley detector (ETD), which is a secondary electron and back-scattered electron detector used in scanning electron microscopes",
"properties": {
"brightness": {
"description": "(Optional) - A number indicating the brightness",
"type": "number"
},
"brightnessdB": {
"description": "(Optional) - Describes the brightness in dB",
"type": "number"
},
"contrast": {
"description": "(Optional) - A number indicating the contrast",
"type": "number"
},
"contrastdB": {
"description": "(Optional) - Describes the contrast in dB",
"type": "number"
},
"enhancedContrast": {
"description": "(Optional) - Describes the enhancement in contrast",
"type": "number"
},
"frontEndVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Bias voltage applied to the front end of the detector "
},
"grid": {
"description": "(Optional) - A number indicating the number of grid elements",
"type": "number"
},
"gridVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage applied to the grid "
},
"minimumDwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Minimum possible dwell time for the detector. IRI: https://purls.helmholtz-metadaten.de/EMG/00000006 "
},
"mix": {
"description": "(Optional) - Signals from different detectors can be overlaid (mixed) and this should, in theory, be the percentage of this detectors contribution to the end result.",
"type": "number"
},
"setting": {
"description": "(Optional) - In case of ETD, this is the bias voltage applied to the detector grid. Note that this block looks different for different detectors. ",
"type": "number"
},
"signal": {
"description": "(Optional) - The signal used for detection",
"enum": [
"SE",
"BSE",
"SI"
],
"type": "string"
}
},
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m).",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"eBeamDetails": {
"additionalProperties": false,
"description": "(Required) - Describes the configuration of the electron beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000007",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The potential difference between anode and cathode. The acceleration voltage adds kinetic energy to the particles of the beam. IRI: https://purls.helmholtz-metadaten.de/EMG/00000001 It is defined separately as voltageDetails, (includes the voltage value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - uV, mv, V, kV, MV)"
},
"apertureSetting": {
"additionalProperties": false,
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size (diameter) of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails."
}
},
"type": "object"
},
"beamCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Electrical current which flows along the beam path. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003 It is defined separately as currentDetails (includes the current value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)."
},
"dynamicFocusIsOn": {
"description": "(Optional) - To bet set true if dynamic focus is on. IRI:https://purls.helmholtz-metadaten.de/emg/00000039",
"type": "boolean"
},
"dynamicWDIsOn": {
"description": "(Optional) - To bet set true if dynamic working distance is on. IRI: https://purls.helmholtz-metadaten.de/EMG/00000026",
"type": "boolean"
},
"horizontalFieldWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual horizontal length scanned on the sample defined separately as distanceDetails."
},
"imageMode": {
"description": "(Optional) - The type of image mode used. Could be a text or number depending on the instrument.",
"type": "string"
},
"lensMode": {
"description": "(Optional) - The type of image mode used",
"enum": [
"Field-Free",
"Immersion",
"EDS"
],
"type": "string"
},
"magnificationCorrection": {
"description": "(Optional) - To bet set true if magnification correction is on",
"type": "boolean"
},
"preTilt ": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Sometimes, pre-tilted holders are used and the pretilt angle must be given in the acquisition software because actual tilt = stage tilt plus pretilt."
},
"scanRotation": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Angle by which beam scanning direction is rotated"
},
"tiltCorrectionAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - If the sample is tilted, the image is compressed in the vertical direction, i.e. the pixels are not isotropic anymore. Tilt correction adapts the line spacing of the scanning to compensate for this. IRI:https://purls.helmholtz-metadaten.de/emg/00000037"
},
"tiltCorrectionIsOn": {
"description": "(Optional) - To bet set true if tilt correction is on. IRI:https://purls.helmholtz-metadaten.de/emg/00000037",
"type": "boolean"
},
"verticalFieldWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual vertical length scanned on the sample defined separately as distanceDetails."
}
},
"required": [
"accelerationVoltage",
"verticalFieldWidth",
"horizontalFieldWidth",
"apertureSetting",
"scanRotation"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (nJ, mJ, J, kJ, eV, meV).",
"enum": [
"nJ",
"mJ",
"J",
"kJ",
"eV",
"meV"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"hotStageMEMSDetails": {
"additionalProperties": false,
"description": "describes the parameters related if a hot stage MEMS is used",
"properties": {
"actualTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Describes the actual Temperature measured in the hot stage MEMS"
},
"heatingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Describes the heating current used in the hot stage MEMS"
},
"heatingPower": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Describes the heating power used in the hot stage MEMS"
},
"heatingVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Describes the heating voltage used in the hot stage MEMS"
},
"sampleBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Describes the bias voltage applied to the sample in the hot stage MEMS"
},
"sampleResistance": {
"$ref": "#/$defs/resistanceDetails",
"description": "(Optional) - Describes the target Temperature used in the hot stage MEMS"
},
"targetTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Describes the target Temperature set in the hot stage MEMS"
}
},
"type": "object"
},
"iBeamDetails": {
"additionalProperties": false,
"description": "(Required) - Describes the configuration of the ion beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000016",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The potential difference between anode and cathode. The acceleration voltage adds kinetic energy to the particles of the beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000001 It is defined separately as voltageDetails, (includes the voltage value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - uV, mv, V, kV, MV)"
},
"millingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Electrical current used in SEM-FIB Tomography to mill/cut the sample. In this case this is the same as the beam current of the ion beam. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003 It is defined separately as currentDetails (includes the current value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)."
}
},
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"imageDetails": {
"additionalProperties": false,
"description": "(Required) - describes the settings related to imaging",
"properties": {
"digitalBrightness": {
"description": "(Required) - A number indicating the setting for digital brightness (a basic post-processing method)",
"type": "number"
},
"digitalContrast": {
"description": "(Required) - A number indicating the setting for digital contrast (a basic post-processing method)",
"type": "number"
},
"digitalGamma": {
"description": "(Required) - A number indicating the setting for digital Gamma (a basic post-processing method)",
"type": "number"
},
"driftcorrected": {
"description": "(Required) - To bet set true if drift correction is on",
"type": "boolean"
},
"numberOfPixels": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The number of x, y pixels of the image (Resolution), defined separately as pixelNumberType with separate entries for integer values of xPixels and yPixels"
},
"postprocessing": {
"description": "(Optional) - Describes the post-processing performed on the image",
"type": "string"
},
"transformation": {
"description": "(Optional) - Describes the transformations performed on the image",
"type": "string"
},
"zoomfactor": {
"description": "(Required) - A number indicating the zoom factor",
"type": "number"
}
},
"required": [
"digitalContrast",
"digitalBrightness",
"digitalGamma",
"numberOfPixels",
"driftcorrected",
"zoomfactor"
],
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"beamType": {
"description": "(Required) - The selected beam",
"enum": [
"EBeam",
"IBeam"
],
"type": "string"
},
"detector": {
"oneOf": [
{
"$ref": "#/$defs/detectorDetails",
"description": "(Required) - Details about the detector used for acquisition."
},
{
"description": "(Required) - Details about the detector(s) used for acquisition.",
"items": {
"$ref": "#/$defs/detectorDetails"
},
"minItems": 1,
"type": "array"
}
]
},
"eBeam": {
"$ref": "#/$defs/eBeamDetails",
"description": "(Required) - Details about the electron beam"
},
"hotStageMEMS": {
"$ref": "#/$defs/hotStageMEMSDetails",
"description": "(Optional) - Pressure maintained inside the chamber (in which the sample is housed) during the measurement"
},
"iBeam": {
"$ref": "#/$defs/iBeamDetails",
"description": "(Required) - Details about the ion beam"
},
"imaging": {
"$ref": "#/$defs/imageDetails",
"description": "(Optional) - Details about the imaging settings"
},
"numberOfDetectors": {
"description": "Number of detectors used for the acquisition",
"type": "number"
},
"scan": {
"$ref": "#/$defs/scanDetails",
"description": "(Required) - Details about the scan settings"
},
"spot": {
"description": "(Optional) - Qualitative index for beam current. Varies with current setting, i.e. 1.6 nA is spot = 1, 3.2 nA is spot = 2, 0.1 nA = spot =-3, so it can also be negative. May vary between different microscope models.",
"type": "number"
}
},
"required": [
"eBeam",
"scan",
"imaging",
"detector"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes the resolution of the image split into number of pixels in x and y directions.",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "describes a power",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (\u00b5W, mW, W, kW, MW).",
"enum": [
"\u00b5W",
"mW",
"W",
"kW",
"MW"
],
"type": "string"
},
"value": {
"description": "(Required) - The power expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi).",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"resistanceDetails": {
"additionalProperties": false,
"description": "describes a resistance",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (abohm, ohm, k ohm, M ohm).",
"enum": [
"abohm",
"ohm",
"k ohm",
"M ohm"
],
"type": "string"
},
"value": {
"description": "(Required) - The resistance expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"scanDetails": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scan settings.",
"properties": {
"average": {
"description": "(Optional) - Number of images averaged at each slice",
"type": "number"
},
"dwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time period during which the beam remains on one position/stationary. IRI: https://purls.helmholtz-metadaten.de/EMG/00000006 "
},
"eScan": {
"additionalProperties": false,
"description": "gives settings pertaining to electron beam scan",
"properties": {
"lineAveraging": {
"description": "(Optional) - Number of lines averaged",
"type": "number"
},
"lineIntegration": {
"description": "(Optional) - Number of lines integrated",
"type": "number"
},
"lineTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) -Time period during which a line is fully scanned."
},
"mainsLock": {
"description": "(Optional) - To bet set true if mains lock is on",
"type": "boolean"
},
"scanInterlacing": {
"description": "(Optional) - Number of scans interlaced. This setting splits an imaging area into blocks defined by the number of lines (from 2 to 8). In the first instance, the first line of each block is scanned, then the second one, etc. This imaging method significantly reduces charging.",
"type": "number"
}
},
"type": "object"
},
"frameTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) -Time period during which a frame is fully scanned. IRI: https://purls.helmholtz-metadaten.de/EMG/00000014 "
},
"horizontalFieldSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the actual horizontal length scanned on the sample defined separately as distanceDetails"
},
"integrate": {
"description": "(Optional) - Number of images integrated at each slice",
"type": "number"
},
"internalScan": {
"description": "(Optional) - To bet set true if internal scan is on",
"type": "boolean"
},
"pixelHeight": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual width of a pixel"
},
"pixelWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual width of a pixel"
},
"scanType": {
"description": "(Optional) - The type of scan E-Scan or I-Scan",
"enum": [
"EScan",
"IScan"
],
"type": "string"
},
"verticalFieldSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the actual vertical length scanned on the sample defined separately as distanceDetails"
}
},
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF).",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time period. IRI:https://purls.helmholtz-metadaten.de/EMG/00000024",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (ps, ns, us, ms, s).",
"enum": [
"ps",
"ns",
"us",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (uV, mV, V, kV, MV, GV).",
"enum": [
"uV",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes a set of images acquired during the course of a SEM/FIB Tomography experiment. The images in each dataset is taken using a detector (SE, BSE, EDS, EBSD) using a specific configuration. This Schema contains only the parameters which are specific to the entire dataset. The parameters which are particular to each image is located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json. The units are by default to be considred as the SI units unless otherwise specified",
"properties": {
"columns": {
"description": "(Optional) - Number of column in the tiled image grab setting",
"type": "number"
},
"datasetType": {
"description": "(Optional) - To be selected from the enumerated list depending on the detector and the angle at which the sample is measured: * SEM Image * SEM Image 2 * EDS * EBSD * BSE * ISE * ISI * SI * InLens * SESI",
"enum": [
"SEM Image",
"SEM Image 2",
"SEM Image 3",
"SEM Image 4",
"SEM Image 5",
"EDS",
"EBSD",
"BSE",
"ISE Image",
"ISI Image",
"SI Image",
"InLens",
"SESI",
"FIB Image",
"FIB Multi-Detector Image-Q1",
"FIB Multi-Detector Image-Q2",
"SEM Multi-Detector Image-Q1",
"SEM Multi-Detector Image-Q2"
],
"type": "string"
},
"definition": {
"description": "(Optional)- Name of the schema to which this entry conforms. In this case, acquisition_dataset is to be written",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Identifier of the dataset. It could be the PID of location where the entire dataset is stored"
},
"images": {
"desription": "(Required) - Array containing the images and their specific parameters. No. of images in the array is described by the numberOfItems parameter at the entry level of this schema",
"items": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json"
},
"type": "array"
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings"
},
"numberOfItems": {
"description": "(Required) - Number of Items (images, files). Depends on the number of slices",
"type": "number"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required)- Details concerning the program (or software) used for aquisition"
},
"rows": {
"description": "(Optional) - Number of rows in the tiled image grab setting",
"type": "number"
},
"tileColumn": {
"description": "(Optional) - The selected column in the tiled image grab setting",
"type": "number"
},
"tileRow": {
"description": "(Optional) - The selected row in the tiled image grab setting",
"type": "number"
},
"user": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/user_description.json",
"description": "(Optional)- The contact information of the user responsible for the measurement"
}
},
"required": [
"program",
"instrument",
"datasetType",
"images",
"numberOfItems"
],
"title": "acquisition_dataset",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 456b17000ec9ddfe6fd1811dc6cf84ee0465f205 | 2023-12-13T13:44:49 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"CTAquisition": {
"additionalProperties": false,
"description": "(Required) - Details about the acquisition.",
"properties": {
"acquisitionScriptName": {
"description": "(Required) - Name of the script used for acquisition.",
"type": "string"
},
"acquisitionTimePerProjection": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time taken for acquisition of a single projection. Typical unit - s."
},
"angularStepSize": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Step size of the rotation of the sample during the CT. Typical unit - degree."
},
"contrastType": {
"description": "(Required) - The contrast type(mode) used - Absorption Contrast or Phase Contrast. If 'Phase Contrast' is selected, please indicate the used Phase Contrast Mode under the field phaseContrastMode.",
"enum": [
"Absorption Contrast",
"Phase Contrast"
],
"type": "string"
},
"endAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - End angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then endAngle is 180\u00b0. Typical unit - degree."
},
"largeFOV": {
"description": "(Required) - To be set to true if large field of view or wide field of view is used.",
"type": "boolean"
},
"numberOfProjections": {
"description": "(Required) - Number of projections acquired during the CT.",
"type": "number"
},
"phaseContrastMode": {
"description": "(Optional) - The phase contrast mode used during acquisition - Zernike phase contrast, propagation-based, grating-based(Hartmann), grating-based(Talbot).",
"enum": [
"Zernike phase contrast",
"Propagation-based",
"Grating-based(Hartmann)",
"Grating-based(Talbot)"
],
"type": "string"
},
"referenceImages": {
"additionalProperties": false,
"description": "(Optional) - Details on the reference images (if used) - number of flats/bright images and number of dark images.",
"properties": {
"numberOfBrightImages": {
"description": "(Optional) - Number of flats or bright images used as reference.",
"type": "number"
},
"numberOfDarkImages": {
"description": "(Optional) - Number of dark images used as reference.",
"type": "number"
}
},
"type": "object"
},
"scanningMode": {
"description": "(Optional) - The scanning mode used during acquisition - helical, raster scanning, fast CT.",
"enum": [
"Helical",
"Raster Scanning",
"Fast CT"
],
"type": "string"
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Start angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then startAngle is -180\u00b0. Typical unit - degree."
},
"totalAcquisitionTime": {
"description": "(Required) - Time taken for acquisition for the entire scan. This is the total scan time, i.e. number of projections multipled by exposure time, but including read-out time. calculated as EndTime-StartTime. Format: hh:mm:ss.",
"format": "time",
"pattern": "^(\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?)$",
"type": "string"
},
"useBadPixelMap": {
"description": "(Optional) - To be set to true if bad pixel map is used. This parameter is relevant for SEM based CT.",
"type": "boolean"
}
},
"required": [
"acquisitionScriptName",
"startAngle",
"endAngle",
"angularStepSize",
"acquisitionTimePerProjection",
"totalAcquisitionTime",
"largeFOV",
"contrastType"
],
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "degree",
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"angleSet": {
"additionalProperties": false,
"description": "(Optional) - Tilt angles alpha, beta and gamma decribing the three angular positions of an item.",
"properties": {
"alpha": {
"description": "(Optional) - Tilt angle alpha of the item.",
"type": "number"
},
"anglesUnit": {
"default": "degree",
"description": "(Optional) - unit of the angles (allowed units - degree or radian)",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"beta": {
"description": "(Optional) - Rotation angle beta of the item.",
"type": "number"
},
"gamma": {
"description": "(Optional) - Angle gamma of the item.",
"type": "number"
}
},
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"default": "\u00b5m",
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "pA",
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string.",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"detectorDetails": {
"additionalProperties": false,
"description": "gives the settings of a detector.",
"properties": {
"componentGeometry": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - xyz coordinates describing the position of the detector defined separately as coordinateSet"
},
"detectorBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - bias voltage applied to the detector defined separately as voltageDetails. Allowed units nV, uV, mV, V, kV"
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector"
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - describes the details of the detector (manufacturerName, modelName and detectorID) as part of manufacturerDetails"
},
"detectorName": {
"description": "(Required) -Name of the detector of datatype string",
"type": "string"
},
"detectorType": {
"default": "Secondary Electron",
"description": "(Optional) - The type of detector (e.g., surface electron detection, secondary electron, back-scattered electron) of datatype string",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (YYYY-MM-DDThh:mm:ss.sss) in the ISO 8601 date-time format",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
}
},
"required": [
"detectorName"
],
"type": "object"
},
"detectorSetDetails": {
"additionalProperties": false,
"description": "gives information about signal mixing between two detectors and provides the information about the detector(s).",
"properties": {
"detector1": {
"$ref": "#/$defs/detectorDetails",
"description": "(Required) - gives the settings of one detector defined separately as detectorDetails; entering the details of at least one detector is compulsory"
},
"detector2": {
"$ref": "#/$defs/detectorDetails",
"description": "(Optional) - gives the settings of a second detector defined separately as detectorDetails"
},
"signalMixingDescription": {
"description": "(Optional) - Describes the purpose and technique of signal mixing of datatype string",
"type": "string"
},
"signalMixingDone": {
"default": false,
"description": "(Optional) - whether the detector signals are mixed, true or false, of datatype boolean",
"type": "boolean"
}
},
"required": [
"detector1"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"eBeamDecelerationDetails": {
"additionalProperties": false,
"description": "Details about deceleration of the e- beam.",
"properties": {
"landingEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Landing energy of the e-beam defined separately as energyDetails (allowed units - meV, eV, keV, nJ, mJ, J, kJ, MJ)"
},
"stageBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Bias voltage applied to the stage defined separately biasDetails (allowed units - nV, uV, mV, V, kV, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ; default value - keV) of datatype string",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"entry": {
"additionalProperties": false,
"description": "Required) - The entry level is the root element of the schema. It contains all the metadata describing a CT measurement.",
"properties": {
"consumables": {
"description": "Auxiliary entity used during Fabrication, Sample Preparation or Measurement which has a limited time capacity or is limited in its number of uses before it is disposed of, necessary to the process itself and normally bought from third party manufacturers. Examples are: gloves, syringes, wipes, etching solutions, glass slides, spatulas, weighing paper, two-sided tape.",
"items": {
"type": "string"
},
"type": "array"
},
"definition": {
"description": "(Optional) - Name of the schema to which this entry conforms. In this case, lab_CT should be written",
"type": "string"
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "entryID (Optional) - Identifier of the metadata entry usually provided by the project or the laboratory"
},
"equipment": {
"description": "(Optional) - Any kind of physical or virtual item, device, machine or other tools used to perform one or more Fabrication(s), Sample Preparation(s), Model Preparation(s), Data Acquisition(s) and/or any of the processes included in the Data Analysis Lifecycle. Usually, the Equipment is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. Equipment is usually an investment. According to this definition, an Instrument is a particular type of Equipment.",
"type": "string"
},
"experimentID": {
"$ref": "#/$defs/identifier",
"description": "entryID (Optional) - Identifier of the measurement usually provided by the project or the laboratory"
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings. Instrument is a physical or virtual identifiable piece of Equipment used to perform a Data Acquisition and to generate Raw Data. The Instrument is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. A virtual Instrument may be any computational resource or HPC infrastructure (cloud infrastructure or supercomputer) needed to perform Calculations or Simulations."
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure"
},
"measurementDescription": {
"description": "(Optional) - Description about the measurement.",
"type": "string"
},
"measurementPurpose": {
"description": "Measurement is experimental Data Acquisition, typically performed on a Sample using an experimental Technique. It may also be performed during Fabrication or Sample Preparation, e.g., to characterise the intermediate stages and/or the final resulting Precursor(s) or Sample(s), respectively. A Measurement may require the use of Consumables.",
"enum": [
"assessment (to given categories or values)",
"completeness check (presence or absence of given properties)",
"correlative characterization (dedicated sample treatment to emphasise given features)",
"exploratory (routine check of known properties)",
"feasibility (quick check, rough estimate)",
"high quality measurement (precise, careful treatment)",
"test specific hypothesis (focus only on given aspects)",
"other (please specify in the comment)"
],
"type": "string"
},
"parents": {
"items": {
"if": {
"properties": {
"parentType": {
"not": {
"const": "not applicable"
}
}
}
},
"properties": {
"parentReference": {
"anyOf": [
{
"format": "uri"
},
{
"format": "url"
}
],
"description": "If type is 'MetaStore URI' it is possible to easily fill this field in a later stage",
"type": "string"
},
"parentReferenceType": {
"enum": [
"plain text",
"external URL",
"MetaStore URI"
],
"type": "string"
},
"parentType": {
"enum": [
"not applicable",
"sample"
],
"type": "string"
}
},
"required": [
"parentType"
],
"then": {
"required": [
"parentReferenceType",
"parentReference"
]
},
"type": "object"
},
"type": "array"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition"
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format"
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"technique": {
"description": "(Optional) - Any experimental, theoretical or computational method used during Data Acquisition or during any of the processes included in the Data Analysis Lifecycle to acquire, process or analyse Research Data about a System or a set of them with an Instrument, whihc is used to generate this metadata.",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement",
"type": "string"
},
"user": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/user_description.json",
"description": "(Required)- The contact information of the user responsible for the measurement"
}
},
"required": [
"title",
"startTime",
"endTime",
"program",
"user",
"instrument",
"data"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/ time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min) default value - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"geometry": {
"additionalProperties": false,
"description": "Describes the geometry of the CT instrument",
"properties": {
"beamGeometry": {
"additionalProperties": false,
"description": "(Required) - Details about beam geometry like beam geometry type and divergence angle.",
"properties": {
"beamGeometryType": {
"description": "(Required) - The type of the beam geometry to be selected between 'collimated' and 'divergent'.",
"enum": [
"collimated",
"divergent"
],
"type": "string"
},
"divergenceAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Angle of divergence when the beam geometry is divergent. Typical unit - degree."
}
},
"type": "object"
},
"geometricMagnification": {
"description": "(Required) - Geometric magnification refers to the ratio of the size of an object's image to the size of the object itself. It is a measure of how much larger the image appears compared to the actual object. Geometric magnification (M) is calculated using the formula M = (SID + SOD) / SID, where SID is the source-to-image distance and SOD is the source-to-object distance.",
"type": "number"
},
"objectToDetectorDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the object and the detector. Typical unit - \u00b5m."
},
"opticalMagnification": {
"description": "(Required) - Optical magnification is calculated as the ratio of the focal length of the objective lens to the focal length of the eyepiece (if an eyepiece is present) in a traditional optical microscope.",
"type": "number"
},
"sourceToObjectDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the source and the object. Typical unit - \u00b5m."
}
},
"required": [
"sourceToObjectDistance",
"objectToDetectorDistance",
"beamGeometry",
"geometricMagnification",
"opticalMagnification"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"imagingDetails": {
"additionalProperties": false,
"description": "describes the imaging settings of the instrument during the measurement.",
"properties": {
"apertureSetting": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Optional) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). The element apertureSetting is defined separately as apertureSettingType which gives the option to choose between current or size. If the size can be set directly, then it is defined with the complex type distanceDetails, else if the aperture setting is controlled with the beam current defined separately as currentDetails"
},
"collectionMethod": {
"default": "normal scan",
"description": "(Optional) - the method of collection of the image, for e.g., normal scan, average of multiple images, integration of multiple images, default value - normal scan, of datatype string",
"type": "string"
},
"cycleTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - the time taken by the beam to scan a frame, defined separately as timeDetails. It is the time needed to scan a line times the number of lines in a frame."
},
"dwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - the dwell time of the beam per pixel, defined separately as timeDetails"
},
"dynamicFocus": {
"description": "(Optional) - To be set to true if dynamic focus is turned on, else false",
"type": "boolean"
},
"noiseReduction": {
"description": "(Optional) - The type of noise reduction used as an enumerated list of six parameters: Pixel Avg, Line Avg, Frame Avg, Pixel Int, Line Int, Frame Int.",
"enum": [
"Pixel Avg",
"Line Avg",
"Frame Avg",
"Pixel Int",
"Line Int",
"Frame Int"
],
"type": "string"
},
"numberOfPixels": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The number of x, y pixels of the image, defined separately as pixelNumberType with separate entries for integer values of xPixels and yPixels"
},
"pixelSize": {
"$ref": "#/$defs/pixelsize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel, normally expressed in nm/pixel, defined separately as pixelSize3D for the mapping along x,y and z directions, with each pixel having a pixelSize, optional uncertainty, optional qualifier and optional notes. The y-pixel-size is to be given only if it is different from the x-pixel-size, and z-pixel-size can be ignored if it is greater than voxel size"
},
"voxel": {
"$ref": "#/$defs/voxelDetails",
"description": "(Optional) - Size of the voxel in case 3D imaging is done for Energy-dispersive X-ray Spectroscopy or Electron-backscatter Diffraction, defined separately as voxelDetails"
}
},
"required": [
"numberOfPixels",
"pixelSize"
],
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"CTAquisition": {
"$ref": "#/$defs/CTAquisition",
"description": "(Optional) - Details regarding the acquisition."
},
"calibration": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the calibration and the scaling factor.",
"properties": {
"calibrationType": {
"description": "(Optional) - Type of calibration as a string.",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (YYYY-MM-DDThh:mm:ss.sss) in the ISO 8601 date-time format",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"systemScaling": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scaling factor.",
"properties": {
"adjustSystemScaling": {
"description": "(Required) - To be set to true if system scaling is adjusted, else false.",
"type": "boolean"
},
"measuredScalingFactor": {
"description": "(Optional) - Value of the measured scaling factor.",
"type": "number"
},
"referenceScalingFactor": {
"description": "(Optional) - Value of the reference scaling factor, determined ususally during the data processing.",
"type": "number"
}
},
"required": [
"adjustSystemScaling"
],
"type": "object"
}
},
"type": "object"
},
"detector": {
"$ref": "#/$defs/detectorDetails",
"description": "(Optional) - Details regarding the detector."
},
"focalSpotMode": {
"additionalProperties": false,
"description": "(Optional) - Option for setting the size of the focal spot. Some sources have the option to select the target spot size, or focal spot size absolutely by setting a value, while some others give the option of selecting 'small', 'medium' or 'large'. Smaller spot size = higher resolution. Note that the power/current will change with this value. In addition, the detector settings will usually be selected in conjunction. (different scintillator/lens/magnification).",
"properties": {
"selection": {
"description": "(Optional) - Selection of the setting of the size of the focal spot when the option for setting the size of the focal spot by selecting 'small', 'medium' or 'large' according to predefined values set by the manufacturer.",
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the target spot when the option for setting the size of the focal spot absolutely by setting a value is available."
}
},
"type": "object"
},
"geometry": {
"$ref": "#/$defs/geometry",
"description": "(Optional) - Details regarding the geometry."
},
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"optics": {
"$ref": "#/$defs/optics",
"description": "(Optional) - Details about the optics and individual motor positions."
},
"sampleStage": {
"$ref": "#/$defs/sampleStage",
"description": "(Optional) - Details regarding the sample stage."
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray target in an SEM based CT set-up.",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required) - Details of the pressure maintained in the chamber of the SEM."
},
"electronBeamShift": {
"additionalProperties": false,
"description": "(Required) - The distance by which the electron beam is shifted in the x and y directions.",
"properties": {
"xShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the x direction. Typical unit - \u00b5m."
},
"yShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xShift",
"yShift"
],
"type": "object"
},
"electronProbeCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required) - The electron current measured at the probe. Typical unit - \u00b5A."
},
"objectiveLensAperture": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). Typically the diameter of the aperture is set in \u00b5m."
},
"target": {
"additionalProperties": false,
"description": "(Required) - Details regarding the target in SEM based CT, which upon interaction with the e-beam produces the X-rays.",
"properties": {
"targetDriftCorrection": {
"description": "(Required) - If drift correction is activated for the target, this parameter has to be set to true.",
"type": "boolean"
},
"targetMaterial": {
"description": "(Required) - Material with which the target is made.",
"type": "string"
},
"targetShape": {
"description": "(Optional) - Description of the shape or geometry of the target. e.g. - bulk, foil, needle.",
"type": "string"
},
"targetThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Thickness of the target (dimension in Z direction). Default unit - \u00b5m."
},
"targetTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the target is tilted. Typical unit - degree."
}
},
"required": [
"targetMaterial",
"targetThickness",
"targetDriftCorrection",
"targetTiltAngle",
"targetCurrent"
],
"type": "object"
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. In SEM based CT, the beam is focussed on the target material which emits the X-rays upon interaction with the electrons. Default unit - \u00b5m."
}
},
"required": [
"chamberPressure",
"electronBeamShift",
"workingDistance",
"objectiveLensAperture",
"electronProbeCurrent",
"target"
],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
},
"targetCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current measured at the X-ray target, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"sourceDrift": {
"additionalProperties": false,
"description": "(Optional) - Distance by which the source is shifted during the measurement (i.e., end position - start position).",
"properties": {
"xDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the x direction. Typical unit - \u00b5m."
},
"yDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xDrift",
"yDrift"
],
"type": "object"
},
"sourcePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the source."
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray enrgy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source",
"focalSpotMode",
"CTAquisition",
"geometry",
"sampleStage",
"detector"
],
"type": "object"
},
"lifetimeDetails": {
"additionalProperties": false,
"description": "describes a lifetime.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5Ah",
"description": "(Required) - the unit of the value (default value - \u00b5Ah) of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The lifetime of the source expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer.",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"bioReactor": {
"additionalProperties": false,
"description": "(Optional) - Details of an in situ bioreactor.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in sterile conditions.",
"type": "boolean"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is decreased. Typical unit - K/min."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is increased, typically in K/min."
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"anvil": {
"description": "(Optional) - The type of anvil used in the in situ load frame (stage) for applying a particular type of force on the sample. Option to be selected from a controlled list consisting of - Compression, Diamond indentation 90\u00b0 cone, Diamond indentation cube corner, Diamond indentation wedge, Tension, Other. If 'Other' is selected, specify the name of the anvil with a description in the field 'otherAnvil'.",
"enum": [
"Compression",
"Diamond indentation 90\u00b0 cone",
"Diamond indentation cube corner",
"Diamond indentation wedge",
"Tension",
"Other"
],
"type": "string"
},
"blindAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - ed by the load frame(stage). Example: for a CT normally scanned over 180\u00b0 (e.g. -90\u00b0/+90\u00b0), a blind angle of 40\u00b0 due to the in situ cell implies that only 180\u00b0-40\u00b0=140\u00b0 (e.g. -70\u00b0/70\u00b0) is visible. NOTE: for a CT normally scanned over 360\u00b0 (e.g. -180\u00b0/+180\u00b0), a blind angle of 40\u00b0 would require the subtraction of the blind angle twice, implying two scan ranges of 140\u00b0 each (e.g. -160\u00b0/-20\u00b0 and +20\u00b0/+160\u00b0). Typical unit - degree."
},
"displacement": {
"additionalProperties": false,
"description": "(Optional) - Specification on how displacement is applied on the sample. Either 'displacementRate' in \u00b5m/min or 'displacementIncrement' in \u00b5m/acquisition need to be selected.",
"properties": {
"displacementIncrement": {
"description": "(Optional) - The step at which displacement is changed per acquisition in \u00b5m/acquisition.",
"type": "number"
},
"displacementRate": {
"description": "(Optional) - The rate at which displacement is applied on the sample in \u00b5m/min.",
"type": "number"
}
},
"type": "object"
},
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame or anvil (e.g. - size of anvil) relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
},
"maximumDisplacement": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - The maximum displacement allowed in the selected configuration. Typical unit - \u00b5m."
},
"maximumForce": {
"description": "(Optional) - The maximum force that can be applied to the sample in N.",
"type": "number"
},
"otherAnvil": {
"description": "(Optional) - If 'anvil' was selected as 'Other' from the controlled list as it was not listed, please specify the name of the anvil with a description in this field.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"chamberName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"motorHeirarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchical level and direction of a motor.",
"properties": {
"motorDirection": {
"description": "(Required) - The direction of movement (for X,Y,Z,M motors) or axis of rotation (for rotating motors) expressed as a vector in cartesian coordinates. e.g. - [-2.1 3.0 4.5].",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"motorLevel": {
"description": "(Required) - Hierarchy of the motor expressed as an integer.",
"type": "number"
}
},
"type": "object"
},
"motorPositions": {
"additionalProperties": false,
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the motor.",
"properties": {
"angles": {
"$ref": "#/$defs/angleSet",
"description": "(Optional) - The three tilt angles alpha, beta and gamma of the motors controlling the position of the item."
},
"xyzPositions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - The xyz coordinates decribing the motor positions of the item."
}
},
"type": "object"
},
"optics": {
"additionalProperties": false,
"description": "(Optional) - Details about the optics and individual motor positions.",
"properties": {
"collimator": {
"additionalProperties": false,
"description": "(Optional) - Details about the collimator and its individual motor positions.",
"properties": {
"collimatorDetails": {
"description": "(Optional) - Details about the collimator relevant for the measurement.",
"type": "string"
},
"collimatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the collimator."
}
},
"type": "object"
},
"condenser": {
"additionalProperties": false,
"description": "(Optional) - Details about the condenser lens and its individual motor positions, if used.",
"properties": {
"condenserDetails": {
"description": "(Optional) - Details about the condenser relevant for the measurement.",
"type": "string"
},
"condenserPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the condenser."
}
},
"type": "object"
},
"fresnelZonePlate": {
"additionalProperties": false,
"description": "(Optional) - Details about the fresnel zone plate and its individual motor positions, if used.",
"properties": {
"fresnelZonePlateDetails": {
"description": "(Optional) - Details about the fresnel zone plate relevant for the measurement.",
"type": "string"
},
"fresnelZonePlatePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the fresnel zone plate."
}
},
"type": "object"
},
"monochromator": {
"additionalProperties": false,
"description": "(Required) - Details about the monochromator and individual motor positions, if used.",
"properties": {
"monochromatorDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the monochromator type type, material, energy and notes.",
"properties": {
"energy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Energy set in the monochromator. Typical unit - eV"
},
"material": {
"description": "(Optional) - Material of the monochromator.",
"type": "string"
},
"monochromatorType": {
"description": "(Optional) - Type of the monochromator.",
"type": "string"
},
"notes": {
"description": "(Optional) - Additional information about the monochromator relevant for the measurement."
}
},
"type": "object"
},
"monochromatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the monochromator."
},
"monochromatorUsed": {
"description": "(Required) - To be set to true if monochromator is used, else false.",
"type": "boolean"
}
},
"required": [
"monochromatorUsed"
],
"type": "object"
},
"phaseRing": {
"additionalProperties": false,
"description": "(Required) - Details about the phase ring and its individual motor positions, if inserted.",
"properties": {
"phaseRingDetails": {
"description": "(Optional) - Details about the phase ring relevant for the measurement.",
"type": "string"
},
"phaseRingPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the phase ring."
}
},
"type": "object"
}
},
"required": [
"monochromator"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes the resolution of the image split into number of pixels in x and y directions.",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "nm/pixel",
"description": "(Required) - the unit of the value (default value - nm/pixel) of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"pixelsize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm/pixel, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min, default value - max) of datatype string.",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"default": "W",
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW, default value - W) of datatype string.",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "Pa",
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"rampDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a rate at which temperature is increased or decreased.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K/min",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K/min, K/s)",
"enum": [
"K/min",
"K/s"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of temperature increase or decrease.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"samplePrepType": {
"additionalProperties": false,
"description": "(Optional) - Describes the sample preparation process.",
"properties": {
"preparationDate": {
"description": "(Optional) - Date of the sample preparation in the ISO 8601 format.",
"format": "date",
"type": "string"
},
"preparationDescription": {
"description": "(Optional) - Short description of the sample preparation.",
"type": "string"
},
"preparationID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the sample preparation."
}
},
"type": "object"
},
"sampleStage": {
"additionalProperties": false,
"description": "(Required) - Details about sample stage.",
"properties": {
"stageMotorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchy of the stage motors. This information is required to know how the motor movements affect the positions of the samples, particularly relevant for correlative characterization.",
"properties": {
"beamDirection": {
"description": "(Required) - The beam direction expressed as a vector in cartesian coordinates. e.g. - [-2.1 3.0 4.5].",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"mMotor": {
"$ref": "#/$defs/motorHeirarchy",
"description": "(Optional) - Heirarchical level and direction of the M motor as a vector in cartesian coordiantes. The M motor is usually relevant only for SEM based CT. It is a special motor which counteracts the Z motor."
},
"rMotor": {
"$ref": "#/$defs/motorHeirarchy",
"description": "(Required) - Heirarchical level and direction of the R motor as a vector in cartesian coordiantes. R motor has rotation around z axis +1 (for anticlockwise)."
},
"tMotor": {
"$ref": "#/$defs/motorHeirarchy",
"description": "(Optional) - Heirarchical level and direction of the T motor as a vector in cartesian coordiantes. The T motor is usually relevant only for SEM based CT."
},
"xMotor": {
"$ref": "#/$defs/motorHeirarchy",
"description": "(Required) - Heirarchical level and direction of the X motor as a vector in cartesian coordiantes."
},
"yMotor": {
"$ref": "#/$defs/motorHeirarchy",
"description": "(Required) - Heirarchical level and direction of the Y motor as a vector in cartesian coordiantes."
},
"zMotor": {
"$ref": "#/$defs/motorHeirarchy",
"description": "(Required) - Heirarchical level and direction of the Z motor as a vector in cartesian coordiantes."
}
},
"required": [
"beamDirection",
"xMotor",
"yMotor",
"zMotor",
"rMotor"
],
"type": "object"
},
"stageMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the stage motors."
}
},
"required": [
"stageMotorHierarchy"
],
"type": "object"
},
"stageDetails": {
"additionalProperties": false,
"description": "describes the stage settings during a measurement.",
"properties": {
"coordinateReference": {
"default": "origin at centre of sample",
"description": "(Optional) - description of the reference used for defining the coordinates (for eg. - origin at centre of sample, distances from two edges, etc.)",
"type": "string"
},
"coordinates": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - the xyz coordinates of a point expressed separately as coordinateSet which allows entering each of the xyz coordinates along with their optional uncertainties. If correllation images (two reference spots) are available, the coordinates enable correlative microscopy and they need to be entered"
},
"eBeamWorkingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the distance at which the beam is focussed (when the sample is in focus, this will be the distance between the bottom end of the pole-piece of the objective lens and the sample) defined separately as distanceDetails, with the distance value, optional uncertainty, optional notes, optional qualifier and choice of units between nm, um, mm, cm and m"
},
"isCorrelationImage": {
"description": "(Optional) - Whether the image is used for correlating in xyz coordinates with another image? Check if true. If true the coordinates have to be entered for the sake of correlative characterization of datatype boolean",
"type": "boolean"
},
"preTilt": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - predefined angle of a tilted sample holder which is tilted by design defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"stageAlignmentDone": {
"description": "(Optional) - was stage alignment done? (check if true)",
"type": "boolean"
},
"stageTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the stage is actually tilted (Stage at T) defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"tiltCorrectionAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - angle used to correct the tilt of the sample defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"tiltCorrectionType": {
"default": "none",
"description": "(Optional) - the tilt correction type applied to the image to compensate for the tilting, for e.g., sample surface, cross-section, none or manual, default value- none of datatype string",
"type": "string"
}
},
"required": [
"eBeamWorkingDistance",
"stageTiltAngle"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5s",
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s default value - \u00b5s) of datatype string",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "kV",
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV default value - V) of datatype string.",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"voxelDetails": {
"additionalProperties": false,
"description": "describes the size of a voxel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "mm",
"description": "(Required) - the unit of the value of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The voxel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"weightDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a weight.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "\u00b5g",
"description": "(Required) - Unit of the value to be selected from a controlled list (ng, \u00b5g, mg, g, kg, default value - ug)",
"enum": [
"ng",
"\u00b5g",
"mg",
"g",
"kg"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the weight",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided. Contributors (in alphabetical order of last names): Alexey Boubnov, Rafaela Debastiani, Jonas Fell, Sarah Irvine, Reetu Elza Joseph",
"properties": {
"entry": {
"$ref": "#/$defs/entry"
}
},
"required": [
"entry"
],
"title": "lab_CT",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 520c2b69ed33ae1a3b51e98cfd9cf8e1b2b5c24f | 2023-12-14T15:02:52 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"CTAquisition": {
"additionalProperties": false,
"description": "(Required) - Details about the acquisition.",
"properties": {
"acquisitionScriptName": {
"description": "(Required) - Name of the script used for acquisition.",
"type": "string"
},
"acquisitionTimePerProjection": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time taken for acquisition of a single projection. Typical unit - s."
},
"angularStepSize": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Step size of the rotation of the sample during the CT. Typical unit - degree."
},
"contrastType": {
"description": "(Required) - The contrast type(mode) used - Absorption Contrast or Phase Contrast. If 'Phase Contrast' is selected, please indicate the used Phase Contrast Mode under the field phaseContrastMode.",
"enum": [
"Absorption Contrast",
"Phase Contrast"
],
"type": "string"
},
"endAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - End angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then endAngle is 180\u00b0. Typical unit - degree."
},
"largeFOV": {
"description": "(Required) - To be set to true if large field of view or wide field of view is used.",
"type": "boolean"
},
"numberOfProjections": {
"description": "(Required) - Number of projections acquired during the CT.",
"type": "number"
},
"phaseContrastMode": {
"description": "(Optional) - The phase contrast mode used during acquisition - Zernike phase contrast, propagation-based, grating-based(Hartmann), grating-based(Talbot).",
"enum": [
"Zernike phase contrast",
"Propagation-based",
"Grating-based(Hartmann)",
"Grating-based(Talbot)"
],
"type": "string"
},
"referenceImages": {
"additionalProperties": false,
"description": "(Optional) - Details on the reference images (if used) - number of flats/bright images and number of dark images.",
"properties": {
"numberOfBrightImages": {
"description": "(Optional) - Number of flats or bright images used as reference.",
"type": "number"
},
"numberOfDarkImages": {
"description": "(Optional) - Number of dark images used as reference.",
"type": "number"
}
},
"type": "object"
},
"scanningMode": {
"description": "(Optional) - The scanning mode used during acquisition - helical, raster scanning, fast CT.",
"enum": [
"Helical",
"Raster Scanning",
"Fast CT"
],
"type": "string"
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Start angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then startAngle is -180\u00b0. Typical unit - degree."
},
"totalAcquisitionTime": {
"description": "(Required) - Time taken for acquisition for the entire scan. This is the total scan time, i.e. number of projections multipled by exposure time, but including read-out time. calculated as EndTime-StartTime. Format: hh:mm:ss.",
"format": "time",
"pattern": "^(\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?)$",
"type": "string"
},
"useBadPixelMap": {
"description": "(Optional) - To be set to true if bad pixel map is used. This parameter is relevant for SEM based CT.",
"type": "boolean"
}
},
"required": [
"acquisitionScriptName",
"startAngle",
"endAngle",
"angularStepSize",
"acquisitionTimePerProjection",
"totalAcquisitionTime",
"largeFOV",
"contrastType"
],
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "degree",
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"angleSet": {
"additionalProperties": false,
"description": "(Optional) - Tilt angles alpha, beta and gamma decribing the three angular positions of an item.",
"properties": {
"alpha": {
"description": "(Optional) - Tilt angle alpha of the item.",
"type": "number"
},
"anglesUnit": {
"default": "degree",
"description": "(Optional) - unit of the angles (allowed units - degree or radian)",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"beta": {
"description": "(Optional) - Rotation angle beta of the item.",
"type": "number"
},
"gamma": {
"description": "(Optional) - Angle gamma of the item.",
"type": "number"
}
},
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"default": "\u00b5m",
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "pA",
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string.",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"data": {
"additionalProperties": false,
"description": "(Required) - Details about the data section of the measurement.",
"properties": {
"projections": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"cropping": {
"additionalProperties": false,
"description": "(Optional) - Details about cropping or clipping to select a region of interest(ROI).",
"properties": {
"ROI": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The size of the region of interest (ROI) in integer values of xPixels and yPixels."
},
"offset": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The offset applied to the origin (i.e., centre of the image) to select the region of interest in x and y coordinates."
}
},
"required": [
"ROI",
"offset"
],
"type": "object"
},
"projectionImageDataStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the data structure of the image data of the projections.",
"properties": {
"IOValue": {
"description": "(Required) - The IO value obtained from the metadata.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The dimension of the image as for integer values of xPixels and yPixels."
},
"fileLocation": {
"description": "(Required) - The location where the data file is stored. A URL is preferred if available.",
"type": "string"
},
"greyValueRepresentation": {
"description": "(Optional) - Description about the grey value representation.",
"type": "string"
},
"header": {
"additionalProperties": false,
"description": "(Required) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Required) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"imageCorrection": {
"additionalProperties": false,
"description": "(Optional) - Details about the image correction.",
"properties": {
"isImageCorrected": {
"description": "(Required) - To be set as true if image is corrected.",
"type": "boolean"
},
"linkToReferenceImages": {
"description": "(Required) - Link to the reference images (flats/darks).",
"format": "uri-reference",
"type": "string"
}
},
"required": [
"isImageCorrected",
"linkToReferenceImages"
],
"type": "object"
},
"imageFormats": {
"additionalProperties": false,
"description": "(Required) - The file formats of the images - tiff, png, jpeg. When more than one file formats are there, then the formats are to be entered as an array of strings.",
"properties": {
"fileFormats": {
"oneOf": [
{
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
{
"items": {
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
"type": "array"
}
]
}
},
"required": [
"fileFormats"
],
"type": "object"
},
"imageID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the Image Data."
},
"isPreFiltered": {
"description": "(Optional) - To be set as true if image is prefiltered.",
"type": "boolean"
},
"name": {
"description": "(Required) - Name of the Projection Image Data.",
"type": "string"
},
"numberOfImages": {
"description": "(Required) - Number of images in the data set. It is same as the number of projections.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical x,y length imaged by a single pixel, normally expressed in \u00b5m."
}
},
"required": [
"fileLocation",
"name",
"imageFormats",
"header"
],
"type": "object"
}
},
"required": [
"projectionImageDataStructure"
],
"type": "object"
},
"reconstructedData": {
"additionalProperties": false,
"description": "(Required) - Details about the reconstructed slices. When multiple reconstructions of the same raw data (projections) are present, the corresponding data can be combined as an array of reconstruction data sets, else as a single reconstruction data set.",
"properties": {
"reconstruction": {
"oneOf": [
{
"$ref": "#/$defs/reconstruction"
},
{
"items": {
"$ref": "#/$defs/reconstruction"
},
"type": "array"
}
]
}
},
"required": [
"reconstruction"
],
"type": "object"
}
},
"required": [
"projections",
"reconstructedData"
],
"type": "object"
},
"detector": {
"additionalProperties": false,
"description": "gives the settings of a detector or multiple detectors.",
"properties": {
"detectorSettings": {
"oneOf": [
{
"$ref": "#/$defs/detectorSettings"
},
{
"items": {
"$ref": "#/$defs/detectorSettings"
},
"type": "array"
}
]
}
},
"required": [
"detectorSettings"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "(Required) - Gives the settings of a single detector.",
"properties": {
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each pixel or voxel in an image. The bit depth determines the number of possible intensity levels that can be assigned to each pixel or voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"cameraGain": {
"description": "(Optional) - The amplification (gain) of the signal from an image sensor in a camera.",
"type": "number"
},
"detectorCoolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Cooling temperature of the detector, if it cooled. Relevant for SEM based CT. Typical unit - K."
},
"detectorDimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Optional) - The dimensions of the detector in integer values of xPixels and yPixels."
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector."
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the detector (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"detectorMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - The motor positions of the detector in cartesian coordinates and tilt angles."
},
"detectorName": {
"description": "(Optional) - Name of the detector of datatype string.",
"type": "string"
},
"detectorPixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical length in cartesian coordinates imaged by a single pixel of the detector. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"detectorType": {
"description": "(Optional) - The type of detector to be selected from a controlled list consisting of CCD, Panel, PCXD, CMOS, Time-Delay Integration (TDI) and Direct Conversion.",
"enum": [
"CCD",
"Panel",
"PCXD",
"CMOS",
"Time-Delay Integration (TDI)",
"Direct Conversion"
],
"type": "string"
},
"energyThreshold": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - A specific energy level used to filter the detected radiation."
},
"exposureTimePerFrame": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Time for which the sample is exposed per frame. Typical unit - s."
},
"frameSkip": {
"additionalProperties": false,
"description": "(Optional) - A numerical representation indicating the number of frames that are skipped or omitted during the acquisition or recording process. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3. If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped.",
"properties": {
"value": {
"oneOf": [
{
"description": "(Optional) - Number of frames skipped during acquisition. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3.",
"type": "number"
},
{
"description": "(Optional) - Pattern of frames skipped during acquisition. E.g. - If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped like [1,3,5]",
"items": {
"type": "number"
},
"type": "array"
}
]
}
},
"type": "object"
},
"framesPerSecond": {
"description": "(Optional) - The number of frames captured in a second.",
"type": "number"
},
"imagePixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical length in cartesian coordinates imaged by a single pixel of the image. It is the native pixel size divided by the total magnification. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"lens": {
"additionalProperties": false,
"description": "(Optional) - Details of a lens, if used with the detector.",
"properties": {
"hasLens": {
"description": "(Required) - To be set to true if the detector has a lens.",
"type": "boolean"
},
"lensFocalLength": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Focal length of the lens."
},
"lensID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the lens."
},
"lensMagnification": {
"description": "(Optional) - Magnification of the lens as a floating point number.",
"type": "number"
},
"lensManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the lens (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"lensName": {
"description": "(Optional) - Name of the lens of datatype string.",
"type": "string"
}
},
"required": [
"lensMagnification",
"lensFocalLength"
],
"type": "object"
},
"numberOfAveragedFramesPerProjection": {
"description": "(Optional) - The number of averaged frames per projection, if averaging is done.",
"type": "number"
},
"sensor": {
"additionalProperties": false,
"description": "(Optional) - Details about a sensor, if present.",
"properties": {
"hasSensor": {
"description": "(Required) - To be set to true if the detector has a sensor.",
"type": "boolean"
},
"sensorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the sensor."
},
"sensorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the sensor (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"sensorMaterial": {
"description": "(Optional) - Material of the sensor of datatype string.",
"type": "string"
},
"sensorName": {
"description": "(Optional) - Name of the sensor of datatype string.",
"type": "string"
},
"sensorThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the sensor."
},
"sensorType": {
"description": "(Optional) - The type of sensor as a string.",
"type": "string"
}
},
"required": [
"hasSensor"
],
"type": "object"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Temperature of the detector."
},
"totalCountsPerProjection": {
"description": "(Optional) - The sum of the intensity values recorded by the X-ray detector for a single projection during a scan.",
"type": "number"
}
},
"required": [
"detectorType",
"detectorManufacturer",
"binning",
"detectorMotorPositions",
"imagePixelSize"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ; default value - keV) of datatype string",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"entry": {
"additionalProperties": false,
"description": "Required) - The entry level is the root element of the schema. It contains all the metadata describing a CT measurement.",
"properties": {
"consumables": {
"description": "(Optional) - Auxiliary entity used during Fabrication, Sample Preparation or Measurement which has a limited time capacity or is limited in its number of uses before it is disposed of, necessary to the process itself and normally bought from third party manufacturers. Examples are: gloves, syringes, wipes, etching solutions, glass slides, spatulas, weighing paper, two-sided tape.",
"items": {
"type": "string"
},
"type": "array"
},
"data": {
"$ref": "#/$defs/data",
"description": "(Optional)- Details concerning the data section of the measurement."
},
"definition": {
"description": "(Required) - Name of the schema to which this entry conforms. In this case, lab_CT should be written.",
"type": "string"
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry usually provided by the project or the laboratory."
},
"equipment": {
"description": "(Optional) - Any kind of physical or virtual item, device, machine or other tools used to perform one or more Fabrication(s), Sample Preparation(s), Model Preparation(s), Data Acquisition(s) and/or any of the processes included in the Data Analysis Lifecycle. Usually, the Equipment is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. Equipment is usually an investment. According to this definition, an Instrument is a particular type of Equipment.",
"type": "string"
},
"experimentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the measurement usually provided by the project or the laboratory."
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings. Instrument is a physical or virtual identifiable piece of Equipment used to perform a Data Acquisition and to generate Raw Data. The Instrument is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. A virtual Instrument may be any computational resource or HPC infrastructure (cloud infrastructure or supercomputer) needed to perform Calculations or Simulations."
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure."
},
"measurementDescription": {
"description": "(Optional) - Description about the measurement.",
"type": "string"
},
"measurementPurpose": {
"description": "(Required) - Measurement is experimental Data Acquisition, typically performed on a Sample using an experimental Technique. It may also be performed during Fabrication or Sample Preparation, e.g., to characterise the intermediate stages and/or the final resulting Precursor(s) or Sample(s), respectively. A Measurement may require the use of Consumables.",
"enum": [
"assessment (to given categories or values)",
"completeness check (presence or absence of given properties)",
"correlative characterization (dedicated sample treatment to emphasise given features)",
"exploratory (routine check of known properties)",
"feasibility (quick check, rough estimate)",
"high quality measurement (precise, careful treatment)",
"test specific hypothesis (focus only on given aspects)",
"other (please specify in the comment)"
],
"type": "string"
},
"parents": {
"description": "(Required) - Parents of this metadata like the metadata document of the sample with which the measurement was performed.",
"items": {
"if": {
"properties": {
"parentType": {
"not": {
"const": "not applicable"
}
}
}
},
"properties": {
"parentReference": {
"description": "If type is 'MetaStore URI' it is possible to easily fill this field in a later stage",
"format": "uri-reference",
"type": "string"
},
"parentReferenceType": {
"enum": [
"plain text",
"external URL",
"MetaStore URI"
],
"type": "string"
},
"parentType": {
"enum": [
"not applicable",
"sample"
],
"type": "string"
}
},
"required": [
"parentType"
],
"then": {
"required": [
"parentReferenceType",
"parentReference"
]
},
"type": "object"
},
"type": "array"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition."
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format."
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"technique": {
"description": "(Required) - Any experimental, theoretical or computational method used during Data Acquisition or during any of the processes included in the Data Analysis Lifecycle to acquire, process or analyse Research Data about a System or a set of them with an Instrument, whihc is used to generate this metadata.",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement.",
"type": "string"
},
"user": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/user_description.json",
"description": "(Required)- The contact information of the user responsible for the measurement."
}
},
"required": [
"title",
"technique",
"definition",
"parents",
"measurementPurpose",
"startTime",
"endTime",
"program",
"user",
"instrument",
"data"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min) default value - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"geometry": {
"additionalProperties": false,
"description": "Describes the geometry of the CT instrument",
"properties": {
"beamGeometry": {
"additionalProperties": false,
"description": "(Required) - Details about beam geometry like beam geometry type and divergence angle.",
"properties": {
"beamGeometryType": {
"description": "(Required) - The type of the beam geometry to be selected between 'collimated' and 'divergent'.",
"enum": [
"collimated",
"divergent"
],
"type": "string"
},
"divergenceAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Angle of divergence when the beam geometry is divergent. Typical unit - degree."
}
},
"type": "object"
},
"geometricMagnification": {
"description": "(Required) - Geometric magnification refers to the ratio of the size of an object's image to the size of the object itself. It is a measure of how much larger the image appears compared to the actual object. Geometric magnification (M) is calculated using the formula M = (SID + SOD) / SID, where SID is the source-to-image distance and SOD is the source-to-object distance.",
"type": "number"
},
"objectToDetectorDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the object and the detector. Typical unit - \u00b5m."
},
"opticalMagnification": {
"description": "(Required) - Optical magnification is calculated as the ratio of the focal length of the objective lens to the focal length of the eyepiece (if an eyepiece is present) in a traditional optical microscope.",
"type": "number"
},
"sourceToObjectDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the source and the object. Typical unit - \u00b5m."
}
},
"required": [
"sourceToObjectDistance",
"objectToDetectorDistance",
"beamGeometry",
"geometricMagnification",
"opticalMagnification"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"CTAquisition": {
"$ref": "#/$defs/CTAquisition",
"description": "(Optional) - Details regarding the acquisition."
},
"calibration": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the calibration and the scaling factor.",
"properties": {
"calibrationType": {
"description": "(Optional) - Type of calibration as a string.",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (YYYY-MM-DDThh:mm:ss.sss) in the ISO 8601 date-time format",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"systemScaling": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scaling factor.",
"properties": {
"adjustSystemScaling": {
"description": "(Required) - To be set to true if system scaling is adjusted, else false.",
"type": "boolean"
},
"measuredScalingFactor": {
"description": "(Optional) - Value of the measured scaling factor.",
"type": "number"
},
"referenceScalingFactor": {
"description": "(Optional) - Value of the reference scaling factor, determined ususally during the data processing.",
"type": "number"
}
},
"required": [
"adjustSystemScaling"
],
"type": "object"
}
},
"type": "object"
},
"detector": {
"$ref": "#/$defs/detector",
"description": "(Optional) - Details regarding the detector."
},
"focalSpotMode": {
"additionalProperties": false,
"description": "(Optional) - Option for setting the size of the focal spot. Some sources have the option to select the target spot size, or focal spot size absolutely by setting a value, while some others give the option of selecting 'small', 'medium' or 'large'. Smaller spot size = higher resolution. Note that the power/current will change with this value. In addition, the detector settings will usually be selected in conjunction. (different scintillator/lens/magnification).",
"properties": {
"selection": {
"description": "(Optional) - Selection of the setting of the size of the focal spot when the option for setting the size of the focal spot by selecting 'small', 'medium' or 'large' according to predefined values set by the manufacturer.",
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the target spot when the option for setting the size of the focal spot absolutely by setting a value is available."
}
},
"type": "object"
},
"geometry": {
"$ref": "#/$defs/geometry",
"description": "(Optional) - Details regarding the geometry."
},
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"optics": {
"$ref": "#/$defs/optics",
"description": "(Optional) - Details about the optics and individual motor positions."
},
"sampleStage": {
"$ref": "#/$defs/sampleStage",
"description": "(Optional) - Details regarding the sample stage."
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray target in an SEM based CT set-up.",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required) - Details of the pressure maintained in the chamber of the SEM."
},
"electronBeamShift": {
"additionalProperties": false,
"description": "(Required) - The distance by which the electron beam is shifted in the x and y directions.",
"properties": {
"xShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the x direction. Typical unit - \u00b5m."
},
"yShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xShift",
"yShift"
],
"type": "object"
},
"electronProbeCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required) - The electron current measured at the probe. Typical unit - \u00b5A."
},
"objectiveLensAperture": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). Typically the diameter of the aperture is set in \u00b5m."
},
"target": {
"additionalProperties": false,
"description": "(Required) - Details regarding the target in SEM based CT, which upon interaction with the e-beam produces the X-rays.",
"properties": {
"targetDriftCorrection": {
"description": "(Required) - If drift correction is activated for the target, this parameter has to be set to true.",
"type": "boolean"
},
"targetMaterial": {
"description": "(Required) - Material with which the target is made.",
"type": "string"
},
"targetShape": {
"description": "(Optional) - Description of the shape or geometry of the target. e.g. - bulk, foil, needle.",
"type": "string"
},
"targetThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Thickness of the target (dimension in Z direction). Default unit - \u00b5m."
},
"targetTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the target is tilted. Typical unit - degree."
}
},
"required": [
"targetMaterial",
"targetThickness",
"targetDriftCorrection",
"targetTiltAngle",
"targetCurrent"
],
"type": "object"
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. In SEM based CT, the beam is focussed on the target material which emits the X-rays upon interaction with the electrons. Default unit - \u00b5m."
}
},
"required": [
"chamberPressure",
"electronBeamShift",
"workingDistance",
"objectiveLensAperture",
"electronProbeCurrent",
"target"
],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
},
"targetCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current measured at the X-ray target, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"sourceDrift": {
"additionalProperties": false,
"description": "(Optional) - Distance by which the source is shifted during the measurement (i.e., end position - start position).",
"properties": {
"xDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the x direction. Typical unit - \u00b5m."
},
"yDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xDrift",
"yDrift"
],
"type": "object"
},
"sourcePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the source."
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray enrgy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source",
"focalSpotMode",
"CTAquisition",
"geometry",
"sampleStage",
"detector"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer.",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"bioReactor": {
"additionalProperties": false,
"description": "(Optional) - Details of an in situ bioreactor.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in sterile conditions.",
"type": "boolean"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is decreased. Typical unit - K/min."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is increased, typically in K/min."
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"anvil": {
"description": "(Optional) - The type of anvil used in the in situ load frame (stage) for applying a particular type of force on the sample. Option to be selected from a controlled list consisting of - Compression, Diamond indentation 90\u00b0 cone, Diamond indentation cube corner, Diamond indentation wedge, Tension, Other. If 'Other' is selected, specify the name of the anvil with a description in the field 'otherAnvil'.",
"enum": [
"Compression",
"Diamond indentation 90\u00b0 cone",
"Diamond indentation cube corner",
"Diamond indentation wedge",
"Tension",
"Other"
],
"type": "string"
},
"blindAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - ed by the load frame(stage). Example: for a CT normally scanned over 180\u00b0 (e.g. -90\u00b0/+90\u00b0), a blind angle of 40\u00b0 due to the in situ cell implies that only 180\u00b0-40\u00b0=140\u00b0 (e.g. -70\u00b0/70\u00b0) is visible. NOTE: for a CT normally scanned over 360\u00b0 (e.g. -180\u00b0/+180\u00b0), a blind angle of 40\u00b0 would require the subtraction of the blind angle twice, implying two scan ranges of 140\u00b0 each (e.g. -160\u00b0/-20\u00b0 and +20\u00b0/+160\u00b0). Typical unit - degree."
},
"displacement": {
"additionalProperties": false,
"description": "(Optional) - Specification on how displacement is applied on the sample. Either 'displacementRate' in \u00b5m/min or 'displacementIncrement' in \u00b5m/acquisition need to be selected.",
"properties": {
"displacementIncrement": {
"description": "(Optional) - The step at which displacement is changed per acquisition in \u00b5m/acquisition.",
"type": "number"
},
"displacementRate": {
"description": "(Optional) - The rate at which displacement is applied on the sample in \u00b5m/min.",
"type": "number"
}
},
"type": "object"
},
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame or anvil (e.g. - size of anvil) relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
},
"maximumDisplacement": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - The maximum displacement allowed in the selected configuration. Typical unit - \u00b5m."
},
"maximumForce": {
"description": "(Optional) - The maximum force that can be applied to the sample in N.",
"type": "number"
},
"otherAnvil": {
"description": "(Optional) - If 'anvil' was selected as 'Other' from the controlled list as it was not listed, please specify the name of the anvil with a description in this field.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the vacuum chamber relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the vacuum chamber relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the vacuum chamber."
},
"chamberName": {
"description": "(Optional) - Name of the vacuum chamber.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"motorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchical level and direction of a motor.",
"properties": {
"motorDirection": {
"description": "(Required) - The direction of movement (for X,Y,Z,M motors) or axis of rotation (for rotating motors) expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the X-stage and perpendicular to the Y-stage. then beam direction = [1 0 0], X-stage-direction = [1 0 0] (positive movement direction away from source towards detector) or can be (-1 0 0) (towards source) and Y-stage-direction = [0 1 0] or can be [0 -1 0] (analogous interpretation). The parameters need to be individually determined for each instrument. For rotating motors, the directional vector of axis of rotation should be given in Cartesian coordinates (counterclockwise, right-hand rule).",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"motorLevel": {
"description": "(Required) - Hierarchy of the motor expressed as an integer.",
"type": "number"
}
},
"type": "object"
},
"motorPositions": {
"additionalProperties": false,
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the motor.",
"properties": {
"angles": {
"$ref": "#/$defs/angleSet",
"description": "(Optional) - The three tilt angles alpha, beta and gamma of the motors controlling the position of the item."
},
"xyzPositions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - The xyz coordinates describing the motor positions of the item."
}
},
"type": "object"
},
"optics": {
"additionalProperties": false,
"description": "(Optional) - Details about the optics and individual motor positions.",
"properties": {
"collimator": {
"additionalProperties": false,
"description": "(Optional) - Details about the collimator and its individual motor positions.",
"properties": {
"collimatorDetails": {
"description": "(Optional) - Details about the collimator relevant for the measurement.",
"type": "string"
},
"collimatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the collimator."
}
},
"type": "object"
},
"condenser": {
"additionalProperties": false,
"description": "(Optional) - Details about the condenser lens and its individual motor positions, if used.",
"properties": {
"condenserDetails": {
"description": "(Optional) - Details about the condenser relevant for the measurement.",
"type": "string"
},
"condenserPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the condenser."
}
},
"type": "object"
},
"fresnelZonePlate": {
"additionalProperties": false,
"description": "(Optional) - Details about the fresnel zone plate and its individual motor positions, if used.",
"properties": {
"fresnelZonePlateDetails": {
"description": "(Optional) - Details about the fresnel zone plate relevant for the measurement.",
"type": "string"
},
"fresnelZonePlatePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the fresnel zone plate."
}
},
"type": "object"
},
"monochromator": {
"additionalProperties": false,
"description": "(Required) - Details about the monochromator and individual motor positions, if used.",
"properties": {
"monochromatorDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the monochromator type type, material, energy and notes.",
"properties": {
"energy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Energy set in the monochromator. Typical unit - eV"
},
"material": {
"description": "(Optional) - Material of the monochromator.",
"type": "string"
},
"monochromatorType": {
"description": "(Optional) - Type of the monochromator.",
"type": "string"
},
"notes": {
"description": "(Optional) - Additional information about the monochromator relevant for the measurement."
}
},
"type": "object"
},
"monochromatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the monochromator."
},
"monochromatorUsed": {
"description": "(Required) - To be set to true if monochromator is used, else false.",
"type": "boolean"
}
},
"required": [
"monochromatorUsed"
],
"type": "object"
},
"phaseRing": {
"additionalProperties": false,
"description": "(Required) - Details about the phase ring and its individual motor positions, if inserted.",
"properties": {
"phaseRingDetails": {
"description": "(Optional) - Details about the phase ring relevant for the measurement.",
"type": "string"
},
"phaseRingPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the phase ring."
}
},
"type": "object"
}
},
"required": [
"monochromator"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes a parameter which can be split into number of pixels in x and y directions like the resolution",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm or \u00b5m, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "nm",
"description": "(Required) - the unit of the size of a single pixel (typical value - nm, \u00b5m) of datatype string",
"enum": [
"nm",
"\u00b5m"
],
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min, default value - max) of datatype string.",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"default": "W",
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW, default value - W) of datatype string.",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "Pa",
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"rampDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a rate at which temperature is increased or decreased.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K/min",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K/min, K/s)",
"enum": [
"K/min",
"K/s"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of temperature increase or decrease.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"reconstruction": {
"additionalProperties": false,
"description": "Data from one single reconstruction.",
"properties": {
"reconstructionDetails": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"additionalFilters": {
"beamHardeningCorrection": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"filterType": {
"description": "(Optional) - Type of the additional filter - Median or Gauss",
"enum": [
"Median",
"Gauss"
],
"type": "string"
},
"phaseRetrieval": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"ringFilter": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
}
},
"algorithm": {
"description": "(Required) - Algorithm used for reconstruction to be selected from FBP - Filtered Back Projection, ART - Algebraic Reconstruction Technique, 3dCT - 3D Computed Tomography and Gridrec.",
"enum": [
"FBP - Filtered Back Projection",
"ART - Algebraic Reconstruction Technique",
"3dCT - 3D Computed Tomography",
"Gridrec"
],
"type": "string"
},
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepthConversionMax": {
"description": "(Required) - Maximum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"bitDepthConversionMin": {
"description": "(Required) - Minimum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"hardwarePlatform": {
"description": "(Optional) - Hardware platform used for reconstruction to be selected between CPU and GPU.",
"enum": [
"CPU",
"GPU"
],
"type": "string"
},
"lastImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the last image for the reconstruction of the 3D Volume, typically an integer.",
"type": "string"
},
"projectionPadding": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the projection padding applied to the raw projection data to address certain issues in the reconstruction process.",
"properties": {
"paddingSize": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - Size of the projection padding used in pixels."
},
"paddingType": {
"description": "(Required) - Type of the projection padding used - Zero Padding, Linear Interpolation Padding, Sinc Interpolation Padding, Shepp-Logan Filtered Back Projection (SL-FBP), Gridding and Extended Field of View (FOV) Padding.",
"enum": [
"Zero Padding",
"Linear Interpolation Padding",
"Sinc Interpolation Padding",
"Shepp-Logan Filtered Back Projection (SL-FBP)",
"Gridding",
"Extended Field of View (FOV) Padding"
],
"type": "string"
}
},
"type": "object"
},
"reconstructionSoftware": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for reconstruction. It may be the same as the acquisition software or a different one."
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Scan angle at which the reconstruction of the 3D Volume starts. Typical unit - degree."
},
"startImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the start image for the reconstruction of the 3D Volume.",
"type": "string"
},
"tomographicProjectionFilter": {
"description": "(Optional) - Name of the tomographic projection filter used to be selected from Ram-Lak Filter, Butterworth Filter, Shepp-Logan Filter, Hann (Hanning) Filter, Gaussian Filter, Cosine Filter, Soft Filtration Method and Hard Filtration Method.",
"enum": [
"Ram-Lak Filter",
"Butterworth Filter",
"Shepp-Logan Filter",
"Hann (Hanning) Filter",
"Gaussian Filter",
"Cosine Filter",
"Soft Filtration Method",
"Hard Filtration Method"
],
"type": "string"
}
},
"required": [
"startImage",
"lastImage",
"startAngle",
"hardwarePlatform",
"algorithm",
"binning"
],
"type": "object"
},
"volumeStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each voxel in the 3D volume. The bit depth determines the number of possible intensity levels that can be assigned to each voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Required) - The dimension of the 3D volume in XYZ coordinates. If the length in Z dimension is not known and instead only the number of slices are known, they need to be separately entered in the field 'numberOfSlices'. Typical unit - \u00b5m."
},
"header": {
"additionalProperties": false,
"description": "(Optional) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Optional) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"name": {
"description": "(Required) - Name of the 3D volume structure (dataset).",
"type": "string"
},
"numberOfSlices": {
"description": "(Optional) - No. of slices which make up the 3D volume.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel/voxel, normally expressed in \u00b5m."
},
"volumeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry of the 3D reconstructed volume usually provided by the project or the laboratory."
}
},
"required": [
"name",
"dimensions",
"bitDepth",
"pixelSize"
],
"type": "object"
}
},
"required": [
"volumeStructure",
"reconstructionDetails"
],
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"sampleStage": {
"additionalProperties": false,
"description": "(Required) - Details about sample stage.",
"properties": {
"stageMotorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchy of the stage motors. This information is required to know how the motor movements affect the positions of the samples, particularly relevant for correlative characterization.",
"properties": {
"beamDirection": {
"description": "(Required) - The beam direction expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the Y-stage and perpendicular to the X-stage. then beam direction = [0 1 0].",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"mMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the M motor (stage) as a vector in cartesian coordiantes. The M motor is usually relevant only for SEM based CT. It is a special motor which counteracts the Z motor."
},
"rMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the R motor (stage) as a vector in cartesian coordiantes. R motor has rotation around z axis +1 (for anticlockwise)."
},
"tMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the T motor (stage) as a vector in cartesian coordiantes. The T motor is usually relevant only for SEM based CT."
},
"xMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the X motor (stage) as a vector in cartesian coordinates."
},
"yMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Y motor (stage) as a vector in cartesian coordinates."
},
"zMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Z motor (stage) as a vector in cartesian coordinates."
}
},
"required": [
"beamDirection",
"xMotor",
"yMotor",
"zMotor",
"rMotor"
],
"type": "object"
},
"stageMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the stage motors."
}
},
"required": [
"stageMotorHierarchy"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5s",
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s default value - \u00b5s) of datatype string",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "kV",
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV default value - V) of datatype string.",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided. Contributors (in alphabetical order of last names): Alexey Boubnov, Rafaela Debastiani, Jonas Fell, Sarah Irvine, Reetu Elza Joseph.",
"properties": {
"entry": {
"$ref": "#/$defs/entry"
}
},
"required": [
"entry"
],
"title": "lab_CT",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 6399a829d6b478b27d31e729b1dcaadf617a64a9 | 2023-12-05T16:22:29 | SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "degree",
"description": "(Optional) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (pA, nA, \u00b5A, mA, A)",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the current",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "Pa",
"description": "(Optional) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"stage": {
"additionalProperties": false,
"description": "Describes the stage.",
"properties": {
"activeStage": {
"description": "(Required)- Describes the stage in use",
"type": "string"
},
"specTilt": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional)- Pretilt of the sample, usually due to pretilted holder."
},
"stageM": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional)- M coordinate of the position of the stage (additional translation axis available in Zeiss instruments)"
},
"stageR": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Angle by which the stage is rotated"
},
"stageTa": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Tilt angle alpha of the stage"
},
"stageTb": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Tilt angle beta of the stage"
},
"stageX": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- X coordinate of the position of the stage"
},
"stageY": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Y coordinate of the position of the stage"
},
"stageZ": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Z coordinate of the position of the stage"
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. IRI: https://purls.helmholtz-metadaten.de/EMG/00000026"
}
},
"required": [
"workingDistance",
"stageX",
"stageY",
"stageZ",
"stageR",
"stageTa",
"stageTb",
"activeStage"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"vacuum": {
"additionalProperties": false,
"description": "Describes the vacuum maintained in the system.",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- The pressure maintained in the electron chamber"
},
"gas": {
"description": "(Required)- The gas used in the electron chamber",
"type": "string"
},
"humidity": {
"description": "(Required)- Describes the humidity in the chamber during the measurement",
"type": "string"
},
"userMode": {
"description": "(Required)- The type of vacuum slected by the user",
"enum": [
"High vacuum",
"Medium vacuum",
"Low vacuum"
],
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes an individual image acquired during the course of a SEM/FIB Tomography experiment. Each image is taken using a detector (SE, BSE, EDS, EBSD) at each slice cut using FIB. This Schema contains only the parameters which are specific to the individual image. The parameters which are common to the entire set are described by another schema which describes the dataset as a whole and is located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json.",
"properties": {
"creationTime": {
"description": "(Required)- Time of creation of the image",
"format": "date-time",
"pattern": "(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z)",
"type": "string"
},
"definition": {
"description": "(Optional)- Name of the schema to which this entry conforms. In this case, acquisition_image should be written",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Identifier of the image produced by the machine"
},
"fileLink": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Link to the location of the image"
},
"fileName": {
"description": "(Optional)- File name of the image",
"type": "string"
},
"specimenCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional)- Current measured on the specimen during acquisition of the image"
},
"stage": {
"$ref": "#/$defs/stage",
"description": "(Required)- Details concerning stage settings used for aquisition"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional)- Temperature of the sample during acquisition"
},
"vacuum": {
"$ref": "#/$defs/vacuum",
"description": "(Required)- Details concerning the vacuum during aquisition"
}
},
"required": [
"creationTime",
"stage",
"vacuum"
],
"title": "acquisition_image",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | a6c14209fe71debfa246dbfba23a5c933fba6343 | 2024-01-12T12:31:45 | SEM-FIB_Tomography/SEM_FIB_Tomography_Acquisition_Main.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"acquisition": {
"additionalProperties": false,
"description": "The entry level is the root element of the schema. It contains all the metadata describing an acquisition as part of an SEM/FIB Tomography measurement which might include multiple detectors.",
"properties": {
"dataset": {
"description": "Array of all the dataset-metadata acquired using multiple detetors",
"items": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json"
},
"type": "array"
},
"genericMetadata": {
"additionalProperties": false,
"description": "Describes all the generic metadata common to the acquisition",
"properties": {
"ESEM": {
"description": "To be set to true if environmental SEM is used",
"type": "boolean"
},
"angleToEBeam": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - angle between e-beam and i-beam defined separately as angleDetails (Allowed units: degree, radian). It is specified by the manufacturer and a property of the geometry of the instrument."
},
"applicationID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Details concerning the program (or software) used for aquisition"
},
"column": {
"description": "The name of the column used in the instrument",
"type": "string"
},
"eucentricWorkingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "The Working Distance when the smaple is at the eucentric height"
},
"fileVersion": {
"description": "The file version of the measurement data of the project",
"type": "string"
},
"millingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "The total height of the area which is cut into slices in the z dimension. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003"
},
"millingLocationDepth": {
"$ref": "#/$defs/distanceDetails",
"description": "The total width of the area which is cut into slices in the y dimension"
},
"millingLocationHeight": {
"$ref": "#/$defs/distanceDetails",
"description": "The total height of the area which is cut into slices in the z dimension"
},
"millingLocationWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "The total width of the area which is cut into slices in the x dimension"
},
"millingLocationX": {
"$ref": "#/$defs/distanceDetails",
"description": "X coordinate begin of the milling location from the origin."
},
"millingLocationY": {
"$ref": "#/$defs/distanceDetails",
"description": "Y coordinate of the begin of the milling location from the origin."
},
"millingMaterial": {
"description": "Material which is milled",
"type": "string"
},
"numberOfCuts": {
"description": "The number of slices into which the sample is cut during the course of the SEM/FIB Tomography",
"type": "number"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Optional)- Details concerning the program (or software) used for aquisition"
},
"projectDescription": {
"description": "Description about the project containing the acquistion datasets",
"type": "string"
},
"projectID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Details concerning the program (or software) used for aquisition"
},
"projectName": {
"description": "The name of the project containing the acquistion datasets",
"type": "string"
},
"pump": {
"description": "The name of the pump used in the instrument",
"type": "string"
},
"source": {
"description": "The type of the source used in the instrument. The source is a physical part of an electron or ion microscope from which the particles that form the beam are emitted. IRI: https://purls.helmholtz-metadaten.de/EMG/00000021",
"type": "string"
},
"stage": {
"description": "The dimensions of the stage used in the instrument",
"type": "string"
},
"systemType": {
"description": "Describes the system type used - the name of the instrument",
"type": "string"
},
"userDescription": {
"description": "Additional description provided by the user about the measurement or the sample",
"type": "string"
},
"zCutSpacing": {
"$ref": "#/$defs/distanceDetails",
"description": "The spacing between individual slices in z dimension"
}
},
"required": [
"angleToEBeam",
"zCutSpacing",
"projectName",
"applicationID",
"program"
],
"type": "object"
}
},
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min)",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (degree, radian).",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A).",
"enum": [
"pA",
"nA",
"uA",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m).",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_Acquisition_Main.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes the entire acquisition process during an SEM_FIB_Tomography measurement. The acquisition comprises of multiple datasets which are described using the schema located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json. The images in each dataset is taken using a detector (SE, BSE, EDS, EBSD) using a specific configuration. Each image is described by the schema located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json. The units are by default to be considered as the SI units unless otherwise specified",
"properties": {
"acquisition": {
"$ref": "#/$defs/acquisition"
}
},
"required": [
"acquisition"
],
"title": "acquisition_main",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 10f403a0f5151bd18cce6225e583912342c4c8c9 | 2023-12-08T16:53:47 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"FIBDetails": {
"additionalProperties": false,
"description": "Details about the focussed ion beam (FIB) extension if present.",
"properties": {
"FIBColumn": {
"description": "(Optional) - The name of the I-beam column used",
"type": "string"
},
"FIBExtractor": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The extractor voltage used for the I-Beam"
},
"FIBProbe": {
"description": "(Required) - The settings used for the probe, extractor voltage:milling current. eg. 30kV:50pA",
"type": "string"
},
"FIBSpotSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - spot size of the i-beam at the focus when the sample is in focus (also the spot size on the sample) defined separately as distanceDetails (Allowed units: nm, um, mm, cm, m)"
},
"angleToEBeam": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - angle between e-beam and i-beam defined separately as angleDetails (Allowed units: degree, radian)"
},
"gasInjectionSystem": {
"$ref": "#/$defs/GISDetails",
"description": "(Optional) - Details about the gas injection system (GIS) defined separately as GISDetails"
},
"iBeamSource": {
"$ref": "#/$defs/sourceDetails",
"description": "(Required) - describes the details of the FIB source, defined separately as sourceDetails in which it is important to note the accelerating voltage and beam current of the i-beam"
},
"iBeamWorkingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Working distance of the ion beam (i-beam) defined separately as distanceDetails - this value needs to be entered if the i-beam focus has to be set independently from the e-beam focus (Allowed units: nm, um, mm, cm, m)"
}
},
"required": [
"iBeamSource",
"FIBExtractor",
"FIBProbe"
],
"type": "object"
},
"GISDetails": {
"additionalProperties": false,
"description": "gives the details of the gas injection system (GIS).",
"properties": {
"GISName": {
"description": "(Optional) - Name of the GIS system of datatype string",
"type": "string"
},
"beamDepositionType": {
"description": "(Optional) - type of beam deposition of datatype string to choose between e-beam deposition and i-beam deposition",
"enum": [
"E-beam Deposition",
"I-beam Deposition"
],
"type": "string"
},
"depositionCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current used for performing beam deposition defined separately as currentDetails (Allowed units pA,nA,uA,mA,A)"
},
"depositionSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the deposition defined separately as distanceDetails (Allowed units nm,um,mm,cm,m)"
},
"depositionTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - total time for deposition defined separately as timeDetails (Allowed units ps,ns,us,ms,s)"
}
},
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "degree",
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"angleSet": {
"additionalProperties": false,
"description": "(Optional) - Tilt angles alpha, beta and gamma decribing the three angular positions of an item.",
"properties": {
"alpha": {
"description": "(Optional) - Tilt angle alpha of the item.",
"type": "number"
},
"anglesUnit": {
"default": "degree",
"description": "(Optional) - unit of the angles (allowed units - degree or radian)",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"beta": {
"description": "(Optional) - Tilt angle beta of the item.",
"type": "number"
},
"gamma": {
"description": "(Optional) - Tilt angle gamma of the item.",
"type": "number"
}
},
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"default": "\u00b5m",
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "pA",
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string.",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"detectorDetails": {
"additionalProperties": false,
"description": "gives the settings of a detector.",
"properties": {
"componentGeometry": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - xyz coordinates describing the position of the detector defined separately as coordinateSet"
},
"detectorBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - bias voltage applied to the detector defined separately as voltageDetails. Allowed units nV, uV, mV, V, kV"
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector"
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - describes the details of the detector (manufacturerName, modelName and detectorID) as part of manufacturerDetails"
},
"detectorName": {
"description": "(Required) -Name of the detector of datatype string",
"type": "string"
},
"detectorType": {
"default": "Secondary Electron",
"description": "(Optional) - The type of detector (e.g., surface electron detection, secondary electron, back-scattered electron) of datatype string",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (CCYY-MM-DDThh:mm:ss.sss) of the date-time format",
"pattern": "(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z)",
"type": "string"
}
},
"required": [
"detectorName"
],
"type": "object"
},
"detectorSetDetails": {
"additionalProperties": false,
"description": "gives information about signal mixing between two detectors and provides the information about the detector(s).",
"properties": {
"detector1": {
"$ref": "#/$defs/detectorDetails",
"description": "(Required) - gives the settings of one detector defined separately as detectorDetails; entering the details of at least one detector is compulsory"
},
"detector2": {
"$ref": "#/$defs/detectorDetails",
"description": "(Optional) - gives the settings of a second detector defined separately as detectorDetails"
},
"signalMixingDescription": {
"description": "(Optional) - Describes the purpose and technique of signal mixing of datatype string",
"type": "string"
},
"signalMixingDone": {
"default": false,
"description": "(Optional) - whether the detector signals are mixed, true or false, of datatype boolean",
"type": "boolean"
}
},
"required": [
"detector1"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"eBeamDecelerationDetails": {
"additionalProperties": false,
"description": "Details about deceleration of the e- beam.",
"properties": {
"landingEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Landing energy of the e-beam defined separately as energyDetails (allowed units - meV, eV, keV, nJ, mJ, J, kJ, MJ)"
},
"stageBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Bias voltage applied to the stage defined separately biasDetails (allowed units - nV, uV, mV, V, kV, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "keV",
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ; default value - keV) of datatype string",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"entry": {
"additionalProperties": false,
"description": "Required) - The entry level is the root element of the schema. It contains all the metadata describing a CT measurement.",
"properties": {
"definition": {
"description": "(Optional) - Name of the schema to which this entry conforms. In this case, lab_CT should be written",
"type": "string"
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "entryID (Optional) - Identifier of the metadata entry usually provided by the project or the laboratory"
},
"experimentID": {
"$ref": "#/$defs/identifier",
"description": "entryID (Optional) - Identifier of the measurement usually provided by the project or the laboratory"
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings"
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition"
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format"
},
"sample": {
"$ref": "#/$defs/sample",
"description": "(Required)- Details concerning the sample"
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement",
"type": "string"
},
"user": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/user_description.json",
"description": "(Required)- The contact information of the user responsible for the measurement"
}
},
"required": [
"title",
"startTime",
"endTime",
"program",
"user",
"instrument"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/unit time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min) default value - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"imagingDetails": {
"additionalProperties": false,
"description": "describes the imaging settings of the instrument during the measurement.",
"properties": {
"apertureSetting": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Optional) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). The element apertureSetting is defined separately as apertureSettingType which gives the option to choose between current or size. If the size can be set directly, then it is defined with the complex type distanceDetails, else if the aperture setting is controlled with the beam current defined separately as currentDetails"
},
"collectionMethod": {
"default": "normal scan",
"description": "(Optional) - the method of collection of the image, for e.g., normal scan, average of multiple images, integration of multiple images, default value - normal scan, of datatype string",
"type": "string"
},
"cycleTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - the time taken by the beam to scan a frame, defined separately as timeDetails. It is the time needed to scan a line times the number of lines in a frame."
},
"dwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - the dwell time of the beam per pixel, defined separately as timeDetails"
},
"dynamicFocus": {
"description": "(Optional) - To be set to true if dynamic focus is turned on, else false",
"type": "boolean"
},
"noiseReduction": {
"description": "(Optional) - The type of noise reduction used as an enumerated list of six parameters: Pixel Avg, Line Avg, Frame Avg, Pixel Int, Line Int, Frame Int.",
"enum": [
"Pixel Avg",
"Line Avg",
"Frame Avg",
"Pixel Int",
"Line Int",
"Frame Int"
],
"type": "string"
},
"numberOfPixels": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The number of x, y pixels of the image, defined separately as pixelNumberType with separate entries for integer values of xPixels and yPixels"
},
"pixelSize": {
"$ref": "#/$defs/pixelsize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel, normally expressed in nm/pixel, defined separately as pixelSize3D for the mapping along x,y and z directions, with each pixel having a pixelSize, optional uncertainty, optional qualifier and optional notes. The y-pixel-size is to be given only if it is different from the x-pixel-size, and z-pixel-size can be ignored if it is greater than voxel size"
},
"voxel": {
"$ref": "#/$defs/voxelDetails",
"description": "(Optional) - Size of the voxel in case 3D imaging is done for Energy-dispersive X-ray Spectroscopy or Electron-backscatter Diffraction, defined separately as voxelDetails"
}
},
"required": [
"numberOfPixels",
"pixelSize"
],
"type": "object"
},
"institutionDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the institution to which the user is affiliated.",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier pertaining to the institution (e.g. ROR)"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray target in an SEM based CT set-up.",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required) - Details of the pressure maintained in the chamber of the SEM."
},
"electronBeamShift": {
"additionalProperties": false,
"description": "(Required) - The distance by which the electron beam is shifted in the x and y directions.",
"properties": {
"xShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the x direction. Typical unit - \u00b5m."
},
"yShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xShift",
"yShift"
],
"type": "object"
},
"electronProbeCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required) - The electron current measured at the probe. Typical unit - \u00b5A."
},
"objectiveLensAperture": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). Typically the diameter of the aperture is set in \u00b5m."
},
"target": {
"additionalProperties": false,
"description": "(Required) - Details regarding the target in SEM based CT, which upon interaction with the e-beam produces the X-rays.",
"properties": {
"targetMaterial": {
"description": "(Required) - Material with which the target is made.",
"type": "string"
},
"targetShape": {
"description": "(Optional) - Description of the shape or geometry of the target. e.g. - bulk, foil, needle.",
"type": "string"
},
"targetThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Thickness of the target (dimension in Z direction). Default unit - \u00b5m."
},
"targetTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the target is tilted. Typical unit - degree."
}
},
"required": [
"targetMaterial",
"targetThickness",
"targetTiltAngle",
"targetCurrent"
],
"type": "object"
},
"targetDriftCorrection": {
"description": "(Required) - If drift correction is activated for the target, this parameter has to be set to true.",
"type": "boolean"
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. In SEM based CT, the beam is focussed on the target material which emits the X-rays upon interaction with the electrons. Default unit - \u00b5m."
}
},
"required": [
"chamberPressure",
"electronBeamShift",
"workingDistance",
"targetDriftCorrection",
"objectiveLensAperture",
"electronProbeCurrent",
"target"
],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
},
"targetCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current measured at the X-ray target, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"motorPositions": {
"additionalProperties": false,
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the source.",
"properties": {
"sourcePosition": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - The xyz coordinates decribing the motor positions of the source."
},
"sourceTilt": {
"$ref": "#/$defs/angleSet",
"description": "(Optional) - The three tilt angles alpha, beta and gamma describing the motor positions of the source."
}
},
"type": "object"
},
"sourceDrift": {
"additionalProperties": false,
"description": "(Optional) - Distance by which the source is shifted during the measurement (i.e., end position - start position).",
"properties": {
"xDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the x direction. Typical unit - \u00b5m."
},
"yDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xDrift",
"yDrift"
],
"type": "object"
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray enrgy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source"
],
"type": "object"
},
"lifetimeDetails": {
"additionalProperties": false,
"description": "describes a lifetime.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5Ah",
"description": "(Required) - the unit of the value (default value - \u00b5Ah) of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The lifetime of the source expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"bioReactor": {
"additionalProperties": false,
"description": "(Optional) - Details of an in situ bioreactor.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in sterile conditions.",
"type": "boolean"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is decreased. Typical unit - K/min."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is increased, typically in K/min."
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"chamberName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes the resolution of the image split into number of pixels in x and y directions.",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "nm/pixel",
"description": "(Required) - the unit of the value (default value - nm/pixel) of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"pixelsize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm/pixel, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min, default value - max) of datatype string.",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"default": "W",
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW, default value - W) of datatype string.",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "Pa",
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"rampDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a rate at which temperature is increased or decreased.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K/min",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K/min, K/s)",
"enum": [
"K/min",
"K/s"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of temperature increase or decrease.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"sample": {
"additionalProperties": false,
"description": "(Required) - Details concerning the sample.",
"properties": {
"sampleForm": {
"description": "(Optional) - Description of the sample form (e.g., bulk, nanostructured, powder, pellet)",
"type": "string"
},
"sampleHolder": {
"description": "(Optional) - Type of sample holder used",
"type": "string"
},
"sampleID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the sample"
},
"sampleName": {
"description": "(Optional) - Name of the sample",
"type": "string"
},
"samplePreparation": {
"$ref": "#/$defs/samplePrepType",
"description": "(Optional) - Details pertaining to the sample prepapration like date, ID, etc"
},
"sampleSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the sample"
},
"sampleWeight": {
"$ref": "#/$defs/weightDetails",
"description": "(Optional) - Weight of the sample"
},
"storageConditions": {
"default": "Ambient, dry environment",
"description": "(Optional) - Environment conditions in which the sample has to be stored before and after the measurement (e.g., nitrogen atmosphere, hermetically sealed, controlled temperature and pressure).",
"type": "string"
}
},
"type": "object"
},
"samplePrepType": {
"additionalProperties": false,
"description": "(Optional) - Describes the sample preparation process.",
"properties": {
"preparationDate": {
"description": "(Optional) - Date of the sample preparation.",
"format": "date",
"type": "string"
},
"preparationDescription": {
"description": "(Optional) - Short description of the sample preparation.",
"type": "string"
},
"preparationID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the sample preparation."
}
},
"type": "object"
},
"sourceDetails": {
"additionalProperties": false,
"description": "gives details about the electron beam source.",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - the voltage with which the e-beam is accelerated, defined separately as voltageDetails, (includes the voltage value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - \u00b5V, mv, V, kV, MV)"
},
"beamCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the measured current of the e-beam, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
},
"gunPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Gives the pressure maintained in the FIB gun"
},
"gunVacuum": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Gives the pressure maintained in the electron gun"
},
"highCurrent": {
"description": "(Optional) - Is special control of the electron optics enabled to increase the specimen current? true or false",
"type": "boolean"
},
"sourceID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - identifier for the e-beam source"
},
"sourceLifetime": {
"$ref": "#/$defs/lifetimeDetails",
"description": "(Optional) - lifetime of the source (default value - uAh) of datatype string"
},
"sourceName": {
"description": "(Optional) - name of the e-beam source of datatype string",
"type": "string"
}
},
"required": [
"accelerationVoltage"
],
"type": "object"
},
"stageDetails": {
"additionalProperties": false,
"description": "describes the stage settings during a measurement.",
"properties": {
"coordinateReference": {
"default": "origin at centre of sample",
"description": "(Optional) - description of the reference used for defining the coordinates (for eg. - origin at centre of sample, distances from two edges, etc.)",
"type": "string"
},
"coordinates": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - the xyz coordinates of a point expressed separately as coordinateSet which allows entering each of the xyz coordinates along with their optional uncertainties. If correllation images (two reference spots) are available, the coordinates enable correlative microscopy and they need to be entered"
},
"eBeamWorkingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the distance at which the beam is focussed (when the sample is in focus, this will be the distance between the bottom end of the pole-piece of the objective lens and the sample) defined separately as distanceDetails, with the distance value, optional uncertainty, optional notes, optional qualifier and choice of units between nm, um, mm, cm and m"
},
"isCorrelationImage": {
"description": "(Optional) - Whether the image is used for correlating in xyz coordinates with another image? Check if true. If true the coordinates have to be entered for the sake of correlative characterization of datatype boolean",
"type": "boolean"
},
"preTilt": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - predefined angle of a tilted sample holder which is tilted by design defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"stageAlignmentDone": {
"description": "(Optional) - was stage alignment done? (check if true)",
"type": "boolean"
},
"stageTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the stage is actually tilted (Stage at T) defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"tiltCorrectionAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - angle used to correct the tilt of the sample defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"tiltCorrectionType": {
"default": "none",
"description": "(Optional) - the tilt correction type applied to the image to compensate for the tilting, for e.g., sample surface, cross-section, none or manual, default value- none of datatype string",
"type": "string"
}
},
"required": [
"eBeamWorkingDistance",
"stageTiltAngle"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5s",
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s default value - \u00b5s) of datatype string",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "kV",
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV default value - V) of datatype string.",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"voxelDetails": {
"additionalProperties": false,
"description": "describes the size of a voxel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "mm",
"description": "(Required) - the unit of the value of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The voxel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"weightDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a weight.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "\u00b5g",
"description": "(Required) - Unit of the value to be selected from a controlled list (ng, \u00b5g, mg, g, kg, default value - ug)",
"enum": [
"ng",
"\u00b5g",
"mg",
"g",
"kg"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the weight",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided.",
"properties": {
"entry": {
"$ref": "#/$defs/entry"
}
},
"required": [
"entry"
],
"title": "lab_CT",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | a09c6f31e2763fcff68fac51aa0cb333ed1b1d93 | 2023-11-24T15:14:55 | SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "degree",
"description": "(Optional) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (pA, nA, \u00b5A, mA, A)",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the current",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "Pa",
"description": "(Optional) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"stage": {
"additionalProperties": false,
"description": "Describes the stage.",
"properties": {
"activeStage": {
"description": "(Required)- Describes the stage in use",
"type": "string"
},
"specTilt": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional)- Pretilt of the sample, usually due to pretilted holder."
},
"stageM": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- M coordinate of the position of the stage (additional translation axis available in Zeiss instruments)"
},
"stageR": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Angle by which the stage is rotated"
},
"stageTa": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Tilt angle alpha of the stage"
},
"stageTb": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Tilt angle beta of the stage"
},
"stageX": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- X coordinate of the position of the stage"
},
"stageY": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Y coordinate of the position of the stage"
},
"stageZ": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Z coordinate of the position of the stage"
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. IRI: https://purls.helmholtz-metadaten.de/EMG/00000026"
}
},
"required": [
"workingDistance",
"stageX",
"stageY",
"stageZ",
"stageR",
"stageTa",
"stageTb",
"activeStage"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"vacuum": {
"additionalProperties": false,
"description": "Describes the vacuum maintained in the system.",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- The pressure maintained in the electron chamber"
},
"gas": {
"description": "(Required)- The gas used in the electron chamber",
"type": "string"
},
"humidity": {
"description": "(Required)- Describes the humidity in the chamber during the measurement",
"type": "string"
},
"userMode": {
"description": "(Required)- The type of vacuum slected by the user",
"enum": [
"High vacuum",
"Medium vacuum",
"Low vacuum"
],
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://github.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/blob/68fd9fa5de5dbe56bd7665b6320eb1ca47b4b1e5/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes an individual image acquired during the course of a SEM/FIB Tomography experiment. Each image is taken using a detector (SE, BSE, EDS, EBSD) at each slice cut using FIB. This Schema contains only the parameters which are specific to the individual image. The parameters which are common to the entire set are described by another schema which describes the dataset as a whole and is located at https://github.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/edit/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json.",
"properties": {
"creationTime": {
"description": "(Required)- Time of creation of the image",
"pattern": "(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z)",
"type": "string"
},
"definition": {
"description": "(Required)- Name of the schema to which this entry conforms. In this case, acquisition_image should be written",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Identifier of the image produced by the machine"
},
"fileLink": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Link to the location of the image"
},
"fileName": {
"description": "(Required)- File name of the image",
"type": "string"
},
"specimenCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required)- Current measured on the specimen during acquisition of the image"
},
"stage": {
"$ref": "#/$defs/stage",
"description": "(Required)- Details concerning stage settings used for aquisition"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required)- Temperature of the sample during acquisition"
},
"vacuum": {
"$ref": "#/$defs/vacuum",
"description": "(Required)- Details concerning the vacuum during aquisition"
}
},
"required": [
"fileName",
"creationTime",
"definition",
"stage",
"vacuum",
"temperature"
],
"title": "acquisition_image",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 8e0a89aa25faf6b2f216155b3408e3982088ccbd | 2023-12-15T08:47:13 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"CTAquisition": {
"additionalProperties": false,
"description": "(Required) - Details about the acquisition.",
"properties": {
"acquisitionScriptName": {
"description": "(Required) - Name of the script used for acquisition.",
"type": "string"
},
"acquisitionTimePerProjection": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time taken for acquisition of a single projection. Typical unit - s."
},
"angularStepSize": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Step size of the rotation of the sample during the CT. Typical unit - degree."
},
"contrastType": {
"description": "(Required) - The contrast type(mode) used - Absorption Contrast or Phase Contrast. If 'Phase Contrast' is selected, please indicate the used Phase Contrast Mode under the field phaseContrastMode.",
"enum": [
"Absorption Contrast",
"Phase Contrast"
],
"type": "string"
},
"endAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - End angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then endAngle is 180\u00b0. Typical unit - degree."
},
"largeFOV": {
"description": "(Required) - To be set to true if large field of view or wide field of view is used.",
"type": "boolean"
},
"numberOfProjections": {
"description": "(Required) - Number of projections acquired during the CT.",
"type": "number"
},
"phaseContrastMode": {
"description": "(Optional) - The phase contrast mode used during acquisition - Zernike phase contrast, propagation-based, grating-based(Hartmann), grating-based(Talbot).",
"enum": [
"Zernike phase contrast",
"Propagation-based",
"Grating-based(Hartmann)",
"Grating-based(Talbot)"
],
"type": "string"
},
"referenceImages": {
"additionalProperties": false,
"description": "(Optional) - Details on the reference images (if used) - number of flats/bright images and number of dark images.",
"properties": {
"numberOfBrightImages": {
"description": "(Optional) - Number of flats or bright images used as reference.",
"type": "number"
},
"numberOfDarkImages": {
"description": "(Optional) - Number of dark images used as reference.",
"type": "number"
}
},
"type": "object"
},
"scanningMode": {
"description": "(Optional) - The scanning mode used during acquisition - helical, raster scanning, fast CT.",
"enum": [
"Helical",
"Raster Scanning",
"Fast CT"
],
"type": "string"
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Start angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then startAngle is -180\u00b0. Typical unit - degree."
},
"totalAcquisitionTime": {
"description": "(Required) - Time taken for acquisition for the entire scan. This is the total scan time, i.e. number of projections multipled by exposure time, but including read-out time. calculated as EndTime-StartTime. Format: hh:mm:ss.",
"format": "time",
"pattern": "^(\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?)$",
"type": "string"
},
"useBadPixelMap": {
"description": "(Optional) - To be set to true if bad pixel map is used. This parameter is relevant for SEM based CT.",
"type": "boolean"
}
},
"required": [
"acquisitionScriptName",
"startAngle",
"endAngle",
"angularStepSize",
"acquisitionTimePerProjection",
"totalAcquisitionTime",
"largeFOV",
"contrastType"
],
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "degree",
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"angleSet": {
"additionalProperties": false,
"description": "(Optional) - Tilt angles alpha, beta and gamma decribing the three angular positions of an item.",
"properties": {
"alpha": {
"description": "(Optional) - Tilt angle alpha of the item.",
"type": "number"
},
"anglesUnit": {
"default": "degree",
"description": "(Optional) - unit of the angles (allowed units - degree or radian)",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"beta": {
"description": "(Optional) - Rotation angle beta of the item.",
"type": "number"
},
"gamma": {
"description": "(Optional) - Angle gamma of the item.",
"type": "number"
}
},
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"default": "\u00b5m",
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "pA",
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string.",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"data": {
"additionalProperties": false,
"description": "(Required) - Details about the data section of the measurement.",
"properties": {
"projections": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"cropping": {
"additionalProperties": false,
"description": "(Optional) - Details about cropping or clipping to select a region of interest(ROI).",
"properties": {
"ROI": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The size of the region of interest (ROI) in integer values of xPixels and yPixels."
},
"offset": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The offset applied to the origin (i.e., centre of the image) to select the region of interest in x and y coordinates."
}
},
"required": [
"ROI",
"offset"
],
"type": "object"
},
"projectionImageDataStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the data structure of the image data of the projections.",
"properties": {
"IOValue": {
"description": "(Required) - The IO value obtained from the metadata.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The dimension of the image as for integer values of xPixels and yPixels."
},
"fileLocation": {
"description": "(Required) - The location where the data file is stored. A URL is preferred if available.",
"type": "string"
},
"greyValueRepresentation": {
"description": "(Optional) - Description about the grey value representation.",
"type": "string"
},
"header": {
"additionalProperties": false,
"description": "(Required) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Required) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"imageCorrection": {
"additionalProperties": false,
"description": "(Optional) - Details about the image correction.",
"properties": {
"isImageCorrected": {
"description": "(Required) - To be set as true if image is corrected.",
"type": "boolean"
},
"linkToReferenceImages": {
"description": "(Required) - Link to the reference images (flats/darks).",
"format": "uri-reference",
"type": "string"
}
},
"required": [
"isImageCorrected",
"linkToReferenceImages"
],
"type": "object"
},
"imageFormats": {
"additionalProperties": false,
"description": "(Required) - The file formats of the images - tiff, png, jpeg. When more than one file formats are there, then the formats are to be entered as an array of strings.",
"properties": {
"fileFormats": {
"oneOf": [
{
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
{
"items": {
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"fileFormats"
],
"type": "object"
},
"imageID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the Image Data."
},
"isPreFiltered": {
"description": "(Optional) - To be set as true if image is prefiltered.",
"type": "boolean"
},
"name": {
"description": "(Required) - Name of the Projection Image Data.",
"type": "string"
},
"numberOfImages": {
"description": "(Required) - Number of images in the data set. It is same as the number of projections.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical x,y length imaged by a single pixel, normally expressed in \u00b5m."
}
},
"required": [
"fileLocation",
"name",
"imageFormats",
"header"
],
"type": "object"
}
},
"required": [
"projectionImageDataStructure"
],
"type": "object"
},
"reconstructedData": {
"additionalProperties": false,
"description": "(Required) - Details about the reconstructed slices. When multiple reconstructions of the same raw data (projections) are present, the corresponding data can be combined as an array of reconstruction data sets, else as a single reconstruction data set.",
"properties": {
"reconstruction": {
"oneOf": [
{
"$ref": "#/$defs/reconstruction"
},
{
"items": {
"$ref": "#/$defs/reconstruction"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"reconstruction"
],
"type": "object"
}
},
"required": [
"projections",
"reconstructedData"
],
"type": "object"
},
"detector": {
"additionalProperties": false,
"description": "gives the settings of a detector or multiple detectors.",
"properties": {
"detectorSettings": {
"oneOf": [
{
"$ref": "#/$defs/detectorSettings"
},
{
"items": {
"$ref": "#/$defs/detectorSettings"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"detectorSettings"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "(Required) - Gives the settings of a single detector.",
"properties": {
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each pixel or voxel in an image. The bit depth determines the number of possible intensity levels that can be assigned to each pixel or voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"cameraGain": {
"description": "(Optional) - The amplification (gain) of the signal from an image sensor in a camera.",
"type": "number"
},
"detectorCoolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Cooling temperature of the detector, if it cooled. Relevant for SEM based CT. Typical unit - K."
},
"detectorDimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Optional) - The dimensions of the detector in integer values of xPixels and yPixels."
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector."
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the detector (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"detectorMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - The motor positions of the detector in cartesian coordinates and tilt angles."
},
"detectorName": {
"description": "(Optional) - Name of the detector of datatype string.",
"type": "string"
},
"detectorPixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical length in cartesian coordinates imaged by a single pixel of the detector. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"detectorType": {
"description": "(Optional) - The type of detector to be selected from a controlled list consisting of CCD, Panel, PCXD, CMOS, Time-Delay Integration (TDI) and Direct Conversion.",
"enum": [
"CCD",
"Panel",
"PCXD",
"CMOS",
"Time-Delay Integration (TDI)",
"Direct Conversion"
],
"type": "string"
},
"energyThreshold": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - A specific energy level used to filter the detected radiation."
},
"exposureTimePerFrame": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Time for which the sample is exposed per frame. Typical unit - s."
},
"frameSkip": {
"additionalProperties": false,
"description": "(Optional) - A numerical representation indicating the number of frames that are skipped or omitted during the acquisition or recording process. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3. If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped.",
"properties": {
"value": {
"oneOf": [
{
"description": "(Optional) - Number of frames skipped during acquisition. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3.",
"type": "number"
},
{
"description": "(Optional) - Pattern of frames skipped during acquisition. E.g. - If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped like [1,3,5]",
"items": {
"type": "number"
},
"minItems": 1,
"type": "array"
}
]
}
},
"type": "object"
},
"framesPerSecond": {
"description": "(Optional) - The number of frames captured in a second.",
"type": "number"
},
"imagePixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical length in cartesian coordinates imaged by a single pixel of the image. It is the native pixel size divided by the total magnification. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"lens": {
"additionalProperties": false,
"description": "(Optional) - Details of a lens, if used with the detector.",
"properties": {
"hasLens": {
"description": "(Required) - To be set to true if the detector has a lens.",
"type": "boolean"
},
"lensFocalLength": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Focal length of the lens."
},
"lensID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the lens."
},
"lensMagnification": {
"description": "(Optional) - Magnification of the lens as a floating point number.",
"type": "number"
},
"lensManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the lens (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"lensName": {
"description": "(Optional) - Name of the lens of datatype string.",
"type": "string"
}
},
"required": [
"lensMagnification",
"lensFocalLength"
],
"type": "object"
},
"numberOfAveragedFramesPerProjection": {
"description": "(Optional) - The number of averaged frames per projection, if averaging is done.",
"type": "number"
},
"sensor": {
"additionalProperties": false,
"description": "(Optional) - Details about a sensor, if present.",
"properties": {
"hasSensor": {
"description": "(Required) - To be set to true if the detector has a sensor.",
"type": "boolean"
},
"sensorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the sensor."
},
"sensorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the sensor (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"sensorMaterial": {
"description": "(Optional) - Material of the sensor of datatype string.",
"type": "string"
},
"sensorName": {
"description": "(Optional) - Name of the sensor of datatype string.",
"type": "string"
},
"sensorThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the sensor."
},
"sensorType": {
"description": "(Optional) - The type of sensor as a string.",
"type": "string"
}
},
"required": [
"hasSensor"
],
"type": "object"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Temperature of the detector."
},
"totalCountsPerProjection": {
"description": "(Optional) - The sum of the intensity values recorded by the X-ray detector for a single projection during a scan.",
"type": "number"
}
},
"required": [
"detectorType",
"detectorManufacturer",
"binning",
"detectorMotorPositions",
"imagePixelSize"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ; default value - keV) of datatype string",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"entry": {
"additionalProperties": false,
"description": "Required) - The entry level is the root element of the schema. It contains all the metadata describing a CT measurement.",
"properties": {
"consumables": {
"description": "(Optional) - Auxiliary entity used during Fabrication, Sample Preparation or Measurement which has a limited time capacity or is limited in its number of uses before it is disposed of, necessary to the process itself and normally bought from third party manufacturers. Examples are: gloves, syringes, wipes, etching solutions, glass slides, spatulas, weighing paper, two-sided tape.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"data": {
"$ref": "#/$defs/data",
"description": "(Optional)- Details concerning the data section of the measurement."
},
"definition": {
"description": "(Required) - Name of the schema to which this entry conforms. In this case, lab_CT should be written.",
"type": "string"
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry usually provided by the project or the laboratory."
},
"equipment": {
"description": "(Optional) - Any kind of physical or virtual item, device, machine or other tools used to perform one or more Fabrication(s), Sample Preparation(s), Model Preparation(s), Data Acquisition(s) and/or any of the processes included in the Data Analysis Lifecycle. Usually, the Equipment is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. Equipment is usually an investment. According to this definition, an Instrument is a particular type of Equipment.",
"type": "string"
},
"experimentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the measurement usually provided by the project or the laboratory."
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings. Instrument is a physical or virtual identifiable piece of Equipment used to perform a Data Acquisition and to generate Raw Data. The Instrument is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. A virtual Instrument may be any computational resource or HPC infrastructure (cloud infrastructure or supercomputer) needed to perform Calculations or Simulations."
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure."
},
"measurementDescription": {
"description": "(Optional) - Description about the measurement.",
"type": "string"
},
"measurementPurpose": {
"description": "(Required) - Measurement is experimental Data Acquisition, typically performed on a Sample using an experimental Technique. It may also be performed during Fabrication or Sample Preparation, e.g., to characterise the intermediate stages and/or the final resulting Precursor(s) or Sample(s), respectively. A Measurement may require the use of Consumables.",
"enum": [
"assessment (to given categories or values)",
"completeness check (presence or absence of given properties)",
"correlative characterization (dedicated sample treatment to emphasise given features)",
"exploratory (routine check of known properties)",
"feasibility (quick check, rough estimate)",
"high quality measurement (precise, careful treatment)",
"test specific hypothesis (focus only on given aspects)",
"other (please specify in the comment)"
],
"type": "string"
},
"parents": {
"description": "(Required) - Parents of this metadata like the metadata document of the sample with which the measurement was performed.",
"items": {
"if": {
"properties": {
"parentType": {
"not": {
"const": "not applicable"
}
}
}
},
"properties": {
"parentReference": {
"description": "If type is 'MetaStore URI' it is possible to easily fill this field in a later stage",
"format": "uri-reference",
"type": "string"
},
"parentReferenceType": {
"enum": [
"plain text",
"external URL",
"MetaStore URI"
],
"type": "string"
},
"parentType": {
"enum": [
"not applicable",
"sample"
],
"type": "string"
}
},
"required": [
"parentType"
],
"then": {
"required": [
"parentReferenceType",
"parentReference"
]
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition."
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format."
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"technique": {
"description": "(Required) - Any experimental, theoretical or computational method used during Data Acquisition or during any of the processes included in the Data Analysis Lifecycle to acquire, process or analyse Research Data about a System or a set of them with an Instrument, whihc is used to generate this metadata.",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement.",
"type": "string"
},
"user": {
"$ref": "#/$defs/user",
"description": "(Required)- The contact information of the user responsible for the measurement."
}
},
"required": [
"title",
"technique",
"definition",
"parents",
"measurementPurpose",
"startTime",
"endTime",
"program",
"user",
"instrument",
"data"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min) default value - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"geometry": {
"additionalProperties": false,
"description": "Describes the geometry of the CT instrument",
"properties": {
"beamGeometry": {
"additionalProperties": false,
"description": "(Required) - Details about beam geometry like beam geometry type and divergence angle.",
"properties": {
"beamGeometryType": {
"description": "(Required) - The type of the beam geometry to be selected between 'collimated' and 'divergent'.",
"enum": [
"collimated",
"divergent"
],
"type": "string"
},
"divergenceAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Angle of divergence when the beam geometry is divergent. Typical unit - degree."
}
},
"type": "object"
},
"geometricMagnification": {
"description": "(Required) - Geometric magnification refers to the ratio of the size of an object's image to the size of the object itself. It is a measure of how much larger the image appears compared to the actual object. Geometric magnification (M) is calculated using the formula M = (SID + SOD) / SID, where SID is the source-to-image distance and SOD is the source-to-object distance.",
"type": "number"
},
"objectToDetectorDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the object and the detector. Typical unit - \u00b5m."
},
"opticalMagnification": {
"description": "(Required) - Optical magnification is calculated as the ratio of the focal length of the objective lens to the focal length of the eyepiece (if an eyepiece is present) in a traditional optical microscope.",
"type": "number"
},
"sourceToObjectDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the source and the object. Typical unit - \u00b5m."
}
},
"required": [
"sourceToObjectDistance",
"objectToDetectorDistance",
"beamGeometry",
"geometricMagnification",
"opticalMagnification"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"CTAquisition": {
"$ref": "#/$defs/CTAquisition",
"description": "(Optional) - Details regarding the acquisition."
},
"calibration": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the calibration and the scaling factor.",
"properties": {
"calibrationType": {
"description": "(Optional) - Type of calibration as a string.",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (YYYY-MM-DDThh:mm:ss.sss) in the ISO 8601 date-time format",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"systemScaling": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scaling factor.",
"properties": {
"adjustSystemScaling": {
"description": "(Required) - To be set to true if system scaling is adjusted, else false.",
"type": "boolean"
},
"measuredScalingFactor": {
"description": "(Optional) - Value of the measured scaling factor.",
"type": "number"
},
"referenceScalingFactor": {
"description": "(Optional) - Value of the reference scaling factor, determined ususally during the data processing.",
"type": "number"
}
},
"required": [
"adjustSystemScaling"
],
"type": "object"
}
},
"type": "object"
},
"detector": {
"$ref": "#/$defs/detector",
"description": "(Optional) - Details regarding the detector."
},
"focalSpotMode": {
"additionalProperties": false,
"description": "(Optional) - Option for setting the size of the focal spot. Some sources have the option to select the target spot size, or focal spot size absolutely by setting a value, while some others give the option of selecting 'small', 'medium' or 'large'. Smaller spot size = higher resolution. Note that the power/current will change with this value. In addition, the detector settings will usually be selected in conjunction. (different scintillator/lens/magnification).",
"properties": {
"selection": {
"description": "(Optional) - Selection of the setting of the size of the focal spot when the option for setting the size of the focal spot by selecting 'small', 'medium' or 'large' according to predefined values set by the manufacturer.",
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the target spot when the option for setting the size of the focal spot absolutely by setting a value is available."
}
},
"type": "object"
},
"geometry": {
"$ref": "#/$defs/geometry",
"description": "(Optional) - Details regarding the geometry."
},
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"optics": {
"$ref": "#/$defs/optics",
"description": "(Optional) - Details about the optics and individual motor positions."
},
"sampleStage": {
"$ref": "#/$defs/sampleStage",
"description": "(Optional) - Details regarding the sample stage."
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray target in an SEM based CT set-up.",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required) - Details of the pressure maintained in the chamber of the SEM."
},
"electronBeamShift": {
"additionalProperties": false,
"description": "(Required) - The distance by which the electron beam is shifted in the x and y directions.",
"properties": {
"xShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the x direction. Typical unit - \u00b5m."
},
"yShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xShift",
"yShift"
],
"type": "object"
},
"electronProbeCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required) - The electron current measured at the probe. Typical unit - \u00b5A."
},
"objectiveLensAperture": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). Typically the diameter of the aperture is set in \u00b5m."
},
"target": {
"additionalProperties": false,
"description": "(Required) - Details regarding the target in SEM based CT, which upon interaction with the e-beam produces the X-rays.",
"properties": {
"targetDriftCorrection": {
"description": "(Required) - If drift correction is activated for the target, this parameter has to be set to true.",
"type": "boolean"
},
"targetMaterial": {
"description": "(Required) - Material with which the target is made.",
"type": "string"
},
"targetShape": {
"description": "(Optional) - Description of the shape or geometry of the target. e.g. - bulk, foil, needle.",
"type": "string"
},
"targetThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Thickness of the target (dimension in Z direction). Default unit - \u00b5m."
},
"targetTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the target is tilted. Typical unit - degree."
}
},
"required": [
"targetMaterial",
"targetThickness",
"targetDriftCorrection",
"targetTiltAngle",
"targetCurrent"
],
"type": "object"
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. In SEM based CT, the beam is focussed on the target material which emits the X-rays upon interaction with the electrons. Default unit - \u00b5m."
}
},
"required": [
"chamberPressure",
"electronBeamShift",
"workingDistance",
"objectiveLensAperture",
"electronProbeCurrent",
"target"
],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
},
"targetCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current measured at the X-ray target, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"sourceDrift": {
"additionalProperties": false,
"description": "(Optional) - Distance by which the source is shifted during the measurement (i.e., end position - start position).",
"properties": {
"xDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the x direction. Typical unit - \u00b5m."
},
"yDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xDrift",
"yDrift"
],
"type": "object"
},
"sourcePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the source."
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray enrgy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source",
"focalSpotMode",
"CTAquisition",
"geometry",
"sampleStage",
"detector"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer.",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"bioReactor": {
"additionalProperties": false,
"description": "(Optional) - Details of an in situ bioreactor.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in sterile conditions.",
"type": "boolean"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is decreased. Typical unit - K/min."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is increased, typically in K/min."
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"anvil": {
"description": "(Optional) - The type of anvil used in the in situ load frame (stage) for applying a particular type of force on the sample. Option to be selected from a controlled list consisting of - Compression, Diamond indentation 90\u00b0 cone, Diamond indentation cube corner, Diamond indentation wedge, Tension, Other. If 'Other' is selected, specify the name of the anvil with a description in the field 'otherAnvil'.",
"enum": [
"Compression",
"Diamond indentation 90\u00b0 cone",
"Diamond indentation cube corner",
"Diamond indentation wedge",
"Tension",
"Other"
],
"type": "string"
},
"blindAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - ed by the load frame(stage). Example: for a CT normally scanned over 180\u00b0 (e.g. -90\u00b0/+90\u00b0), a blind angle of 40\u00b0 due to the in situ cell implies that only 180\u00b0-40\u00b0=140\u00b0 (e.g. -70\u00b0/70\u00b0) is visible. NOTE: for a CT normally scanned over 360\u00b0 (e.g. -180\u00b0/+180\u00b0), a blind angle of 40\u00b0 would require the subtraction of the blind angle twice, implying two scan ranges of 140\u00b0 each (e.g. -160\u00b0/-20\u00b0 and +20\u00b0/+160\u00b0). Typical unit - degree."
},
"displacement": {
"additionalProperties": false,
"description": "(Optional) - Specification on how displacement is applied on the sample. Either 'displacementRate' in \u00b5m/min or 'displacementIncrement' in \u00b5m/acquisition need to be selected.",
"properties": {
"displacementIncrement": {
"description": "(Optional) - The step at which displacement is changed per acquisition in \u00b5m/acquisition.",
"type": "number"
},
"displacementRate": {
"description": "(Optional) - The rate at which displacement is applied on the sample in \u00b5m/min.",
"type": "number"
}
},
"type": "object"
},
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame or anvil (e.g. - size of anvil) relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
},
"maximumDisplacement": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - The maximum displacement allowed in the selected configuration. Typical unit - \u00b5m."
},
"maximumForce": {
"description": "(Optional) - The maximum force that can be applied to the sample in N.",
"type": "number"
},
"otherAnvil": {
"description": "(Optional) - If 'anvil' was selected as 'Other' from the controlled list as it was not listed, please specify the name of the anvil with a description in this field.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the vacuum chamber relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the vacuum chamber relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the vacuum chamber."
},
"chamberName": {
"description": "(Optional) - Name of the vacuum chamber.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"motorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchical level and direction of a motor.",
"properties": {
"motorDirection": {
"description": "(Required) - The direction of movement (for X,Y,Z,M motors) or axis of rotation (for rotating motors) expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the X-stage and perpendicular to the Y-stage. then beam direction = [1 0 0], X-stage-direction = [1 0 0] (positive movement direction away from source towards detector) or can be (-1 0 0) (towards source) and Y-stage-direction = [0 1 0] or can be [0 -1 0] (analogous interpretation). The parameters need to be individually determined for each instrument. For rotating motors, the directional vector of axis of rotation should be given in Cartesian coordinates (counterclockwise, right-hand rule).",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"motorLevel": {
"description": "(Required) - Hierarchy of the motor expressed as an integer.",
"type": "number"
}
},
"type": "object"
},
"motorPositions": {
"additionalProperties": false,
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the motor.",
"properties": {
"angles": {
"$ref": "#/$defs/angleSet",
"description": "(Optional) - The three tilt angles alpha, beta and gamma of the motors controlling the position of the item."
},
"xyzPositions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - The xyz coordinates describing the motor positions of the item."
}
},
"type": "object"
},
"optics": {
"additionalProperties": false,
"description": "(Optional) - Details about the optics and individual motor positions.",
"properties": {
"collimator": {
"additionalProperties": false,
"description": "(Optional) - Details about the collimator and its individual motor positions.",
"properties": {
"collimatorDetails": {
"description": "(Optional) - Details about the collimator relevant for the measurement.",
"type": "string"
},
"collimatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the collimator."
}
},
"type": "object"
},
"condenser": {
"additionalProperties": false,
"description": "(Optional) - Details about the condenser lens and its individual motor positions, if used.",
"properties": {
"condenserDetails": {
"description": "(Optional) - Details about the condenser relevant for the measurement.",
"type": "string"
},
"condenserPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the condenser."
}
},
"type": "object"
},
"fresnelZonePlate": {
"additionalProperties": false,
"description": "(Optional) - Details about the fresnel zone plate and its individual motor positions, if used.",
"properties": {
"fresnelZonePlateDetails": {
"description": "(Optional) - Details about the fresnel zone plate relevant for the measurement.",
"type": "string"
},
"fresnelZonePlatePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the fresnel zone plate."
}
},
"type": "object"
},
"monochromator": {
"additionalProperties": false,
"description": "(Required) - Details about the monochromator and individual motor positions, if used.",
"properties": {
"monochromatorDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the monochromator type type, material, energy and notes.",
"properties": {
"energy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Energy set in the monochromator. Typical unit - eV"
},
"material": {
"description": "(Optional) - Material of the monochromator.",
"type": "string"
},
"monochromatorType": {
"description": "(Optional) - Type of the monochromator.",
"type": "string"
},
"notes": {
"description": "(Optional) - Additional information about the monochromator relevant for the measurement."
}
},
"type": "object"
},
"monochromatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the monochromator."
},
"monochromatorUsed": {
"description": "(Required) - To be set to true if monochromator is used, else false.",
"type": "boolean"
}
},
"required": [
"monochromatorUsed"
],
"type": "object"
},
"phaseRing": {
"additionalProperties": false,
"description": "(Required) - Details about the phase ring and its individual motor positions, if inserted.",
"properties": {
"phaseRingDetails": {
"description": "(Optional) - Details about the phase ring relevant for the measurement.",
"type": "string"
},
"phaseRingPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the phase ring."
}
},
"type": "object"
}
},
"required": [
"monochromator"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes a parameter which can be split into number of pixels in x and y directions like the resolution",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm or \u00b5m, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "nm",
"description": "(Required) - the unit of the size of a single pixel (typical value - nm, \u00b5m) of datatype string",
"enum": [
"nm",
"\u00b5m"
],
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min, default value - max) of datatype string.",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"default": "W",
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW, default value - W) of datatype string.",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "Pa",
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"rampDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a rate at which temperature is increased or decreased.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K/min",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K/min, K/s)",
"enum": [
"K/min",
"K/s"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of temperature increase or decrease.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"reconstruction": {
"additionalProperties": false,
"description": "Data from one single reconstruction.",
"properties": {
"reconstructionDetails": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"additionalFilters": {
"beamHardeningCorrection": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"filterType": {
"description": "(Optional) - Type of the additional filter - Median or Gauss",
"enum": [
"Median",
"Gauss"
],
"type": "string"
},
"phaseRetrieval": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"ringFilter": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
}
},
"algorithm": {
"description": "(Required) - Algorithm used for reconstruction to be selected from FBP - Filtered Back Projection, ART - Algebraic Reconstruction Technique, 3dCT - 3D Computed Tomography and Gridrec.",
"enum": [
"FBP - Filtered Back Projection",
"ART - Algebraic Reconstruction Technique",
"3dCT - 3D Computed Tomography",
"Gridrec"
],
"type": "string"
},
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepthConversionMax": {
"description": "(Required) - Maximum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"bitDepthConversionMin": {
"description": "(Required) - Minimum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"hardwarePlatform": {
"description": "(Optional) - Hardware platform used for reconstruction to be selected between CPU and GPU.",
"enum": [
"CPU",
"GPU"
],
"type": "string"
},
"lastImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the last image for the reconstruction of the 3D Volume, typically an integer.",
"type": "string"
},
"projectionPadding": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the projection padding applied to the raw projection data to address certain issues in the reconstruction process.",
"properties": {
"paddingSize": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - Size of the projection padding used in pixels."
},
"paddingType": {
"description": "(Required) - Type of the projection padding used - Zero Padding, Linear Interpolation Padding, Sinc Interpolation Padding, Shepp-Logan Filtered Back Projection (SL-FBP), Gridding and Extended Field of View (FOV) Padding.",
"enum": [
"Zero Padding",
"Linear Interpolation Padding",
"Sinc Interpolation Padding",
"Shepp-Logan Filtered Back Projection (SL-FBP)",
"Gridding",
"Extended Field of View (FOV) Padding"
],
"type": "string"
}
},
"type": "object"
},
"reconstructionSoftware": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for reconstruction. It may be the same as the acquisition software or a different one."
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Scan angle at which the reconstruction of the 3D Volume starts. Typical unit - degree."
},
"startImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the start image for the reconstruction of the 3D Volume.",
"type": "string"
},
"tomographicProjectionFilter": {
"description": "(Optional) - Name of the tomographic projection filter used to be selected from Ram-Lak Filter, Butterworth Filter, Shepp-Logan Filter, Hann (Hanning) Filter, Gaussian Filter, Cosine Filter, Soft Filtration Method and Hard Filtration Method.",
"enum": [
"Ram-Lak Filter",
"Butterworth Filter",
"Shepp-Logan Filter",
"Hann (Hanning) Filter",
"Gaussian Filter",
"Cosine Filter",
"Soft Filtration Method",
"Hard Filtration Method"
],
"type": "string"
}
},
"required": [
"startImage",
"lastImage",
"startAngle",
"hardwarePlatform",
"algorithm",
"binning"
],
"type": "object"
},
"volumeStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each voxel in the 3D volume. The bit depth determines the number of possible intensity levels that can be assigned to each voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Required) - The dimension of the 3D volume in XYZ coordinates. If the length in Z dimension is not known and instead only the number of slices are known, they need to be separately entered in the field 'numberOfSlices'. Typical unit - \u00b5m."
},
"header": {
"additionalProperties": false,
"description": "(Optional) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Optional) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"name": {
"description": "(Required) - Name of the 3D volume structure (dataset).",
"type": "string"
},
"numberOfSlices": {
"description": "(Optional) - No. of slices which make up the 3D volume.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel/voxel, normally expressed in \u00b5m."
},
"volumeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry of the 3D reconstructed volume usually provided by the project or the laboratory."
}
},
"required": [
"name",
"dimensions",
"bitDepth",
"pixelSize"
],
"type": "object"
}
},
"required": [
"volumeStructure",
"reconstructionDetails"
],
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"sampleStage": {
"additionalProperties": false,
"description": "(Required) - Details about sample stage.",
"properties": {
"stageMotorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchy of the stage motors. This information is required to know how the motor movements affect the positions of the samples, particularly relevant for correlative characterization.",
"properties": {
"beamDirection": {
"description": "(Required) - The beam direction expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the Y-stage and perpendicular to the X-stage. then beam direction = [0 1 0].",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"mMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the M motor (stage) as a vector in cartesian coordiantes. The M motor is usually relevant only for SEM based CT. It is a special motor which counteracts the Z motor."
},
"rMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the R motor (stage) as a vector in cartesian coordiantes. R motor has rotation around z axis +1 (for anticlockwise)."
},
"tMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the T motor (stage) as a vector in cartesian coordiantes. The T motor is usually relevant only for SEM based CT."
},
"xMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the X motor (stage) as a vector in cartesian coordinates."
},
"yMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Y motor (stage) as a vector in cartesian coordinates."
},
"zMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Z motor (stage) as a vector in cartesian coordinates."
}
},
"required": [
"beamDirection",
"xMotor",
"yMotor",
"zMotor",
"rMotor"
],
"type": "object"
},
"stageMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the stage motors."
}
},
"required": [
"stageMotorHierarchy"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5s",
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s default value - \u00b5s) of datatype string",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"user": {
"description": "Basic schema for user description. It can be extended.",
"properties": {
"ORCID": {
"description": "(Optional) - Open Researcher and Contributor ID expressed as a URI",
"pattern": "^https://orcid\\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[X0-9]{1}$",
"type": "string"
},
"affiliation": {
"description": "(Optional) - Details of the institution to which the user is affiliated",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"description": "(Optional) -Identifier of the institution to which the user is affiliated",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be chosen from a controlled list of values (*ROR *GRID *ISNI *URL *DOI *Handle)",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"email": {
"description": "(Optional) - Email of the user",
"format": "email",
"type": "string"
},
"familyName": {
"description": "(Optional) - Family name of the user",
"type": "string"
},
"givenName": {
"description": "(Optional) - Given name of the user",
"type": "string"
},
"role": {
"description": "(Required) - Role of the research user",
"enum": [
"Data Curator",
"Instrument Scientist",
"Team Leader",
"Team Member"
],
"type": "string"
},
"userName": {
"description": "(Required) - Full name of the user in the format (Family Name, Given Name)",
"type": "string"
}
},
"required": [
"userName",
"role"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "kV",
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV default value - V) of datatype string.",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided. Contributors (in alphabetical order of last names): Alexey Boubnov, Rafaela Debastiani, Jonas Fell, Sarah Irvine, Reetu Elza Joseph.",
"properties": {
"entry": {
"$ref": "#/$defs/entry"
}
},
"required": [
"entry"
],
"title": "lab_CT",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 7d64276f3386960daa50cf06c9e50cb1bad401e4 | 2024-02-27T11:17:55 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"CTAquisition": {
"additionalProperties": false,
"description": "(Required) - Details about the acquisition.",
"properties": {
"acquisitionScriptName": {
"description": "(Required) - Name of the script used for acquisition.",
"type": "string"
},
"acquisitionTimePerProjection": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time taken for acquisition of a single projection. Typical unit - s."
},
"angularStepSize": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Step size of the rotation of the sample during the CT. Typical unit - degree."
},
"contrastType": {
"description": "(Required) - The contrast type(mode) used - Absorption Contrast or Phase Contrast. If 'Phase Contrast' is selected, please indicate the used Phase Contrast Mode under the field phaseContrastMode.",
"enum": [
"Absorption Contrast",
"Phase Contrast"
],
"type": "string"
},
"endAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - End angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then endAngle is 180\u00b0. Typical unit - degree."
},
"largeFOV": {
"description": "(Required) - To be set to true if large field of view or wide field of view is used.",
"type": "boolean"
},
"numberOfProjections": {
"description": "(Required) - Number of projections acquired during the CT.",
"type": "number"
},
"phaseContrastMode": {
"description": "(Optional) - The phase contrast mode used during acquisition - Zernike phase contrast, propagation-based, grating-based(Hartmann), grating-based(Talbot).",
"enum": [
"Zernike phase contrast",
"Propagation-based",
"Grating-based(Hartmann)",
"Grating-based(Talbot)"
],
"type": "string"
},
"referenceImages": {
"additionalProperties": false,
"description": "(Optional) - Details on the reference images (if used) - number of flats/bright images and number of dark images.",
"properties": {
"numberOfBrightImages": {
"description": "(Optional) - Number of flats or bright images used as reference.",
"type": "number"
},
"numberOfDarkImages": {
"description": "(Optional) - Number of dark images used as reference.",
"type": "number"
}
},
"type": "object"
},
"scanningMode": {
"description": "(Optional) - The scanning mode used during acquisition - helical, raster scanning, fast CT.",
"enum": [
"Helical",
"Raster Scanning",
"Fast CT"
],
"type": "string"
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Start angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then startAngle is -180\u00b0. Typical unit - degree."
},
"totalAcquisitionTime": {
"description": "(Required) - Time taken for acquisition for the entire scan. This is the total scan time, i.e. number of projections multipled by exposure time, but including read-out time. calculated as EndTime-StartTime. Format: hh:mm:ss.",
"format": "time",
"pattern": "^(\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?)$",
"type": "string"
},
"useBadPixelMap": {
"description": "(Optional) - To be set to true if bad pixel map is used. This parameter is relevant for SEM based CT.",
"type": "boolean"
}
},
"required": [
"acquisitionScriptName",
"startAngle",
"endAngle",
"angularStepSize",
"acquisitionTimePerProjection",
"totalAcquisitionTime",
"largeFOV",
"contrastType"
],
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian) of datatype string.",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"angleSet": {
"additionalProperties": false,
"description": "(Optional) - Tilt angles alpha, beta and gamma decribing the three angular positions of an item.",
"properties": {
"alpha": {
"description": "(Optional) - Tilt angle alpha of the item.",
"type": "number"
},
"anglesUnit": {
"description": "(Optional) - unit of the angles (allowed units - degree or radian)",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"beta": {
"description": "(Optional) - Rotation angle beta of the item.",
"type": "number"
},
"gamma": {
"description": "(Optional) - Angle gamma of the item.",
"type": "number"
}
},
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A).",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"data": {
"additionalProperties": false,
"description": "(Required) - Details about the data section of the measurement.",
"properties": {
"projections": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"cropping": {
"additionalProperties": false,
"description": "(Optional) - Details about cropping or clipping to select a region of interest(ROI).",
"properties": {
"ROI": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The size of the region of interest (ROI) in integer values of xPixels and yPixels."
},
"offset": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The offset applied to the origin (i.e., centre of the image) to select the region of interest in x and y coordinates."
}
},
"required": [
"ROI",
"offset"
],
"type": "object"
},
"projectionImageDataStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the data structure of the image data of the projections.",
"properties": {
"IOValue": {
"description": "(Required) - The IO value obtained from the metadata.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The dimension of the image as for integer values of xPixels and yPixels."
},
"fileLocation": {
"description": "(Required) - The location where the data file is stored. A URL is preferred if available.",
"type": "string"
},
"greyValueRepresentation": {
"description": "(Optional) - Description about the grey value representation.",
"type": "string"
},
"header": {
"additionalProperties": false,
"description": "(Required) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Required) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"imageCorrection": {
"additionalProperties": false,
"description": "(Optional) - Details about the image correction.",
"properties": {
"isImageCorrected": {
"description": "(Required) - To be set as true if image is corrected.",
"type": "boolean"
},
"linkToReferenceImages": {
"description": "(Required) - Link to the reference images (flats/darks).",
"format": "uri-reference",
"type": "string"
}
},
"required": [
"isImageCorrected",
"linkToReferenceImages"
],
"type": "object"
},
"imageFormats": {
"additionalProperties": false,
"description": "(Required) - The file formats of the images - tiff, png, jpeg. When more than one file formats are there, then the formats are to be entered as an array of strings.",
"properties": {
"fileFormats": {
"oneOf": [
{
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
{
"items": {
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"fileFormats"
],
"type": "object"
},
"imageID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the Image Data."
},
"isPreFiltered": {
"description": "(Optional) - To be set as true if image is prefiltered.",
"type": "boolean"
},
"name": {
"description": "(Required) - Name of the Projection Image Data.",
"type": "string"
},
"numberOfImages": {
"description": "(Required) - Number of images in the data set. It is same as the number of projections.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical x,y length imaged by a single pixel, normally expressed in \u00b5m."
}
},
"required": [
"fileLocation",
"name",
"imageFormats",
"header"
],
"type": "object"
}
},
"required": [
"projectionImageDataStructure"
],
"type": "object"
},
"reconstructedData": {
"additionalProperties": false,
"description": "(Required) - Details about the reconstructed slices. When multiple reconstructions of the same raw data (projections) are present, the corresponding data can be combined as an array of reconstruction data sets, else as a single reconstruction data set.",
"properties": {
"reconstruction": {
"oneOf": [
{
"$ref": "#/$defs/reconstruction"
},
{
"items": {
"$ref": "#/$defs/reconstruction"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"reconstruction"
],
"type": "object"
}
},
"required": [
"projections",
"reconstructedData"
],
"type": "object"
},
"detector": {
"additionalProperties": false,
"description": "gives the settings of a detector or multiple detectors.",
"properties": {
"detectorSettings": {
"oneOf": [
{
"$ref": "#/$defs/detectorSettings"
},
{
"items": {
"$ref": "#/$defs/detectorSettings"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"detectorSettings"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "(Required) - Gives the settings of a single detector.",
"properties": {
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each pixel or voxel in an image. The bit depth determines the number of possible intensity levels that can be assigned to each pixel or voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"cameraGain": {
"description": "(Optional) - The amplification (gain) of the signal from an image sensor in a camera.",
"type": "number"
},
"detectorCoolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Cooling temperature of the detector, if it cooled. Relevant for SEM based CT. Typical unit - K."
},
"detectorDimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Optional) - The dimensions of the detector in integer values of xPixels and yPixels."
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector."
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the detector (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"detectorMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - The motor positions of the detector in cartesian coordinates and tilt angles."
},
"detectorName": {
"description": "(Optional) - Name of the detector of datatype string.",
"type": "string"
},
"detectorPixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical length in cartesian coordinates imaged by a single pixel of the detector. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"detectorType": {
"description": "(Optional) - The type of detector to be selected from a controlled list consisting of CCD, Panel, PCXD, CMOS, Time-Delay Integration (TDI) and Direct Conversion.",
"enum": [
"CCD",
"Panel",
"PCXD",
"CMOS",
"Time-Delay Integration (TDI)",
"Direct Conversion"
],
"type": "string"
},
"energyThreshold": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - A specific energy level used to filter the detected radiation."
},
"exposureTimePerFrame": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Time for which the sample is exposed per frame. Typical unit - s."
},
"frameSkip": {
"additionalProperties": false,
"description": "(Optional) - A numerical representation indicating the number of frames that are skipped or omitted during the acquisition or recording process. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3. If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped.",
"properties": {
"value": {
"oneOf": [
{
"description": "(Optional) - Number of frames skipped during acquisition. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3.",
"type": "number"
},
{
"description": "(Optional) - Pattern of frames skipped during acquisition. E.g. - If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped like [1,3,5]",
"items": {
"type": "number"
},
"minItems": 1,
"type": "array"
}
]
}
},
"type": "object"
},
"framesPerSecond": {
"description": "(Optional) - The number of frames captured in a second.",
"type": "number"
},
"imagePixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical length in cartesian coordinates imaged by a single pixel of the image. It is the native pixel size divided by the total magnification. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"lens": {
"additionalProperties": false,
"description": "(Optional) - Details of a lens, if used with the detector.",
"properties": {
"hasLens": {
"description": "(Required) - To be set to true if the detector has a lens.",
"type": "boolean"
},
"lensFocalLength": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Focal length of the lens."
},
"lensID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the lens."
},
"lensMagnification": {
"description": "(Optional) - Magnification of the lens as a floating point number.",
"type": "number"
},
"lensManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the lens (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"lensName": {
"description": "(Optional) - Name of the lens of datatype string.",
"type": "string"
}
},
"required": [
"lensMagnification",
"lensFocalLength"
],
"type": "object"
},
"numberOfAveragedFramesPerProjection": {
"description": "(Optional) - The number of averaged frames per projection, if averaging is done.",
"type": "number"
},
"sensor": {
"additionalProperties": false,
"description": "(Optional) - Details about a sensor, if present.",
"properties": {
"hasSensor": {
"description": "(Required) - To be set to true if the detector has a sensor.",
"type": "boolean"
},
"sensorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the sensor."
},
"sensorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the sensor (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"sensorMaterial": {
"description": "(Optional) - Material of the sensor of datatype string.",
"type": "string"
},
"sensorName": {
"description": "(Optional) - Name of the sensor of datatype string.",
"type": "string"
},
"sensorThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the sensor."
},
"sensorType": {
"description": "(Optional) - The type of sensor as a string.",
"type": "string"
}
},
"required": [
"hasSensor"
],
"type": "object"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Temperature of the detector."
},
"totalCountsPerProjection": {
"description": "(Optional) - The sum of the intensity values recorded by the X-ray detector for a single projection during a scan.",
"type": "number"
}
},
"required": [
"detectorType",
"detectorManufacturer",
"binning",
"detectorMotorPositions",
"imagePixelSize"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m).",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ).",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min). Typical unit - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"geometry": {
"additionalProperties": false,
"description": "Describes the geometry of the CT instrument",
"properties": {
"beamGeometry": {
"additionalProperties": false,
"description": "(Required) - Details about beam geometry like beam geometry type and divergence angle.",
"properties": {
"beamGeometryType": {
"description": "(Required) - The type of the beam geometry to be selected between 'collimated' and 'divergent'.",
"enum": [
"collimated",
"divergent"
],
"type": "string"
},
"divergenceAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Angle of divergence when the beam geometry is divergent. Typical unit - degree."
}
},
"type": "object"
},
"geometricMagnification": {
"description": "(Required) - Geometric magnification refers to the ratio of the size of an object's image to the size of the object itself. It is a measure of how much larger the image appears compared to the actual object. Geometric magnification (M) is calculated using the formula M = (SID + SOD) / SID, where SID is the source-to-image distance and SOD is the source-to-object distance.",
"type": "number"
},
"objectToDetectorDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the object and the detector. Typical unit - \u00b5m."
},
"opticalMagnification": {
"description": "(Required) - Optical magnification is calculated as the ratio of the focal length of the objective lens to the focal length of the eyepiece (if an eyepiece is present) in a traditional optical microscope.",
"type": "number"
},
"sourceToObjectDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the source and the object. Typical unit - \u00b5m."
}
},
"required": [
"sourceToObjectDistance",
"objectToDetectorDistance",
"beamGeometry",
"geometricMagnification",
"opticalMagnification"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"CTAquisition": {
"$ref": "#/$defs/CTAquisition",
"description": "(Optional) - Details regarding the acquisition."
},
"calibration": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the calibration and the scaling factor.",
"properties": {
"calibrationType": {
"description": "(Optional) - Type of calibration as a string.",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (YYYY-MM-DDThh:mm:ss.sss) in the ISO 8601 date-time format",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z?)$",
"type": "string"
},
"systemScaling": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scaling factor.",
"properties": {
"adjustSystemScaling": {
"description": "(Required) - To be set to true if system scaling is adjusted, else false.",
"type": "boolean"
},
"measuredScalingFactor": {
"description": "(Optional) - Value of the measured scaling factor.",
"type": "number"
},
"referenceScalingFactor": {
"description": "(Optional) - Value of the reference scaling factor, determined ususally during the data processing.",
"type": "number"
}
},
"required": [
"adjustSystemScaling"
],
"type": "object"
}
},
"type": "object"
},
"detector": {
"$ref": "#/$defs/detector",
"description": "(Optional) - Details regarding the detector."
},
"focalSpotMode": {
"additionalProperties": false,
"description": "(Optional) - Option for setting the size of the focal spot. Some sources have the option to select the target spot size, or focal spot size absolutely by setting a value, while some others give the option of selecting 'small', 'medium' or 'large'. Smaller spot size = higher resolution. Note that the power/current will change with this value. In addition, the detector settings will usually be selected in conjunction. (different scintillator/lens/magnification).",
"properties": {
"selection": {
"description": "(Optional) - Selection of the setting of the size of the focal spot when the option for setting the size of the focal spot by selecting 'small', 'medium' or 'large' according to predefined values set by the manufacturer.",
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the target spot when the option for setting the size of the focal spot absolutely by setting a value is available."
}
},
"type": "object"
},
"geometry": {
"$ref": "#/$defs/geometry",
"description": "(Optional) - Details regarding the geometry."
},
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"optics": {
"$ref": "#/$defs/optics",
"description": "(Optional) - Details about the optics and individual motor positions."
},
"sampleStage": {
"$ref": "#/$defs/sampleStage",
"description": "(Optional) - Details regarding the sample stage."
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray target in an SEM based CT set-up.",
"properties": {
"SEMManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the scanning electron microscope used for SEM based CT."
},
"SEMName": {
"description": "(Optional) - Name of the scanning electron microscope used for SEM based CT.",
"type": "string"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the material which acts as the cathode in SEM based CT",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details of the pressure maintained in the chamber of the SEM."
},
"electronBeamShift": {
"additionalProperties": false,
"description": "(Optional) - The distance by which the electron beam is shifted in the x and y directions.",
"properties": {
"xShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Beam shift in the x direction. Typical unit - \u00b5m."
},
"yShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Beam shift in the y direction. Typical unit - \u00b5m."
}
},
"type": "object"
},
"electronProbeCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required) - The electron current measured at the probe. Typical unit - \u00b5A."
},
"objectiveLensAperture": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). Typically the diameter of the aperture is set in \u00b5m."
},
"target": {
"additionalProperties": false,
"description": "(Required) - Details regarding the target in SEM based CT, which upon interaction with the e-beam produces the X-rays.",
"properties": {
"targetDriftCorrection": {
"description": "(Required) - If drift correction is activated for the target, this parameter has to be set to true.",
"type": "boolean"
},
"targetMaterial": {
"description": "(Required) - Material with which the target is made.",
"type": "string"
},
"targetShape": {
"description": "(Optional) - Description of the shape or geometry of the target. e.g. - bulk, foil, needle.",
"type": "string"
},
"targetThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Thickness of the target (dimension in Z direction). Default unit - \u00b5m."
},
"targetTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the target is tilted. Typical unit - degree."
}
},
"required": [
"targetMaterial",
"targetThickness",
"targetDriftCorrection",
"targetTiltAngle"
],
"type": "object"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - Acceleration Voltage set in the SEM. Default unit - kV."
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. In SEM based CT, the beam is focussed on the target material which emits the X-rays upon interaction with the electrons. Default unit - \u00b5m."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray energy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Optional) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"xrayCharacteristicLine": {
"description": "(Optional) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"workingDistance",
"objectiveLensAperture",
"electronProbeCurrent",
"voltage",
"target"
],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
},
"targetCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current measured at the X-ray target, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"sourceDrift": {
"additionalProperties": false,
"description": "(Optional) - Distance by which the source is shifted during the measurement (i.e., end position - start position).",
"properties": {
"xDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the x direction. Typical unit - \u00b5m."
},
"yDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xDrift",
"yDrift"
],
"type": "object"
},
"sourcePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the source."
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray energy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source",
"focalSpotMode",
"CTAquisition",
"geometry",
"sampleStage",
"detector"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer.",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"bioReactor": {
"additionalProperties": false,
"description": "(Optional) - Details of an in situ bioreactor.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in sterile conditions.",
"type": "boolean"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is decreased. Typical unit - K/min."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is increased, typically in K/min."
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"anvil": {
"description": "(Optional) - The type of anvil used in the in situ load frame (stage) for applying a particular type of force on the sample. Option to be selected from a controlled list consisting of - Compression, Diamond indentation 90\u00b0 cone, Diamond indentation cube corner, Diamond indentation wedge, Tension, Other. If 'Other' is selected, specify the name of the anvil with a description in the field 'otherAnvil'.",
"enum": [
"Compression",
"Diamond indentation 90\u00b0 cone",
"Diamond indentation cube corner",
"Diamond indentation wedge",
"Tension",
"Other"
],
"type": "string"
},
"blindAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - ed by the load frame(stage). Example: for a CT normally scanned over 180\u00b0 (e.g. -90\u00b0/+90\u00b0), a blind angle of 40\u00b0 due to the in situ cell implies that only 180\u00b0-40\u00b0=140\u00b0 (e.g. -70\u00b0/70\u00b0) is visible. NOTE: for a CT normally scanned over 360\u00b0 (e.g. -180\u00b0/+180\u00b0), a blind angle of 40\u00b0 would require the subtraction of the blind angle twice, implying two scan ranges of 140\u00b0 each (e.g. -160\u00b0/-20\u00b0 and +20\u00b0/+160\u00b0). Typical unit - degree."
},
"displacement": {
"additionalProperties": false,
"description": "(Optional) - Specification on how displacement is applied on the sample. Either 'displacementRate' in \u00b5m/min or 'displacementIncrement' in \u00b5m/acquisition need to be selected.",
"properties": {
"displacementIncrement": {
"description": "(Optional) - The step at which displacement is changed per acquisition in \u00b5m/acquisition.",
"type": "number"
},
"displacementRate": {
"description": "(Optional) - The rate at which displacement is applied on the sample in \u00b5m/min.",
"type": "number"
}
},
"type": "object"
},
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame or anvil (e.g. - size of anvil) relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
},
"maximumDisplacement": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - The maximum displacement allowed in the selected configuration. Typical unit - \u00b5m."
},
"maximumForce": {
"description": "(Optional) - The maximum force that can be applied to the sample in N.",
"type": "number"
},
"otherAnvil": {
"description": "(Optional) - If 'anvil' was selected as 'Other' from the controlled list as it was not listed, please specify the name of the anvil with a description in this field.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the vacuum chamber relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the vacuum chamber relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the vacuum chamber."
},
"chamberName": {
"description": "(Optional) - Name of the vacuum chamber.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"motorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchical level and direction of a motor.",
"properties": {
"motorDirection": {
"description": "(Required) - The direction of movement (for X,Y,Z,M motors) or axis of rotation (for rotating motors) expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the X-stage and perpendicular to the Y-stage. then beam direction = [1 0 0], X-stage-direction = [1 0 0] (positive movement direction away from source towards detector) or can be (-1 0 0) (towards source) and Y-stage-direction = [0 1 0] or can be [0 -1 0] (analogous interpretation). The parameters need to be individually determined for each instrument. For rotating motors, the directional vector of axis of rotation should be given in Cartesian coordinates (counterclockwise, right-hand rule).",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"motorLevel": {
"description": "(Required) - Hierarchy of the motor expressed as an integer.",
"type": "number"
}
},
"type": "object"
},
"motorPositions": {
"additionalProperties": false,
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the motor.",
"properties": {
"angles": {
"$ref": "#/$defs/angleSet",
"description": "(Optional) - The three tilt angles alpha, beta and gamma of the motors controlling the position of the item."
},
"xyzPositions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - The xyz coordinates describing the motor positions of the item."
}
},
"type": "object"
},
"optics": {
"additionalProperties": false,
"description": "(Optional) - Details about the optics and individual motor positions.",
"properties": {
"collimator": {
"additionalProperties": false,
"description": "(Optional) - Details about the collimator and its individual motor positions.",
"properties": {
"collimatorDetails": {
"description": "(Optional) - Details about the collimator relevant for the measurement.",
"type": "string"
},
"collimatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the collimator."
}
},
"type": "object"
},
"condenser": {
"additionalProperties": false,
"description": "(Optional) - Details about the condenser lens and its individual motor positions, if used.",
"properties": {
"condenserDetails": {
"description": "(Optional) - Details about the condenser relevant for the measurement.",
"type": "string"
},
"condenserPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the condenser."
}
},
"type": "object"
},
"fresnelZonePlate": {
"additionalProperties": false,
"description": "(Optional) - Details about the fresnel zone plate and its individual motor positions, if used.",
"properties": {
"fresnelZonePlateDetails": {
"description": "(Optional) - Details about the fresnel zone plate relevant for the measurement.",
"type": "string"
},
"fresnelZonePlatePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the fresnel zone plate."
}
},
"type": "object"
},
"monochromator": {
"additionalProperties": false,
"description": "(Required) - Details about the monochromator and individual motor positions, if used.",
"properties": {
"monochromatorDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the monochromator type type, material, energy and notes.",
"properties": {
"energy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Energy set in the monochromator. Typical unit - eV."
},
"material": {
"description": "(Optional) - Material of the monochromator.",
"type": "string"
},
"monochromatorType": {
"description": "(Optional) - Type of the monochromator.",
"type": "string"
},
"notes": {
"description": "(Optional) - Additional information about the monochromator relevant for the measurement."
}
},
"type": "object"
},
"monochromatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the monochromator."
},
"monochromatorUsed": {
"description": "(Required) - To be set to true if monochromator is used, else false.",
"type": "boolean"
}
},
"required": [
"monochromatorUsed"
],
"type": "object"
},
"phaseRing": {
"additionalProperties": false,
"description": "(Required) - Details about the phase ring and its individual motor positions, if inserted.",
"properties": {
"phaseRingDetails": {
"description": "(Optional) - Details about the phase ring relevant for the measurement.",
"type": "string"
},
"phaseRingPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the phase ring."
}
},
"type": "object"
}
},
"required": [
"monochromator"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes a parameter which can be split into number of pixels in x and y directions like the resolution",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm or \u00b5m, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the size of a single pixel (typical value - nm, \u00b5m) of datatype string",
"enum": [
"nm",
"\u00b5m"
],
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min).",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW).",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi).",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"rampDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a rate at which temperature is increased or decreased.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K/min, K/s).",
"enum": [
"K/min",
"K/s"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of temperature increase or decrease.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"reconstruction": {
"additionalProperties": false,
"description": "Data from one single reconstruction.",
"properties": {
"reconstructionDetails": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"additionalFilters": {
"beamHardeningCorrection": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"filterType": {
"description": "(Optional) - Type of the additional filter - Median or Gauss",
"enum": [
"Median",
"Gauss"
],
"type": "string"
},
"phaseRetrieval": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"ringFilter": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
}
},
"algorithm": {
"description": "(Required) - Algorithm used for reconstruction to be selected from FBP - Filtered Back Projection, ART - Algebraic Reconstruction Technique, 3dCT - 3D Computed Tomography and Gridrec.",
"enum": [
"FBP - Filtered Back Projection",
"ART - Algebraic Reconstruction Technique",
"3dCT - 3D Computed Tomography",
"Gridrec"
],
"type": "string"
},
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepthConversionMax": {
"description": "(Required) - Maximum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"bitDepthConversionMin": {
"description": "(Required) - Minimum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"hardwarePlatform": {
"description": "(Optional) - Hardware platform used for reconstruction to be selected between CPU and GPU.",
"enum": [
"CPU",
"GPU"
],
"type": "string"
},
"lastImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the last image for the reconstruction of the 3D Volume, typically an integer.",
"type": "string"
},
"projectionPadding": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the projection padding applied to the raw projection data to address certain issues in the reconstruction process.",
"properties": {
"paddingSize": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - Size of the projection padding used in pixels."
},
"paddingType": {
"description": "(Required) - Type of the projection padding used - Zero Padding, Linear Interpolation Padding, Sinc Interpolation Padding, Shepp-Logan Filtered Back Projection (SL-FBP), Gridding and Extended Field of View (FOV) Padding.",
"enum": [
"Zero Padding",
"Linear Interpolation Padding",
"Sinc Interpolation Padding",
"Shepp-Logan Filtered Back Projection (SL-FBP)",
"Gridding",
"Extended Field of View (FOV) Padding"
],
"type": "string"
}
},
"type": "object"
},
"reconstructionSoftware": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for reconstruction. It may be the same as the acquisition software or a different one."
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Scan angle at which the reconstruction of the 3D Volume starts. Typical unit - degree."
},
"startImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the start image for the reconstruction of the 3D Volume.",
"type": "string"
},
"tomographicProjectionFilter": {
"description": "(Optional) - Name of the tomographic projection filter used to be selected from Ram-Lak Filter, Butterworth Filter, Shepp-Logan Filter, Hann (Hanning) Filter, Gaussian Filter, Cosine Filter, Soft Filtration Method and Hard Filtration Method.",
"enum": [
"Ram-Lak Filter",
"Butterworth Filter",
"Shepp-Logan Filter",
"Hann (Hanning) Filter",
"Gaussian Filter",
"Cosine Filter",
"Soft Filtration Method",
"Hard Filtration Method"
],
"type": "string"
}
},
"required": [
"startImage",
"lastImage",
"startAngle",
"hardwarePlatform",
"algorithm",
"binning"
],
"type": "object"
},
"volumeStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each voxel in the 3D volume. The bit depth determines the number of possible intensity levels that can be assigned to each voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Required) - The dimension of the 3D volume in XYZ coordinates. If the length in Z dimension is not known and instead only the number of slices are known, they need to be separately entered in the field 'numberOfSlices'. Typical unit - \u00b5m."
},
"header": {
"additionalProperties": false,
"description": "(Optional) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Optional) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"name": {
"description": "(Required) - Name of the 3D volume structure (dataset).",
"type": "string"
},
"numberOfSlices": {
"description": "(Optional) - No. of slices which make up the 3D volume.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel/voxel, normally expressed in \u00b5m."
},
"volumeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry of the 3D reconstructed volume usually provided by the project or the laboratory."
}
},
"required": [
"name",
"dimensions",
"bitDepth",
"pixelSize"
],
"type": "object"
}
},
"required": [
"volumeStructure",
"reconstructionDetails"
],
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"sampleStage": {
"additionalProperties": false,
"description": "(Required) - Details about sample stage.",
"properties": {
"stageMotorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchy of the stage motors. This information is required to know how the motor movements affect the positions of the samples, particularly relevant for correlative characterization.",
"properties": {
"beamDirection": {
"description": "(Required) - The beam direction expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the Y-stage and perpendicular to the X-stage. then beam direction = [0 1 0].",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"mMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the M motor (stage) as a vector in cartesian coordiantes. The M motor is usually relevant only for SEM based CT. It is a special motor which counteracts the Z motor."
},
"rMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the R motor (stage) as a vector in cartesian coordiantes. R motor has rotation around z axis +1 (for anticlockwise)."
},
"tMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the T motor (stage) as a vector in cartesian coordiantes. The T motor is usually relevant only for SEM based CT."
},
"xMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the X motor (stage) as a vector in cartesian coordinates."
},
"yMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Y motor (stage) as a vector in cartesian coordinates."
},
"zMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Z motor (stage) as a vector in cartesian coordinates."
}
},
"required": [
"beamDirection",
"xMotor",
"yMotor",
"zMotor",
"rMotor"
],
"type": "object"
},
"stageMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the stage motors."
}
},
"required": [
"stageMotorHierarchy"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s).",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"user": {
"description": "Basic schema for user description. It can be extended.",
"properties": {
"ORCID": {
"description": "(Optional) - Open Researcher and Contributor ID expressed as a URI",
"pattern": "^https://orcid\\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[X0-9]{1}$",
"type": "string"
},
"affiliation": {
"description": "(Optional) - Details of the institution to which the user is affiliated",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"description": "(Optional) -Identifier of the institution to which the user is affiliated",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be chosen from a controlled list of values (*ROR *GRID *ISNI *URL *DOI *Handle)",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"email": {
"description": "(Optional) - Email of the user",
"format": "email",
"type": "string"
},
"familyName": {
"description": "(Optional) - Family name of the user",
"type": "string"
},
"givenName": {
"description": "(Optional) - Given name of the user",
"type": "string"
},
"role": {
"description": "(Required) - Role of the research user",
"enum": [
"Data Curator",
"Instrument Scientist",
"Team Leader",
"Team Member"
],
"type": "string"
},
"userName": {
"description": "(Required) - Full name of the user in the format (Family Name, Given Name)",
"type": "string"
}
},
"required": [
"userName",
"role"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV).",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided. Contributors (in alphabetical order of last names): Alexey Boubnov, Rafaela Debastiani, Jonas Fell, Sarah Irvine, Reetu Elza Joseph.",
"properties": {
"consumables": {
"description": "(Optional) - Auxiliary entity used during Fabrication, Sample Preparation or Measurement which has a limited time capacity or is limited in its number of uses before it is disposed of, necessary to the process itself and normally bought from third party manufacturers. Examples are: gloves, syringes, wipes, etching solutions, glass slides, spatulas, weighing paper, two-sided tape.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"data": {
"$ref": "#/$defs/data",
"description": "(Required)- Details concerning the data section of the measurement."
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format YYYY-MM-DDThh:mm:ss.sss.",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z?)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry usually provided by the project or the laboratory."
},
"equipment": {
"description": "(Optional) - Any kind of physical or virtual item, device, machine or other tools used to perform one or more Fabrication(s), Sample Preparation(s), Model Preparation(s), Data Acquisition(s) and/or any of the processes included in the Data Analysis Lifecycle. Usually, the Equipment is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. Equipment is usually an investment. According to this definition, an Instrument is a particular type of Equipment.",
"type": "string"
},
"experimentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the measurement usually provided by the project or the laboratory."
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings. Instrument is a physical or virtual identifiable piece of Equipment used to perform a Data Acquisition and to generate Raw Data. The Instrument is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. A virtual Instrument may be any computational resource or HPC infrastructure (cloud infrastructure or supercomputer) needed to perform Calculations or Simulations."
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure."
},
"measurementDescription": {
"description": "(Optional) - Description about the measurement.",
"type": "string"
},
"measurementPurpose": {
"description": "(Required) - Measurement is experimental Data Acquisition, typically performed on a Sample using an experimental Technique. It may also be performed during Fabrication or Sample Preparation, e.g., to characterise the intermediate stages and/or the final resulting Precursor(s) or Sample(s), respectively. A Measurement may require the use of Consumables.",
"enum": [
"assessment (to given categories or values)",
"completeness check (presence or absence of given properties)",
"correlative characterization (dedicated sample treatment to emphasise given features)",
"exploratory (routine check of known properties)",
"feasibility (quick check, rough estimate)",
"high quality measurement (precise, careful treatment)",
"test specific hypothesis (focus only on given aspects)",
"other (please specify in the comment)"
],
"type": "string"
},
"parents": {
"description": "(Required) - Parents of this metadata like the metadata document of the sample with which the measurement was performed.",
"items": {
"if": {
"properties": {
"parentType": {
"not": {
"const": "not applicable"
}
}
}
},
"properties": {
"parentReference": {
"description": "If type is 'MetaStore URI' it is possible to easily fill this field in a later stage",
"format": "uri-reference",
"type": "string"
},
"parentReferenceType": {
"default": "MetaStore URI",
"enum": [
"plain text",
"external URL",
"MetaStore URI"
],
"type": "string"
},
"parentType": {
"default": "sample",
"enum": [
"not applicable",
"sample"
],
"type": "string"
}
},
"required": [
"parentType"
],
"then": {
"required": [
"parentReferenceType",
"parentReference"
]
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition."
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format."
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format YYYY-MM-DDThh:mm:ss.sss.",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z?)$",
"type": "string"
},
"technique": {
"description": "(Required) - Any experimental, theoretical or computational method used during Data Acquisition or during any of the processes included in the Data Analysis Lifecycle to acquire, process or analyse Research Data about a System or a set of them with an Instrument, which is used to generate this metadata.",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement.",
"type": "string"
},
"user": {
"$ref": "#/$defs/user",
"description": "(Required)- The contact information of the user responsible for the measurement."
}
},
"required": [
"title",
"technique",
"parents",
"measurementPurpose",
"startTime",
"endTime",
"program",
"user",
"instrument",
"data"
],
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 11b879587f4bff1b7801e535d1f1fad7226948f8 | 2023-12-15T08:25:57 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"CTAquisition": {
"additionalProperties": false,
"description": "(Required) - Details about the acquisition.",
"properties": {
"acquisitionScriptName": {
"description": "(Required) - Name of the script used for acquisition.",
"type": "string"
},
"acquisitionTimePerProjection": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time taken for acquisition of a single projection. Typical unit - s."
},
"angularStepSize": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Step size of the rotation of the sample during the CT. Typical unit - degree."
},
"contrastType": {
"description": "(Required) - The contrast type(mode) used - Absorption Contrast or Phase Contrast. If 'Phase Contrast' is selected, please indicate the used Phase Contrast Mode under the field phaseContrastMode.",
"enum": [
"Absorption Contrast",
"Phase Contrast"
],
"type": "string"
},
"endAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - End angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then endAngle is 180\u00b0. Typical unit - degree."
},
"largeFOV": {
"description": "(Required) - To be set to true if large field of view or wide field of view is used.",
"type": "boolean"
},
"numberOfProjections": {
"description": "(Required) - Number of projections acquired during the CT.",
"type": "number"
},
"phaseContrastMode": {
"description": "(Optional) - The phase contrast mode used during acquisition - Zernike phase contrast, propagation-based, grating-based(Hartmann), grating-based(Talbot).",
"enum": [
"Zernike phase contrast",
"Propagation-based",
"Grating-based(Hartmann)",
"Grating-based(Talbot)"
],
"type": "string"
},
"referenceImages": {
"additionalProperties": false,
"description": "(Optional) - Details on the reference images (if used) - number of flats/bright images and number of dark images.",
"properties": {
"numberOfBrightImages": {
"description": "(Optional) - Number of flats or bright images used as reference.",
"type": "number"
},
"numberOfDarkImages": {
"description": "(Optional) - Number of dark images used as reference.",
"type": "number"
}
},
"type": "object"
},
"scanningMode": {
"description": "(Optional) - The scanning mode used during acquisition - helical, raster scanning, fast CT.",
"enum": [
"Helical",
"Raster Scanning",
"Fast CT"
],
"type": "string"
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Start angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then startAngle is -180\u00b0. Typical unit - degree."
},
"totalAcquisitionTime": {
"description": "(Required) - Time taken for acquisition for the entire scan. This is the total scan time, i.e. number of projections multipled by exposure time, but including read-out time. calculated as EndTime-StartTime. Format: hh:mm:ss.",
"format": "time",
"pattern": "^(\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?)$",
"type": "string"
},
"useBadPixelMap": {
"description": "(Optional) - To be set to true if bad pixel map is used. This parameter is relevant for SEM based CT.",
"type": "boolean"
}
},
"required": [
"acquisitionScriptName",
"startAngle",
"endAngle",
"angularStepSize",
"acquisitionTimePerProjection",
"totalAcquisitionTime",
"largeFOV",
"contrastType"
],
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "degree",
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"angleSet": {
"additionalProperties": false,
"description": "(Optional) - Tilt angles alpha, beta and gamma decribing the three angular positions of an item.",
"properties": {
"alpha": {
"description": "(Optional) - Tilt angle alpha of the item.",
"type": "number"
},
"anglesUnit": {
"default": "degree",
"description": "(Optional) - unit of the angles (allowed units - degree or radian)",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"beta": {
"description": "(Optional) - Rotation angle beta of the item.",
"type": "number"
},
"gamma": {
"description": "(Optional) - Angle gamma of the item.",
"type": "number"
}
},
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"default": "\u00b5m",
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "pA",
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string.",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"data": {
"additionalProperties": false,
"description": "(Required) - Details about the data section of the measurement.",
"properties": {
"projections": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"cropping": {
"additionalProperties": false,
"description": "(Optional) - Details about cropping or clipping to select a region of interest(ROI).",
"properties": {
"ROI": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The size of the region of interest (ROI) in integer values of xPixels and yPixels."
},
"offset": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The offset applied to the origin (i.e., centre of the image) to select the region of interest in x and y coordinates."
}
},
"required": [
"ROI",
"offset"
],
"type": "object"
},
"projectionImageDataStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the data structure of the image data of the projections.",
"properties": {
"IOValue": {
"description": "(Required) - The IO value obtained from the metadata.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The dimension of the image as for integer values of xPixels and yPixels."
},
"fileLocation": {
"description": "(Required) - The location where the data file is stored. A URL is preferred if available.",
"type": "string"
},
"greyValueRepresentation": {
"description": "(Optional) - Description about the grey value representation.",
"type": "string"
},
"header": {
"additionalProperties": false,
"description": "(Required) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Required) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"imageCorrection": {
"additionalProperties": false,
"description": "(Optional) - Details about the image correction.",
"properties": {
"isImageCorrected": {
"description": "(Required) - To be set as true if image is corrected.",
"type": "boolean"
},
"linkToReferenceImages": {
"description": "(Required) - Link to the reference images (flats/darks).",
"format": "uri-reference",
"type": "string"
}
},
"required": [
"isImageCorrected",
"linkToReferenceImages"
],
"type": "object"
},
"imageFormats": {
"additionalProperties": false,
"description": "(Required) - The file formats of the images - tiff, png, jpeg. When more than one file formats are there, then the formats are to be entered as an array of strings.",
"properties": {
"fileFormats": {
"oneOf": [
{
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
{
"items": {
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
"type": "array"
}
]
}
},
"required": [
"fileFormats"
],
"type": "object"
},
"imageID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the Image Data."
},
"isPreFiltered": {
"description": "(Optional) - To be set as true if image is prefiltered.",
"type": "boolean"
},
"name": {
"description": "(Required) - Name of the Projection Image Data.",
"type": "string"
},
"numberOfImages": {
"description": "(Required) - Number of images in the data set. It is same as the number of projections.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical x,y length imaged by a single pixel, normally expressed in \u00b5m."
}
},
"required": [
"fileLocation",
"name",
"imageFormats",
"header"
],
"type": "object"
}
},
"required": [
"projectionImageDataStructure"
],
"type": "object"
},
"reconstructedData": {
"additionalProperties": false,
"description": "(Required) - Details about the reconstructed slices. When multiple reconstructions of the same raw data (projections) are present, the corresponding data can be combined as an array of reconstruction data sets, else as a single reconstruction data set.",
"properties": {
"reconstruction": {
"oneOf": [
{
"$ref": "#/$defs/reconstruction"
},
{
"items": {
"$ref": "#/$defs/reconstruction"
},
"type": "array"
}
]
}
},
"required": [
"reconstruction"
],
"type": "object"
}
},
"required": [
"projections",
"reconstructedData"
],
"type": "object"
},
"detector": {
"additionalProperties": false,
"description": "gives the settings of a detector or multiple detectors.",
"properties": {
"detectorSettings": {
"oneOf": [
{
"$ref": "#/$defs/detectorSettings"
},
{
"items": {
"$ref": "#/$defs/detectorSettings"
},
"type": "array"
}
]
}
},
"required": [
"detectorSettings"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "(Required) - Gives the settings of a single detector.",
"properties": {
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each pixel or voxel in an image. The bit depth determines the number of possible intensity levels that can be assigned to each pixel or voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"cameraGain": {
"description": "(Optional) - The amplification (gain) of the signal from an image sensor in a camera.",
"type": "number"
},
"detectorCoolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Cooling temperature of the detector, if it cooled. Relevant for SEM based CT. Typical unit - K."
},
"detectorDimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Optional) - The dimensions of the detector in integer values of xPixels and yPixels."
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector."
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the detector (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"detectorMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - The motor positions of the detector in cartesian coordinates and tilt angles."
},
"detectorName": {
"description": "(Optional) - Name of the detector of datatype string.",
"type": "string"
},
"detectorPixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical length in cartesian coordinates imaged by a single pixel of the detector. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"detectorType": {
"description": "(Optional) - The type of detector to be selected from a controlled list consisting of CCD, Panel, PCXD, CMOS, Time-Delay Integration (TDI) and Direct Conversion.",
"enum": [
"CCD",
"Panel",
"PCXD",
"CMOS",
"Time-Delay Integration (TDI)",
"Direct Conversion"
],
"type": "string"
},
"energyThreshold": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - A specific energy level used to filter the detected radiation."
},
"exposureTimePerFrame": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Time for which the sample is exposed per frame. Typical unit - s."
},
"frameSkip": {
"additionalProperties": false,
"description": "(Optional) - A numerical representation indicating the number of frames that are skipped or omitted during the acquisition or recording process. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3. If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped.",
"properties": {
"value": {
"oneOf": [
{
"description": "(Optional) - Number of frames skipped during acquisition. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3.",
"type": "number"
},
{
"description": "(Optional) - Pattern of frames skipped during acquisition. E.g. - If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped like [1,3,5]",
"items": {
"type": "number"
},
"type": "array"
}
]
}
},
"type": "object"
},
"framesPerSecond": {
"description": "(Optional) - The number of frames captured in a second.",
"type": "number"
},
"imagePixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical length in cartesian coordinates imaged by a single pixel of the image. It is the native pixel size divided by the total magnification. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"lens": {
"additionalProperties": false,
"description": "(Optional) - Details of a lens, if used with the detector.",
"properties": {
"hasLens": {
"description": "(Required) - To be set to true if the detector has a lens.",
"type": "boolean"
},
"lensFocalLength": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Focal length of the lens."
},
"lensID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the lens."
},
"lensMagnification": {
"description": "(Optional) - Magnification of the lens as a floating point number.",
"type": "number"
},
"lensManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the lens (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"lensName": {
"description": "(Optional) - Name of the lens of datatype string.",
"type": "string"
}
},
"required": [
"lensMagnification",
"lensFocalLength"
],
"type": "object"
},
"numberOfAveragedFramesPerProjection": {
"description": "(Optional) - The number of averaged frames per projection, if averaging is done.",
"type": "number"
},
"sensor": {
"additionalProperties": false,
"description": "(Optional) - Details about a sensor, if present.",
"properties": {
"hasSensor": {
"description": "(Required) - To be set to true if the detector has a sensor.",
"type": "boolean"
},
"sensorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the sensor."
},
"sensorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the sensor (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"sensorMaterial": {
"description": "(Optional) - Material of the sensor of datatype string.",
"type": "string"
},
"sensorName": {
"description": "(Optional) - Name of the sensor of datatype string.",
"type": "string"
},
"sensorThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the sensor."
},
"sensorType": {
"description": "(Optional) - The type of sensor as a string.",
"type": "string"
}
},
"required": [
"hasSensor"
],
"type": "object"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Temperature of the detector."
},
"totalCountsPerProjection": {
"description": "(Optional) - The sum of the intensity values recorded by the X-ray detector for a single projection during a scan.",
"type": "number"
}
},
"required": [
"detectorType",
"detectorManufacturer",
"binning",
"detectorMotorPositions",
"imagePixelSize"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ; default value - keV) of datatype string",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"entry": {
"additionalProperties": false,
"description": "Required) - The entry level is the root element of the schema. It contains all the metadata describing a CT measurement.",
"properties": {
"consumables": {
"description": "(Optional) - Auxiliary entity used during Fabrication, Sample Preparation or Measurement which has a limited time capacity or is limited in its number of uses before it is disposed of, necessary to the process itself and normally bought from third party manufacturers. Examples are: gloves, syringes, wipes, etching solutions, glass slides, spatulas, weighing paper, two-sided tape.",
"items": {
"type": "string"
},
"type": "array"
},
"data": {
"$ref": "#/$defs/data",
"description": "(Optional)- Details concerning the data section of the measurement."
},
"definition": {
"description": "(Required) - Name of the schema to which this entry conforms. In this case, lab_CT should be written.",
"type": "string"
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry usually provided by the project or the laboratory."
},
"equipment": {
"description": "(Optional) - Any kind of physical or virtual item, device, machine or other tools used to perform one or more Fabrication(s), Sample Preparation(s), Model Preparation(s), Data Acquisition(s) and/or any of the processes included in the Data Analysis Lifecycle. Usually, the Equipment is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. Equipment is usually an investment. According to this definition, an Instrument is a particular type of Equipment.",
"type": "string"
},
"experimentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the measurement usually provided by the project or the laboratory."
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings. Instrument is a physical or virtual identifiable piece of Equipment used to perform a Data Acquisition and to generate Raw Data. The Instrument is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. A virtual Instrument may be any computational resource or HPC infrastructure (cloud infrastructure or supercomputer) needed to perform Calculations or Simulations."
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure."
},
"measurementDescription": {
"description": "(Optional) - Description about the measurement.",
"type": "string"
},
"measurementPurpose": {
"description": "(Required) - Measurement is experimental Data Acquisition, typically performed on a Sample using an experimental Technique. It may also be performed during Fabrication or Sample Preparation, e.g., to characterise the intermediate stages and/or the final resulting Precursor(s) or Sample(s), respectively. A Measurement may require the use of Consumables.",
"enum": [
"assessment (to given categories or values)",
"completeness check (presence or absence of given properties)",
"correlative characterization (dedicated sample treatment to emphasise given features)",
"exploratory (routine check of known properties)",
"feasibility (quick check, rough estimate)",
"high quality measurement (precise, careful treatment)",
"test specific hypothesis (focus only on given aspects)",
"other (please specify in the comment)"
],
"type": "string"
},
"parents": {
"description": "(Required) - Parents of this metadata like the metadata document of the sample with which the measurement was performed.",
"items": {
"if": {
"properties": {
"parentType": {
"not": {
"const": "not applicable"
}
}
}
},
"properties": {
"parentReference": {
"description": "If type is 'MetaStore URI' it is possible to easily fill this field in a later stage",
"format": "uri-reference",
"type": "string"
},
"parentReferenceType": {
"enum": [
"plain text",
"external URL",
"MetaStore URI"
],
"type": "string"
},
"parentType": {
"enum": [
"not applicable",
"sample"
],
"type": "string"
}
},
"required": [
"parentType"
],
"then": {
"required": [
"parentReferenceType",
"parentReference"
]
},
"type": "object"
},
"type": "array"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition."
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format."
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"technique": {
"description": "(Required) - Any experimental, theoretical or computational method used during Data Acquisition or during any of the processes included in the Data Analysis Lifecycle to acquire, process or analyse Research Data about a System or a set of them with an Instrument, whihc is used to generate this metadata.",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement.",
"type": "string"
},
"user": {
"$ref": "#/$defs/user",
"description": "(Required)- The contact information of the user responsible for the measurement."
}
},
"required": [
"title",
"technique",
"definition",
"parents",
"measurementPurpose",
"startTime",
"endTime",
"program",
"user",
"instrument",
"data"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min) default value - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"geometry": {
"additionalProperties": false,
"description": "Describes the geometry of the CT instrument",
"properties": {
"beamGeometry": {
"additionalProperties": false,
"description": "(Required) - Details about beam geometry like beam geometry type and divergence angle.",
"properties": {
"beamGeometryType": {
"description": "(Required) - The type of the beam geometry to be selected between 'collimated' and 'divergent'.",
"enum": [
"collimated",
"divergent"
],
"type": "string"
},
"divergenceAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Angle of divergence when the beam geometry is divergent. Typical unit - degree."
}
},
"type": "object"
},
"geometricMagnification": {
"description": "(Required) - Geometric magnification refers to the ratio of the size of an object's image to the size of the object itself. It is a measure of how much larger the image appears compared to the actual object. Geometric magnification (M) is calculated using the formula M = (SID + SOD) / SID, where SID is the source-to-image distance and SOD is the source-to-object distance.",
"type": "number"
},
"objectToDetectorDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the object and the detector. Typical unit - \u00b5m."
},
"opticalMagnification": {
"description": "(Required) - Optical magnification is calculated as the ratio of the focal length of the objective lens to the focal length of the eyepiece (if an eyepiece is present) in a traditional optical microscope.",
"type": "number"
},
"sourceToObjectDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the source and the object. Typical unit - \u00b5m."
}
},
"required": [
"sourceToObjectDistance",
"objectToDetectorDistance",
"beamGeometry",
"geometricMagnification",
"opticalMagnification"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"CTAquisition": {
"$ref": "#/$defs/CTAquisition",
"description": "(Optional) - Details regarding the acquisition."
},
"calibration": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the calibration and the scaling factor.",
"properties": {
"calibrationType": {
"description": "(Optional) - Type of calibration as a string.",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (YYYY-MM-DDThh:mm:ss.sss) in the ISO 8601 date-time format",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"systemScaling": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scaling factor.",
"properties": {
"adjustSystemScaling": {
"description": "(Required) - To be set to true if system scaling is adjusted, else false.",
"type": "boolean"
},
"measuredScalingFactor": {
"description": "(Optional) - Value of the measured scaling factor.",
"type": "number"
},
"referenceScalingFactor": {
"description": "(Optional) - Value of the reference scaling factor, determined ususally during the data processing.",
"type": "number"
}
},
"required": [
"adjustSystemScaling"
],
"type": "object"
}
},
"type": "object"
},
"detector": {
"$ref": "#/$defs/detector",
"description": "(Optional) - Details regarding the detector."
},
"focalSpotMode": {
"additionalProperties": false,
"description": "(Optional) - Option for setting the size of the focal spot. Some sources have the option to select the target spot size, or focal spot size absolutely by setting a value, while some others give the option of selecting 'small', 'medium' or 'large'. Smaller spot size = higher resolution. Note that the power/current will change with this value. In addition, the detector settings will usually be selected in conjunction. (different scintillator/lens/magnification).",
"properties": {
"selection": {
"description": "(Optional) - Selection of the setting of the size of the focal spot when the option for setting the size of the focal spot by selecting 'small', 'medium' or 'large' according to predefined values set by the manufacturer.",
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the target spot when the option for setting the size of the focal spot absolutely by setting a value is available."
}
},
"type": "object"
},
"geometry": {
"$ref": "#/$defs/geometry",
"description": "(Optional) - Details regarding the geometry."
},
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"optics": {
"$ref": "#/$defs/optics",
"description": "(Optional) - Details about the optics and individual motor positions."
},
"sampleStage": {
"$ref": "#/$defs/sampleStage",
"description": "(Optional) - Details regarding the sample stage."
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray target in an SEM based CT set-up.",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required) - Details of the pressure maintained in the chamber of the SEM."
},
"electronBeamShift": {
"additionalProperties": false,
"description": "(Required) - The distance by which the electron beam is shifted in the x and y directions.",
"properties": {
"xShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the x direction. Typical unit - \u00b5m."
},
"yShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xShift",
"yShift"
],
"type": "object"
},
"electronProbeCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required) - The electron current measured at the probe. Typical unit - \u00b5A."
},
"objectiveLensAperture": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). Typically the diameter of the aperture is set in \u00b5m."
},
"target": {
"additionalProperties": false,
"description": "(Required) - Details regarding the target in SEM based CT, which upon interaction with the e-beam produces the X-rays.",
"properties": {
"targetDriftCorrection": {
"description": "(Required) - If drift correction is activated for the target, this parameter has to be set to true.",
"type": "boolean"
},
"targetMaterial": {
"description": "(Required) - Material with which the target is made.",
"type": "string"
},
"targetShape": {
"description": "(Optional) - Description of the shape or geometry of the target. e.g. - bulk, foil, needle.",
"type": "string"
},
"targetThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Thickness of the target (dimension in Z direction). Default unit - \u00b5m."
},
"targetTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the target is tilted. Typical unit - degree."
}
},
"required": [
"targetMaterial",
"targetThickness",
"targetDriftCorrection",
"targetTiltAngle",
"targetCurrent"
],
"type": "object"
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. In SEM based CT, the beam is focussed on the target material which emits the X-rays upon interaction with the electrons. Default unit - \u00b5m."
}
},
"required": [
"chamberPressure",
"electronBeamShift",
"workingDistance",
"objectiveLensAperture",
"electronProbeCurrent",
"target"
],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
},
"targetCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current measured at the X-ray target, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"sourceDrift": {
"additionalProperties": false,
"description": "(Optional) - Distance by which the source is shifted during the measurement (i.e., end position - start position).",
"properties": {
"xDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the x direction. Typical unit - \u00b5m."
},
"yDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xDrift",
"yDrift"
],
"type": "object"
},
"sourcePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the source."
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray enrgy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source",
"focalSpotMode",
"CTAquisition",
"geometry",
"sampleStage",
"detector"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer.",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"bioReactor": {
"additionalProperties": false,
"description": "(Optional) - Details of an in situ bioreactor.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in sterile conditions.",
"type": "boolean"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is decreased. Typical unit - K/min."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is increased, typically in K/min."
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"anvil": {
"description": "(Optional) - The type of anvil used in the in situ load frame (stage) for applying a particular type of force on the sample. Option to be selected from a controlled list consisting of - Compression, Diamond indentation 90\u00b0 cone, Diamond indentation cube corner, Diamond indentation wedge, Tension, Other. If 'Other' is selected, specify the name of the anvil with a description in the field 'otherAnvil'.",
"enum": [
"Compression",
"Diamond indentation 90\u00b0 cone",
"Diamond indentation cube corner",
"Diamond indentation wedge",
"Tension",
"Other"
],
"type": "string"
},
"blindAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - ed by the load frame(stage). Example: for a CT normally scanned over 180\u00b0 (e.g. -90\u00b0/+90\u00b0), a blind angle of 40\u00b0 due to the in situ cell implies that only 180\u00b0-40\u00b0=140\u00b0 (e.g. -70\u00b0/70\u00b0) is visible. NOTE: for a CT normally scanned over 360\u00b0 (e.g. -180\u00b0/+180\u00b0), a blind angle of 40\u00b0 would require the subtraction of the blind angle twice, implying two scan ranges of 140\u00b0 each (e.g. -160\u00b0/-20\u00b0 and +20\u00b0/+160\u00b0). Typical unit - degree."
},
"displacement": {
"additionalProperties": false,
"description": "(Optional) - Specification on how displacement is applied on the sample. Either 'displacementRate' in \u00b5m/min or 'displacementIncrement' in \u00b5m/acquisition need to be selected.",
"properties": {
"displacementIncrement": {
"description": "(Optional) - The step at which displacement is changed per acquisition in \u00b5m/acquisition.",
"type": "number"
},
"displacementRate": {
"description": "(Optional) - The rate at which displacement is applied on the sample in \u00b5m/min.",
"type": "number"
}
},
"type": "object"
},
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame or anvil (e.g. - size of anvil) relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
},
"maximumDisplacement": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - The maximum displacement allowed in the selected configuration. Typical unit - \u00b5m."
},
"maximumForce": {
"description": "(Optional) - The maximum force that can be applied to the sample in N.",
"type": "number"
},
"otherAnvil": {
"description": "(Optional) - If 'anvil' was selected as 'Other' from the controlled list as it was not listed, please specify the name of the anvil with a description in this field.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the vacuum chamber relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the vacuum chamber relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the vacuum chamber."
},
"chamberName": {
"description": "(Optional) - Name of the vacuum chamber.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"motorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchical level and direction of a motor.",
"properties": {
"motorDirection": {
"description": "(Required) - The direction of movement (for X,Y,Z,M motors) or axis of rotation (for rotating motors) expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the X-stage and perpendicular to the Y-stage. then beam direction = [1 0 0], X-stage-direction = [1 0 0] (positive movement direction away from source towards detector) or can be (-1 0 0) (towards source) and Y-stage-direction = [0 1 0] or can be [0 -1 0] (analogous interpretation). The parameters need to be individually determined for each instrument. For rotating motors, the directional vector of axis of rotation should be given in Cartesian coordinates (counterclockwise, right-hand rule).",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"motorLevel": {
"description": "(Required) - Hierarchy of the motor expressed as an integer.",
"type": "number"
}
},
"type": "object"
},
"motorPositions": {
"additionalProperties": false,
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the motor.",
"properties": {
"angles": {
"$ref": "#/$defs/angleSet",
"description": "(Optional) - The three tilt angles alpha, beta and gamma of the motors controlling the position of the item."
},
"xyzPositions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - The xyz coordinates describing the motor positions of the item."
}
},
"type": "object"
},
"optics": {
"additionalProperties": false,
"description": "(Optional) - Details about the optics and individual motor positions.",
"properties": {
"collimator": {
"additionalProperties": false,
"description": "(Optional) - Details about the collimator and its individual motor positions.",
"properties": {
"collimatorDetails": {
"description": "(Optional) - Details about the collimator relevant for the measurement.",
"type": "string"
},
"collimatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the collimator."
}
},
"type": "object"
},
"condenser": {
"additionalProperties": false,
"description": "(Optional) - Details about the condenser lens and its individual motor positions, if used.",
"properties": {
"condenserDetails": {
"description": "(Optional) - Details about the condenser relevant for the measurement.",
"type": "string"
},
"condenserPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the condenser."
}
},
"type": "object"
},
"fresnelZonePlate": {
"additionalProperties": false,
"description": "(Optional) - Details about the fresnel zone plate and its individual motor positions, if used.",
"properties": {
"fresnelZonePlateDetails": {
"description": "(Optional) - Details about the fresnel zone plate relevant for the measurement.",
"type": "string"
},
"fresnelZonePlatePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the fresnel zone plate."
}
},
"type": "object"
},
"monochromator": {
"additionalProperties": false,
"description": "(Required) - Details about the monochromator and individual motor positions, if used.",
"properties": {
"monochromatorDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the monochromator type type, material, energy and notes.",
"properties": {
"energy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Energy set in the monochromator. Typical unit - eV"
},
"material": {
"description": "(Optional) - Material of the monochromator.",
"type": "string"
},
"monochromatorType": {
"description": "(Optional) - Type of the monochromator.",
"type": "string"
},
"notes": {
"description": "(Optional) - Additional information about the monochromator relevant for the measurement."
}
},
"type": "object"
},
"monochromatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the monochromator."
},
"monochromatorUsed": {
"description": "(Required) - To be set to true if monochromator is used, else false.",
"type": "boolean"
}
},
"required": [
"monochromatorUsed"
],
"type": "object"
},
"phaseRing": {
"additionalProperties": false,
"description": "(Required) - Details about the phase ring and its individual motor positions, if inserted.",
"properties": {
"phaseRingDetails": {
"description": "(Optional) - Details about the phase ring relevant for the measurement.",
"type": "string"
},
"phaseRingPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the phase ring."
}
},
"type": "object"
}
},
"required": [
"monochromator"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes a parameter which can be split into number of pixels in x and y directions like the resolution",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm or \u00b5m, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "nm",
"description": "(Required) - the unit of the size of a single pixel (typical value - nm, \u00b5m) of datatype string",
"enum": [
"nm",
"\u00b5m"
],
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min, default value - max) of datatype string.",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"default": "W",
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW, default value - W) of datatype string.",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "Pa",
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"rampDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a rate at which temperature is increased or decreased.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K/min",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K/min, K/s)",
"enum": [
"K/min",
"K/s"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of temperature increase or decrease.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"reconstruction": {
"additionalProperties": false,
"description": "Data from one single reconstruction.",
"properties": {
"reconstructionDetails": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"additionalFilters": {
"beamHardeningCorrection": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"filterType": {
"description": "(Optional) - Type of the additional filter - Median or Gauss",
"enum": [
"Median",
"Gauss"
],
"type": "string"
},
"phaseRetrieval": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"ringFilter": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
}
},
"algorithm": {
"description": "(Required) - Algorithm used for reconstruction to be selected from FBP - Filtered Back Projection, ART - Algebraic Reconstruction Technique, 3dCT - 3D Computed Tomography and Gridrec.",
"enum": [
"FBP - Filtered Back Projection",
"ART - Algebraic Reconstruction Technique",
"3dCT - 3D Computed Tomography",
"Gridrec"
],
"type": "string"
},
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepthConversionMax": {
"description": "(Required) - Maximum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"bitDepthConversionMin": {
"description": "(Required) - Minimum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"hardwarePlatform": {
"description": "(Optional) - Hardware platform used for reconstruction to be selected between CPU and GPU.",
"enum": [
"CPU",
"GPU"
],
"type": "string"
},
"lastImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the last image for the reconstruction of the 3D Volume, typically an integer.",
"type": "string"
},
"projectionPadding": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the projection padding applied to the raw projection data to address certain issues in the reconstruction process.",
"properties": {
"paddingSize": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - Size of the projection padding used in pixels."
},
"paddingType": {
"description": "(Required) - Type of the projection padding used - Zero Padding, Linear Interpolation Padding, Sinc Interpolation Padding, Shepp-Logan Filtered Back Projection (SL-FBP), Gridding and Extended Field of View (FOV) Padding.",
"enum": [
"Zero Padding",
"Linear Interpolation Padding",
"Sinc Interpolation Padding",
"Shepp-Logan Filtered Back Projection (SL-FBP)",
"Gridding",
"Extended Field of View (FOV) Padding"
],
"type": "string"
}
},
"type": "object"
},
"reconstructionSoftware": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for reconstruction. It may be the same as the acquisition software or a different one."
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Scan angle at which the reconstruction of the 3D Volume starts. Typical unit - degree."
},
"startImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the start image for the reconstruction of the 3D Volume.",
"type": "string"
},
"tomographicProjectionFilter": {
"description": "(Optional) - Name of the tomographic projection filter used to be selected from Ram-Lak Filter, Butterworth Filter, Shepp-Logan Filter, Hann (Hanning) Filter, Gaussian Filter, Cosine Filter, Soft Filtration Method and Hard Filtration Method.",
"enum": [
"Ram-Lak Filter",
"Butterworth Filter",
"Shepp-Logan Filter",
"Hann (Hanning) Filter",
"Gaussian Filter",
"Cosine Filter",
"Soft Filtration Method",
"Hard Filtration Method"
],
"type": "string"
}
},
"required": [
"startImage",
"lastImage",
"startAngle",
"hardwarePlatform",
"algorithm",
"binning"
],
"type": "object"
},
"volumeStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each voxel in the 3D volume. The bit depth determines the number of possible intensity levels that can be assigned to each voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Required) - The dimension of the 3D volume in XYZ coordinates. If the length in Z dimension is not known and instead only the number of slices are known, they need to be separately entered in the field 'numberOfSlices'. Typical unit - \u00b5m."
},
"header": {
"additionalProperties": false,
"description": "(Optional) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Optional) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"name": {
"description": "(Required) - Name of the 3D volume structure (dataset).",
"type": "string"
},
"numberOfSlices": {
"description": "(Optional) - No. of slices which make up the 3D volume.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel/voxel, normally expressed in \u00b5m."
},
"volumeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry of the 3D reconstructed volume usually provided by the project or the laboratory."
}
},
"required": [
"name",
"dimensions",
"bitDepth",
"pixelSize"
],
"type": "object"
}
},
"required": [
"volumeStructure",
"reconstructionDetails"
],
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"sampleStage": {
"additionalProperties": false,
"description": "(Required) - Details about sample stage.",
"properties": {
"stageMotorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchy of the stage motors. This information is required to know how the motor movements affect the positions of the samples, particularly relevant for correlative characterization.",
"properties": {
"beamDirection": {
"description": "(Required) - The beam direction expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the Y-stage and perpendicular to the X-stage. then beam direction = [0 1 0].",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"mMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the M motor (stage) as a vector in cartesian coordiantes. The M motor is usually relevant only for SEM based CT. It is a special motor which counteracts the Z motor."
},
"rMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the R motor (stage) as a vector in cartesian coordiantes. R motor has rotation around z axis +1 (for anticlockwise)."
},
"tMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the T motor (stage) as a vector in cartesian coordiantes. The T motor is usually relevant only for SEM based CT."
},
"xMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the X motor (stage) as a vector in cartesian coordinates."
},
"yMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Y motor (stage) as a vector in cartesian coordinates."
},
"zMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Z motor (stage) as a vector in cartesian coordinates."
}
},
"required": [
"beamDirection",
"xMotor",
"yMotor",
"zMotor",
"rMotor"
],
"type": "object"
},
"stageMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the stage motors."
}
},
"required": [
"stageMotorHierarchy"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5s",
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s default value - \u00b5s) of datatype string",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"user": {
"description": "Basic schema for user description. It can be extended.",
"properties": {
"ORCID": {
"description": "(Optional) - Open Researcher and Contributor ID expressed as a URI",
"pattern": "^https://orcid\\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[X0-9]{1}$",
"type": "string"
},
"affiliation": {
"description": "(Optional) - Details of the institution to which the user is affiliated",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"description": "(Optional) -Identifier of the institution to which the user is affiliated",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be chosen from a controlled list of values (*ROR *GRID *ISNI *URL *DOI *Handle)",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"email": {
"description": "(Optional) - Email of the user",
"format": "email",
"type": "string"
},
"familyName": {
"description": "(Optional) - Family name of the user",
"type": "string"
},
"givenName": {
"description": "(Optional) - Given name of the user",
"type": "string"
},
"role": {
"description": "(Required) - Role of the research user",
"enum": [
"Data Curator",
"Instrument Scientist",
"Team Leader",
"Team Member"
],
"type": "string"
},
"userName": {
"description": "(Required) - Full name of the user in the format (Family Name, Given Name)",
"type": "string"
}
},
"required": [
"userName",
"role"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "kV",
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV default value - V) of datatype string.",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided. Contributors (in alphabetical order of last names): Alexey Boubnov, Rafaela Debastiani, Jonas Fell, Sarah Irvine, Reetu Elza Joseph.",
"properties": {
"entry": {
"$ref": "#/$defs/entry"
}
},
"required": [
"entry"
],
"title": "lab_CT",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | fa36de9792c4ebcda0d482b609a5a11bf09adcf7 | 2023-12-13T16:00:13 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"CTAquisition": {
"additionalProperties": false,
"description": "(Required) - Details about the acquisition.",
"properties": {
"acquisitionScriptName": {
"description": "(Required) - Name of the script used for acquisition.",
"type": "string"
},
"acquisitionTimePerProjection": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time taken for acquisition of a single projection. Typical unit - s."
},
"angularStepSize": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Step size of the rotation of the sample during the CT. Typical unit - degree."
},
"contrastType": {
"description": "(Required) - The contrast type(mode) used - Absorption Contrast or Phase Contrast. If 'Phase Contrast' is selected, please indicate the used Phase Contrast Mode under the field phaseContrastMode.",
"enum": [
"Absorption Contrast",
"Phase Contrast"
],
"type": "string"
},
"endAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - End angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then endAngle is 180\u00b0. Typical unit - degree."
},
"largeFOV": {
"description": "(Required) - To be set to true if large field of view or wide field of view is used.",
"type": "boolean"
},
"numberOfProjections": {
"description": "(Required) - Number of projections acquired during the CT.",
"type": "number"
},
"phaseContrastMode": {
"description": "(Optional) - The phase contrast mode used during acquisition - Zernike phase contrast, propagation-based, grating-based(Hartmann), grating-based(Talbot).",
"enum": [
"Zernike phase contrast",
"Propagation-based",
"Grating-based(Hartmann)",
"Grating-based(Talbot)"
],
"type": "string"
},
"referenceImages": {
"additionalProperties": false,
"description": "(Optional) - Details on the reference images (if used) - number of flats/bright images and number of dark images.",
"properties": {
"numberOfBrightImages": {
"description": "(Optional) - Number of flats or bright images used as reference.",
"type": "number"
},
"numberOfDarkImages": {
"description": "(Optional) - Number of dark images used as reference.",
"type": "number"
}
},
"type": "object"
},
"scanningMode": {
"description": "(Optional) - The scanning mode used during acquisition - helical, raster scanning, fast CT.",
"enum": [
"Helical",
"Raster Scanning",
"Fast CT"
],
"type": "string"
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Start angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then startAngle is -180\u00b0. Typical unit - degree."
},
"totalAcquisitionTime": {
"description": "(Required) - Time taken for acquisition for the entire scan. This is the total scan time, i.e. number of projections multipled by exposure time, but including read-out time. calculated as EndTime-StartTime. Format: hh:mm:ss.",
"format": "time",
"pattern": "^(\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?)$",
"type": "string"
},
"useBadPixelMap": {
"description": "(Optional) - To be set to true if bad pixel map is used. This parameter is relevant for SEM based CT.",
"type": "boolean"
}
},
"required": [
"acquisitionScriptName",
"startAngle",
"endAngle",
"angularStepSize",
"acquisitionTimePerProjection",
"totalAcquisitionTime",
"largeFOV",
"contrastType"
],
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "degree",
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"angleSet": {
"additionalProperties": false,
"description": "(Optional) - Tilt angles alpha, beta and gamma decribing the three angular positions of an item.",
"properties": {
"alpha": {
"description": "(Optional) - Tilt angle alpha of the item.",
"type": "number"
},
"anglesUnit": {
"default": "degree",
"description": "(Optional) - unit of the angles (allowed units - degree or radian)",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"beta": {
"description": "(Optional) - Rotation angle beta of the item.",
"type": "number"
},
"gamma": {
"description": "(Optional) - Angle gamma of the item.",
"type": "number"
}
},
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"default": "\u00b5m",
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "pA",
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string.",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"detector": {
"additionalProperties": false,
"description": "gives the settings of a detector or multiple detectors.",
"properties": {
"detectorSettings": {
"oneOf": [
{
"$ref": "#/$defs/detectorSettings"
},
{
"items": {
"$ref": "#/$defs/detectorSettings"
},
"type": "array"
}
]
}
},
"required": [
"detectorSettings"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "(Required) - Gives the settings of a single detector.",
"properties": {
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector."
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the detector (manufacturerName, modelName and detectorID) as part of manufacturerDetails."
},
"detectorName": {
"description": "(Optional) - Name of the detector of datatype string.",
"type": "string"
},
"detectorType": {
"description": "(Optional) - The type of detector to be selected from a controlled list consisting of CCD, Panel, PCXD, CMOS, Time-Delay Integration (TDI) and Direct Conversion.",
"enum": [
"CCD",
"Panel",
"PCXD",
"CMOS",
"Time-Delay Integration (TDI)",
"Direct Conversion"
],
"type": "string"
}
},
"required": [
"detectorType",
"detectorManufacturer"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ; default value - keV) of datatype string",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"entry": {
"additionalProperties": false,
"description": "Required) - The entry level is the root element of the schema. It contains all the metadata describing a CT measurement.",
"properties": {
"consumables": {
"description": "Auxiliary entity used during Fabrication, Sample Preparation or Measurement which has a limited time capacity or is limited in its number of uses before it is disposed of, necessary to the process itself and normally bought from third party manufacturers. Examples are: gloves, syringes, wipes, etching solutions, glass slides, spatulas, weighing paper, two-sided tape.",
"items": {
"type": "string"
},
"type": "array"
},
"definition": {
"description": "(Optional) - Name of the schema to which this entry conforms. In this case, lab_CT should be written",
"type": "string"
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "entryID (Optional) - Identifier of the metadata entry usually provided by the project or the laboratory"
},
"equipment": {
"description": "(Optional) - Any kind of physical or virtual item, device, machine or other tools used to perform one or more Fabrication(s), Sample Preparation(s), Model Preparation(s), Data Acquisition(s) and/or any of the processes included in the Data Analysis Lifecycle. Usually, the Equipment is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. Equipment is usually an investment. According to this definition, an Instrument is a particular type of Equipment.",
"type": "string"
},
"experimentID": {
"$ref": "#/$defs/identifier",
"description": "entryID (Optional) - Identifier of the measurement usually provided by the project or the laboratory"
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings. Instrument is a physical or virtual identifiable piece of Equipment used to perform a Data Acquisition and to generate Raw Data. The Instrument is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. A virtual Instrument may be any computational resource or HPC infrastructure (cloud infrastructure or supercomputer) needed to perform Calculations or Simulations."
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure"
},
"measurementDescription": {
"description": "(Optional) - Description about the measurement.",
"type": "string"
},
"measurementPurpose": {
"description": "Measurement is experimental Data Acquisition, typically performed on a Sample using an experimental Technique. It may also be performed during Fabrication or Sample Preparation, e.g., to characterise the intermediate stages and/or the final resulting Precursor(s) or Sample(s), respectively. A Measurement may require the use of Consumables.",
"enum": [
"assessment (to given categories or values)",
"completeness check (presence or absence of given properties)",
"correlative characterization (dedicated sample treatment to emphasise given features)",
"exploratory (routine check of known properties)",
"feasibility (quick check, rough estimate)",
"high quality measurement (precise, careful treatment)",
"test specific hypothesis (focus only on given aspects)",
"other (please specify in the comment)"
],
"type": "string"
},
"parents": {
"items": {
"if": {
"properties": {
"parentType": {
"not": {
"const": "not applicable"
}
}
}
},
"properties": {
"parentReference": {
"anyOf": [
{
"format": "uri"
},
{
"format": "url"
}
],
"description": "If type is 'MetaStore URI' it is possible to easily fill this field in a later stage",
"type": "string"
},
"parentReferenceType": {
"enum": [
"plain text",
"external URL",
"MetaStore URI"
],
"type": "string"
},
"parentType": {
"enum": [
"not applicable",
"sample"
],
"type": "string"
}
},
"required": [
"parentType"
],
"then": {
"required": [
"parentReferenceType",
"parentReference"
]
},
"type": "object"
},
"type": "array"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition"
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format"
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"technique": {
"description": "(Optional) - Any experimental, theoretical or computational method used during Data Acquisition or during any of the processes included in the Data Analysis Lifecycle to acquire, process or analyse Research Data about a System or a set of them with an Instrument, whihc is used to generate this metadata.",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement",
"type": "string"
},
"user": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/user_description.json",
"description": "(Required)- The contact information of the user responsible for the measurement"
}
},
"required": [
"title",
"startTime",
"endTime",
"program",
"user",
"instrument",
"data"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/ time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min) default value - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"geometry": {
"additionalProperties": false,
"description": "Describes the geometry of the CT instrument",
"properties": {
"beamGeometry": {
"additionalProperties": false,
"description": "(Required) - Details about beam geometry like beam geometry type and divergence angle.",
"properties": {
"beamGeometryType": {
"description": "(Required) - The type of the beam geometry to be selected between 'collimated' and 'divergent'.",
"enum": [
"collimated",
"divergent"
],
"type": "string"
},
"divergenceAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Angle of divergence when the beam geometry is divergent. Typical unit - degree."
}
},
"type": "object"
},
"geometricMagnification": {
"description": "(Required) - Geometric magnification refers to the ratio of the size of an object's image to the size of the object itself. It is a measure of how much larger the image appears compared to the actual object. Geometric magnification (M) is calculated using the formula M = (SID + SOD) / SID, where SID is the source-to-image distance and SOD is the source-to-object distance.",
"type": "number"
},
"objectToDetectorDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the object and the detector. Typical unit - \u00b5m."
},
"opticalMagnification": {
"description": "(Required) - Optical magnification is calculated as the ratio of the focal length of the objective lens to the focal length of the eyepiece (if an eyepiece is present) in a traditional optical microscope.",
"type": "number"
},
"sourceToObjectDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the source and the object. Typical unit - \u00b5m."
}
},
"required": [
"sourceToObjectDistance",
"objectToDetectorDistance",
"beamGeometry",
"geometricMagnification",
"opticalMagnification"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"imagingDetails": {
"additionalProperties": false,
"description": "describes the imaging settings of the instrument during the measurement.",
"properties": {
"apertureSetting": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Optional) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). The element apertureSetting is defined separately as apertureSettingType which gives the option to choose between current or size. If the size can be set directly, then it is defined with the complex type distanceDetails, else if the aperture setting is controlled with the beam current defined separately as currentDetails"
},
"collectionMethod": {
"default": "normal scan",
"description": "(Optional) - the method of collection of the image, for e.g., normal scan, average of multiple images, integration of multiple images, default value - normal scan, of datatype string",
"type": "string"
},
"cycleTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - the time taken by the beam to scan a frame, defined separately as timeDetails. It is the time needed to scan a line times the number of lines in a frame."
},
"dwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - the dwell time of the beam per pixel, defined separately as timeDetails"
},
"dynamicFocus": {
"description": "(Optional) - To be set to true if dynamic focus is turned on, else false",
"type": "boolean"
},
"noiseReduction": {
"description": "(Optional) - The type of noise reduction used as an enumerated list of six parameters: Pixel Avg, Line Avg, Frame Avg, Pixel Int, Line Int, Frame Int.",
"enum": [
"Pixel Avg",
"Line Avg",
"Frame Avg",
"Pixel Int",
"Line Int",
"Frame Int"
],
"type": "string"
},
"numberOfPixels": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The number of x, y pixels of the image, defined separately as pixelNumberType with separate entries for integer values of xPixels and yPixels"
},
"pixelSize": {
"$ref": "#/$defs/pixelsize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel, normally expressed in nm/pixel, defined separately as pixelSize3D for the mapping along x,y and z directions, with each pixel having a pixelSize, optional uncertainty, optional qualifier and optional notes. The y-pixel-size is to be given only if it is different from the x-pixel-size, and z-pixel-size can be ignored if it is greater than voxel size"
},
"voxel": {
"$ref": "#/$defs/voxelDetails",
"description": "(Optional) - Size of the voxel in case 3D imaging is done for Energy-dispersive X-ray Spectroscopy or Electron-backscatter Diffraction, defined separately as voxelDetails"
}
},
"required": [
"numberOfPixels",
"pixelSize"
],
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"CTAquisition": {
"$ref": "#/$defs/CTAquisition",
"description": "(Optional) - Details regarding the acquisition."
},
"calibration": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the calibration and the scaling factor.",
"properties": {
"calibrationType": {
"description": "(Optional) - Type of calibration as a string.",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (YYYY-MM-DDThh:mm:ss.sss) in the ISO 8601 date-time format",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"systemScaling": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scaling factor.",
"properties": {
"adjustSystemScaling": {
"description": "(Required) - To be set to true if system scaling is adjusted, else false.",
"type": "boolean"
},
"measuredScalingFactor": {
"description": "(Optional) - Value of the measured scaling factor.",
"type": "number"
},
"referenceScalingFactor": {
"description": "(Optional) - Value of the reference scaling factor, determined ususally during the data processing.",
"type": "number"
}
},
"required": [
"adjustSystemScaling"
],
"type": "object"
}
},
"type": "object"
},
"detector": {
"$ref": "#/$defs/detector",
"description": "(Optional) - Details regarding the detector."
},
"focalSpotMode": {
"additionalProperties": false,
"description": "(Optional) - Option for setting the size of the focal spot. Some sources have the option to select the target spot size, or focal spot size absolutely by setting a value, while some others give the option of selecting 'small', 'medium' or 'large'. Smaller spot size = higher resolution. Note that the power/current will change with this value. In addition, the detector settings will usually be selected in conjunction. (different scintillator/lens/magnification).",
"properties": {
"selection": {
"description": "(Optional) - Selection of the setting of the size of the focal spot when the option for setting the size of the focal spot by selecting 'small', 'medium' or 'large' according to predefined values set by the manufacturer.",
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the target spot when the option for setting the size of the focal spot absolutely by setting a value is available."
}
},
"type": "object"
},
"geometry": {
"$ref": "#/$defs/geometry",
"description": "(Optional) - Details regarding the geometry."
},
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"optics": {
"$ref": "#/$defs/optics",
"description": "(Optional) - Details about the optics and individual motor positions."
},
"sampleStage": {
"$ref": "#/$defs/sampleStage",
"description": "(Optional) - Details regarding the sample stage."
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray target in an SEM based CT set-up.",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required) - Details of the pressure maintained in the chamber of the SEM."
},
"electronBeamShift": {
"additionalProperties": false,
"description": "(Required) - The distance by which the electron beam is shifted in the x and y directions.",
"properties": {
"xShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the x direction. Typical unit - \u00b5m."
},
"yShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xShift",
"yShift"
],
"type": "object"
},
"electronProbeCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required) - The electron current measured at the probe. Typical unit - \u00b5A."
},
"objectiveLensAperture": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). Typically the diameter of the aperture is set in \u00b5m."
},
"target": {
"additionalProperties": false,
"description": "(Required) - Details regarding the target in SEM based CT, which upon interaction with the e-beam produces the X-rays.",
"properties": {
"targetDriftCorrection": {
"description": "(Required) - If drift correction is activated for the target, this parameter has to be set to true.",
"type": "boolean"
},
"targetMaterial": {
"description": "(Required) - Material with which the target is made.",
"type": "string"
},
"targetShape": {
"description": "(Optional) - Description of the shape or geometry of the target. e.g. - bulk, foil, needle.",
"type": "string"
},
"targetThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Thickness of the target (dimension in Z direction). Default unit - \u00b5m."
},
"targetTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the target is tilted. Typical unit - degree."
}
},
"required": [
"targetMaterial",
"targetThickness",
"targetDriftCorrection",
"targetTiltAngle",
"targetCurrent"
],
"type": "object"
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. In SEM based CT, the beam is focussed on the target material which emits the X-rays upon interaction with the electrons. Default unit - \u00b5m."
}
},
"required": [
"chamberPressure",
"electronBeamShift",
"workingDistance",
"objectiveLensAperture",
"electronProbeCurrent",
"target"
],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
},
"targetCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current measured at the X-ray target, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"sourceDrift": {
"additionalProperties": false,
"description": "(Optional) - Distance by which the source is shifted during the measurement (i.e., end position - start position).",
"properties": {
"xDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the x direction. Typical unit - \u00b5m."
},
"yDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xDrift",
"yDrift"
],
"type": "object"
},
"sourcePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the source."
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray enrgy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source",
"focalSpotMode",
"CTAquisition",
"geometry",
"sampleStage",
"detector"
],
"type": "object"
},
"lifetimeDetails": {
"additionalProperties": false,
"description": "describes a lifetime.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5Ah",
"description": "(Required) - the unit of the value (default value - \u00b5Ah) of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The lifetime of the source expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer.",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"bioReactor": {
"additionalProperties": false,
"description": "(Optional) - Details of an in situ bioreactor.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in sterile conditions.",
"type": "boolean"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is decreased. Typical unit - K/min."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is increased, typically in K/min."
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"anvil": {
"description": "(Optional) - The type of anvil used in the in situ load frame (stage) for applying a particular type of force on the sample. Option to be selected from a controlled list consisting of - Compression, Diamond indentation 90\u00b0 cone, Diamond indentation cube corner, Diamond indentation wedge, Tension, Other. If 'Other' is selected, specify the name of the anvil with a description in the field 'otherAnvil'.",
"enum": [
"Compression",
"Diamond indentation 90\u00b0 cone",
"Diamond indentation cube corner",
"Diamond indentation wedge",
"Tension",
"Other"
],
"type": "string"
},
"blindAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - ed by the load frame(stage). Example: for a CT normally scanned over 180\u00b0 (e.g. -90\u00b0/+90\u00b0), a blind angle of 40\u00b0 due to the in situ cell implies that only 180\u00b0-40\u00b0=140\u00b0 (e.g. -70\u00b0/70\u00b0) is visible. NOTE: for a CT normally scanned over 360\u00b0 (e.g. -180\u00b0/+180\u00b0), a blind angle of 40\u00b0 would require the subtraction of the blind angle twice, implying two scan ranges of 140\u00b0 each (e.g. -160\u00b0/-20\u00b0 and +20\u00b0/+160\u00b0). Typical unit - degree."
},
"displacement": {
"additionalProperties": false,
"description": "(Optional) - Specification on how displacement is applied on the sample. Either 'displacementRate' in \u00b5m/min or 'displacementIncrement' in \u00b5m/acquisition need to be selected.",
"properties": {
"displacementIncrement": {
"description": "(Optional) - The step at which displacement is changed per acquisition in \u00b5m/acquisition.",
"type": "number"
},
"displacementRate": {
"description": "(Optional) - The rate at which displacement is applied on the sample in \u00b5m/min.",
"type": "number"
}
},
"type": "object"
},
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame or anvil (e.g. - size of anvil) relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
},
"maximumDisplacement": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - The maximum displacement allowed in the selected configuration. Typical unit - \u00b5m."
},
"maximumForce": {
"description": "(Optional) - The maximum force that can be applied to the sample in N.",
"type": "number"
},
"otherAnvil": {
"description": "(Optional) - If 'anvil' was selected as 'Other' from the controlled list as it was not listed, please specify the name of the anvil with a description in this field.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"chamberName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"motorHeirarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchical level and direction of a motor.",
"properties": {
"motorDirection": {
"description": "(Required) - The direction of movement (for X,Y,Z,M motors) or axis of rotation (for rotating motors) expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the X-stage and perpendicular to the Y-stage. then beam direction = [1 0 0], X-stage-direction = [1 0 0] (positive movement direction away from source towards detector) or can be (-1 0 0) (towards source) and Y-stage-direction = [0 1 0] or can be [0 -1 0] (analogous interpretation). The parameters need to be individually determined for each instrument.",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"motorLevel": {
"description": "(Required) - Hierarchy of the motor expressed as an integer.",
"type": "number"
}
},
"type": "object"
},
"motorPositions": {
"additionalProperties": false,
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the motor.",
"properties": {
"angles": {
"$ref": "#/$defs/angleSet",
"description": "(Optional) - The three tilt angles alpha, beta and gamma of the motors controlling the position of the item."
},
"xyzPositions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - The xyz coordinates decribing the motor positions of the item."
}
},
"type": "object"
},
"optics": {
"additionalProperties": false,
"description": "(Optional) - Details about the optics and individual motor positions.",
"properties": {
"collimator": {
"additionalProperties": false,
"description": "(Optional) - Details about the collimator and its individual motor positions.",
"properties": {
"collimatorDetails": {
"description": "(Optional) - Details about the collimator relevant for the measurement.",
"type": "string"
},
"collimatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the collimator."
}
},
"type": "object"
},
"condenser": {
"additionalProperties": false,
"description": "(Optional) - Details about the condenser lens and its individual motor positions, if used.",
"properties": {
"condenserDetails": {
"description": "(Optional) - Details about the condenser relevant for the measurement.",
"type": "string"
},
"condenserPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the condenser."
}
},
"type": "object"
},
"fresnelZonePlate": {
"additionalProperties": false,
"description": "(Optional) - Details about the fresnel zone plate and its individual motor positions, if used.",
"properties": {
"fresnelZonePlateDetails": {
"description": "(Optional) - Details about the fresnel zone plate relevant for the measurement.",
"type": "string"
},
"fresnelZonePlatePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the fresnel zone plate."
}
},
"type": "object"
},
"monochromator": {
"additionalProperties": false,
"description": "(Required) - Details about the monochromator and individual motor positions, if used.",
"properties": {
"monochromatorDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the monochromator type type, material, energy and notes.",
"properties": {
"energy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Energy set in the monochromator. Typical unit - eV"
},
"material": {
"description": "(Optional) - Material of the monochromator.",
"type": "string"
},
"monochromatorType": {
"description": "(Optional) - Type of the monochromator.",
"type": "string"
},
"notes": {
"description": "(Optional) - Additional information about the monochromator relevant for the measurement."
}
},
"type": "object"
},
"monochromatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the monochromator."
},
"monochromatorUsed": {
"description": "(Required) - To be set to true if monochromator is used, else false.",
"type": "boolean"
}
},
"required": [
"monochromatorUsed"
],
"type": "object"
},
"phaseRing": {
"additionalProperties": false,
"description": "(Required) - Details about the phase ring and its individual motor positions, if inserted.",
"properties": {
"phaseRingDetails": {
"description": "(Optional) - Details about the phase ring relevant for the measurement.",
"type": "string"
},
"phaseRingPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the phase ring."
}
},
"type": "object"
}
},
"required": [
"monochromator"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes the resolution of the image split into number of pixels in x and y directions.",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "nm/pixel",
"description": "(Required) - the unit of the value (default value - nm/pixel) of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"pixelsize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm/pixel, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min, default value - max) of datatype string.",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"default": "W",
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW, default value - W) of datatype string.",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "Pa",
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"rampDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a rate at which temperature is increased or decreased.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K/min",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K/min, K/s)",
"enum": [
"K/min",
"K/s"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of temperature increase or decrease.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"samplePrepType": {
"additionalProperties": false,
"description": "(Optional) - Describes the sample preparation process.",
"properties": {
"preparationDate": {
"description": "(Optional) - Date of the sample preparation in the ISO 8601 format.",
"format": "date",
"type": "string"
},
"preparationDescription": {
"description": "(Optional) - Short description of the sample preparation.",
"type": "string"
},
"preparationID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the sample preparation."
}
},
"type": "object"
},
"sampleStage": {
"additionalProperties": false,
"description": "(Required) - Details about sample stage.",
"properties": {
"stageMotorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchy of the stage motors. This information is required to know how the motor movements affect the positions of the samples, particularly relevant for correlative characterization.",
"properties": {
"beamDirection": {
"description": "(Required) - The beam direction expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the Y-stage and perpendicular to the X-stage. then beam direction = [0 1 0].",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"mMotor": {
"$ref": "#/$defs/motorHeirarchy",
"description": "(Optional) - Hierarchical level and direction of the M motor (stage) as a vector in cartesian coordiantes. The M motor is usually relevant only for SEM based CT. It is a special motor which counteracts the Z motor."
},
"rMotor": {
"$ref": "#/$defs/motorHeirarchy",
"description": "(Required) - Hierarchical level and direction of the R motor (stage) as a vector in cartesian coordiantes. R motor has rotation around z axis +1 (for anticlockwise)."
},
"tMotor": {
"$ref": "#/$defs/motorHeirarchy",
"description": "(Optional) - Hierarchical level and direction of the T motor (stage) as a vector in cartesian coordiantes. The T motor is usually relevant only for SEM based CT."
},
"xMotor": {
"$ref": "#/$defs/motorHeirarchy",
"description": "(Required) - Hierarchical level and direction of the X motor (stage) as a vector in cartesian coordinates."
},
"yMotor": {
"$ref": "#/$defs/motorHeirarchy",
"description": "(Required) - Hierarchical level and direction of the Y motor (stage) as a vector in cartesian coordinates."
},
"zMotor": {
"$ref": "#/$defs/motorHeirarchy",
"description": "(Required) - Hierarchical level and direction of the Z motor (stage) as a vector in cartesian coordinates."
}
},
"required": [
"beamDirection",
"xMotor",
"yMotor",
"zMotor",
"rMotor"
],
"type": "object"
},
"stageMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the stage motors."
}
},
"required": [
"stageMotorHierarchy"
],
"type": "object"
},
"stageDetails": {
"additionalProperties": false,
"description": "describes the stage settings during a measurement.",
"properties": {
"coordinateReference": {
"default": "origin at centre of sample",
"description": "(Optional) - description of the reference used for defining the coordinates (for eg. - origin at centre of sample, distances from two edges, etc.)",
"type": "string"
},
"coordinates": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - the xyz coordinates of a point expressed separately as coordinateSet which allows entering each of the xyz coordinates along with their optional uncertainties. If correllation images (two reference spots) are available, the coordinates enable correlative microscopy and they need to be entered"
},
"eBeamWorkingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the distance at which the beam is focussed (when the sample is in focus, this will be the distance between the bottom end of the pole-piece of the objective lens and the sample) defined separately as distanceDetails, with the distance value, optional uncertainty, optional notes, optional qualifier and choice of units between nm, um, mm, cm and m"
},
"isCorrelationImage": {
"description": "(Optional) - Whether the image is used for correlating in xyz coordinates with another image? Check if true. If true the coordinates have to be entered for the sake of correlative characterization of datatype boolean",
"type": "boolean"
},
"preTilt": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - predefined angle of a tilted sample holder which is tilted by design defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"stageAlignmentDone": {
"description": "(Optional) - was stage alignment done? (check if true)",
"type": "boolean"
},
"stageTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the stage is actually tilted (Stage at T) defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"tiltCorrectionAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - angle used to correct the tilt of the sample defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"tiltCorrectionType": {
"default": "none",
"description": "(Optional) - the tilt correction type applied to the image to compensate for the tilting, for e.g., sample surface, cross-section, none or manual, default value- none of datatype string",
"type": "string"
}
},
"required": [
"eBeamWorkingDistance",
"stageTiltAngle"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5s",
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s default value - \u00b5s) of datatype string",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "kV",
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV default value - V) of datatype string.",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"voxelDetails": {
"additionalProperties": false,
"description": "describes the size of a voxel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "mm",
"description": "(Required) - the unit of the value of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The voxel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"weightDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a weight.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "\u00b5g",
"description": "(Required) - Unit of the value to be selected from a controlled list (ng, \u00b5g, mg, g, kg, default value - ug)",
"enum": [
"ng",
"\u00b5g",
"mg",
"g",
"kg"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the weight",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided. Contributors (in alphabetical order of last names): Alexey Boubnov, Rafaela Debastiani, Jonas Fell, Sarah Irvine, Reetu Elza Joseph",
"properties": {
"entry": {
"$ref": "#/$defs/entry"
}
},
"required": [
"entry"
],
"title": "lab_CT",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 6399a829d6b478b27d31e729b1dcaadf617a64a9 | 2023-12-05T16:22:29 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"FIBDetails": {
"additionalProperties": false,
"description": "Details about the focussed ion beam (FIB) extension if present.",
"properties": {
"FIBColumn": {
"description": "(Optional) - The name of the I-beam column used",
"type": "string"
},
"FIBExtractor": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The extractor voltage used for the I-Beam"
},
"FIBProbe": {
"description": "(Required) - The settings used for the probe, extractor voltage:milling current. eg. 30kV:50pA",
"type": "string"
},
"FIBSpotSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - spot size of the i-beam at the focus when the sample is in focus (also the spot size on the sample) defined separately as distanceDetails (Allowed units: nm, um, mm, cm, m)"
},
"angleToEBeam": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - angle between e-beam and i-beam defined separately as angleDetails (Allowed units: degree, radian)"
},
"gasInjectionSystem": {
"$ref": "#/$defs/GISDetails",
"description": "(Optional) - Details about the gas injection system (GIS) defined separately as GISDetails"
},
"iBeamSource": {
"$ref": "#/$defs/sourceDetails",
"description": "(Required) - describes the details of the FIB source, defined separately as sourceDetails in which it is important to note the accelerating voltage and beam current of the i-beam"
},
"iBeamWorkingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Working distance of the ion beam (i-beam) defined separately as distanceDetails - this value needs to be entered if the i-beam focus has to be set independently from the e-beam focus (Allowed units: nm, um, mm, cm, m)"
}
},
"required": [
"iBeamSource",
"FIBExtractor",
"FIBProbe"
],
"type": "object"
},
"GISDetails": {
"additionalProperties": false,
"description": "gives the details of the gas injection system (GIS).",
"properties": {
"GISName": {
"description": "(Optional) - Name of the GIS system of datatype string",
"type": "string"
},
"beamDepositionType": {
"description": "(Optional) - type of beam deposition of datatype string to choose between e-beam deposition and i-beam deposition",
"enum": [
"E-beam Deposition",
"I-beam Deposition"
],
"type": "string"
},
"depositionCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current used for performing beam deposition defined separately as currentDetails (Allowed units pA,nA,uA,mA,A)"
},
"depositionSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the deposition defined separately as distanceDetails (Allowed units nm,um,mm,cm,m)"
},
"depositionTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - total time for deposition defined separately as timeDetails (Allowed units ps,ns,us,ms,s)"
}
},
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "degree",
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"default": "\u00b5m",
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "pA",
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"detectorDetails": {
"additionalProperties": false,
"description": "gives the settings of a detector.",
"properties": {
"componentGeometry": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - xyz coordinates describing the position of the detector defined separately as coordinateSet"
},
"detectorBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - bias voltage applied to the detector defined separately as voltageDetails. Allowed units nV, uV, mV, V, kV"
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector"
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - describes the details of the detector (manufacturerName, modelName and detectorID) as part of manufacturerDetails"
},
"detectorName": {
"description": "(Required) -Name of the detector of datatype string",
"type": "string"
},
"detectorType": {
"default": "Secondary Electron",
"description": "(Optional) - The type of detector (e.g., surface electron detection, secondary electron, back-scattered electron) of datatype string",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (CCYY-MM-DDThh:mm:ss.sss) of the date-time format",
"pattern": "(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z)",
"type": "string"
}
},
"required": [
"detectorName"
],
"type": "object"
},
"detectorSetDetails": {
"additionalProperties": false,
"description": "gives information about signal mixing between two detectors and provides the information about the detector(s).",
"properties": {
"detector1": {
"$ref": "#/$defs/detectorDetails",
"description": "(Required) - gives the settings of one detector defined separately as detectorDetails; entering the details of at least one detector is compulsory"
},
"detector2": {
"$ref": "#/$defs/detectorDetails",
"description": "(Optional) - gives the settings of a second detector defined separately as detectorDetails"
},
"signalMixingDescription": {
"description": "(Optional) - Describes the purpose and technique of signal mixing of datatype string",
"type": "string"
},
"signalMixingDone": {
"default": false,
"description": "(Optional) - whether the detector signals are mixed, true or false, of datatype boolean",
"type": "boolean"
}
},
"required": [
"detector1"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"eBeamDecelerationDetails": {
"additionalProperties": false,
"description": "Details about deceleration of the e- beam.",
"properties": {
"landingEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Landing energy of the e-beam defined separately as energyDetails (allowed units - meV, eV, keV, nJ, mJ, J, kJ, MJ)"
},
"stageBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Bias voltage applied to the stage defined separately biasDetails (allowed units - nV, uV, mV, V, kV, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "keV",
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ; default value - keV) of datatype string",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"entry": {
"additionalProperties": false,
"description": "Required) - The entry level is the root element of the schema. It contains all the metadata describing a CT measurement.",
"properties": {
"definition": {
"description": "(Optional) - Name of the schema to which this entry conforms. In this case, lab_CT should be written",
"type": "string"
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "entryID (Optional) - Identifier of the measurement usually provided by the project or the laboratory"
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings"
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition"
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format"
},
"sample": {
"$ref": "#/$defs/sample",
"description": "(Required)- Details concerning the sample"
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement",
"type": "string"
},
"user": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/user_description.json",
"description": "(Required)- The contact information of the user responsible for the measurement"
}
},
"required": [
"title",
"startTime",
"endTime",
"program",
"user",
"instrument"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/unit time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min) default value - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"imagingDetails": {
"additionalProperties": false,
"description": "describes the imaging settings of the instrument during the measurement.",
"properties": {
"apertureSetting": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Optional) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). The element apertureSetting is defined separately as apertureSettingType which gives the option to choose between current or size. If the size can be set directly, then it is defined with the complex type distanceDetails, else if the aperture setting is controlled with the beam current defined separately as currentDetails"
},
"collectionMethod": {
"default": "normal scan",
"description": "(Optional) - the method of collection of the image, for e.g., normal scan, average of multiple images, integration of multiple images, default value - normal scan, of datatype string",
"type": "string"
},
"cycleTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - the time taken by the beam to scan a frame, defined separately as timeDetails. It is the time needed to scan a line times the number of lines in a frame."
},
"dwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - the dwell time of the beam per pixel, defined separately as timeDetails"
},
"dynamicFocus": {
"description": "(Optional) - To be set to true if dynamic focus is turned on, else false",
"type": "boolean"
},
"noiseReduction": {
"description": "(Optional) - The type of noise reduction used as an enumerated list of six parameters: Pixel Avg, Line Avg, Frame Avg, Pixel Int, Line Int, Frame Int.",
"enum": [
"Pixel Avg",
"Line Avg",
"Frame Avg",
"Pixel Int",
"Line Int",
"Frame Int"
],
"type": "string"
},
"numberOfPixels": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The number of x, y pixels of the image, defined separately as pixelNumberType with separate entries for integer values of xPixels and yPixels"
},
"pixelSize": {
"$ref": "#/$defs/pixelsize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel, normally expressed in nm/pixel, defined separately as pixelSize3D for the mapping along x,y and z directions, with each pixel having a pixelSize, optional uncertainty, optional qualifier and optional notes. The y-pixel-size is to be given only if it is different from the x-pixel-size, and z-pixel-size can be ignored if it is greater than voxel size"
},
"voxel": {
"$ref": "#/$defs/voxelDetails",
"description": "(Optional) - Size of the voxel in case 3D imaging is done for Energy-dispersive X-ray Spectroscopy or Electron-backscatter Diffraction, defined separately as voxelDetails"
}
},
"required": [
"numberOfPixels",
"pixelSize"
],
"type": "object"
},
"institutionDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the institution to which the user is affiliated.",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier pertaining to the institution (e.g. ROR)"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Required) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray Target in an SEM based CT set-up",
"properties": {},
"required": [],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the x-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
}
},
"required": [],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"chamberPressure",
"detectors",
"eBeamSource",
"imaging",
"instrumentName",
"stage"
],
"type": "object"
},
"lifetimeDetails": {
"additionalProperties": false,
"description": "describes a lifetime.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5Ah",
"description": "(Required) - the unit of the value (default value - \u00b5Ah) of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The lifetime of the source expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"description": "(Optional) - The rate at which temperature is increased in K/min.",
"type": "number"
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"pH": {
"additionalProperties": false,
"description": "(Optional) - Details about the pH maintained in the in situ cell.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in steile conditions.",
"type": "boolean"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"chamberName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes the resolution of the image split into number of pixels in x and y directions.",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "nm/pixel",
"description": "(Required) - the unit of the value (default value - nm/pixel) of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"pixelsize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm/pixel, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "Pa",
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"sample": {
"additionalProperties": false,
"description": "(Required) - Details concerning the sample.",
"properties": {
"sampleForm": {
"description": "(Optional) - Description of the sample form (e.g., bulk, nanostructured, powder, pellet)",
"type": "string"
},
"sampleHolder": {
"description": "(Optional) - Type of sample holder used",
"type": "string"
},
"sampleID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the sample"
},
"sampleName": {
"description": "(Optional) - Name of the sample",
"type": "string"
},
"samplePreparation": {
"$ref": "#/$defs/samplePrepType",
"description": "(Optional) - Details pertaining to the sample prepapration like date, ID, etc"
},
"sampleSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the sample"
},
"sampleWeight": {
"$ref": "#/$defs/weightDetails",
"description": "(Optional) - Weight of the sample"
},
"storageConditions": {
"default": "Ambient, dry environment",
"description": "(Optional) - Environment conditions in which the sample has to be stored before and after the measurement (e.g., nitrogen atmosphere, hermetically sealed, controlled temperature and pressure).",
"type": "string"
}
},
"type": "object"
},
"samplePrepType": {
"additionalProperties": false,
"description": "(Optional) - Describes the sample preparation process.",
"properties": {
"preparationDate": {
"description": "(Optional) - Date of the sample preparation.",
"format": "date",
"type": "string"
},
"preparationDescription": {
"description": "(Optional) - Short description of the sample preparation.",
"type": "string"
},
"preparationID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the sample preparation."
}
},
"type": "object"
},
"sourceDetails": {
"additionalProperties": false,
"description": "gives details about the electron beam source.",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - the voltage with which the e-beam is accelerated, defined separately as voltageDetails, (includes the voltage value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - \u00b5V, mv, V, kV, MV)"
},
"beamCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the measured current of the e-beam, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
},
"gunPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Gives the pressure maintained in the FIB gun"
},
"gunVacuum": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Gives the pressure maintained in the electron gun"
},
"highCurrent": {
"description": "(Optional) - Is special control of the electron optics enabled to increase the specimen current? true or false",
"type": "boolean"
},
"sourceID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - identifier for the e-beam source"
},
"sourceLifetime": {
"$ref": "#/$defs/lifetimeDetails",
"description": "(Optional) - lifetime of the source (default value - uAh) of datatype string"
},
"sourceName": {
"description": "(Optional) - name of the e-beam source of datatype string",
"type": "string"
}
},
"required": [
"accelerationVoltage"
],
"type": "object"
},
"stageDetails": {
"additionalProperties": false,
"description": "describes the stage settings during a measurement.",
"properties": {
"coordinateReference": {
"default": "origin at centre of sample",
"description": "(Optional) - description of the reference used for defining the coordinates (for eg. - origin at centre of sample, distances from two edges, etc.)",
"type": "string"
},
"coordinates": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - the xyz coordinates of a point expressed separately as coordinateSet which allows entering each of the xyz coordinates along with their optional uncertainties. If correllation images (two reference spots) are available, the coordinates enable correlative microscopy and they need to be entered"
},
"eBeamWorkingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the distance at which the beam is focussed (when the sample is in focus, this will be the distance between the bottom end of the pole-piece of the objective lens and the sample) defined separately as distanceDetails, with the distance value, optional uncertainty, optional notes, optional qualifier and choice of units between nm, um, mm, cm and m"
},
"isCorrelationImage": {
"description": "(Optional) - Whether the image is used for correlating in xyz coordinates with another image? Check if true. If true the coordinates have to be entered for the sake of correlative characterization of datatype boolean",
"type": "boolean"
},
"preTilt": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - predefined angle of a tilted sample holder which is tilted by design defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"stageAlignmentDone": {
"description": "(Optional) - was stage alignment done? (check if true)",
"type": "boolean"
},
"stageTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the stage is actually tilted (Stage at T) defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"tiltCorrectionAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - angle used to correct the tilt of the sample defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"tiltCorrectionType": {
"default": "none",
"description": "(Optional) - the tilt correction type applied to the image to compensate for the tilting, for e.g., sample surface, cross-section, none or manual, default value- none of datatype string",
"type": "string"
}
},
"required": [
"eBeamWorkingDistance",
"stageTiltAngle"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5s",
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s default value - \u00b5s) of datatype string",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "kV",
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV default value - V) of datatype string",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"voxelDetails": {
"additionalProperties": false,
"description": "describes the size of a voxel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "mm",
"description": "(Required) - the unit of the value of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The voxel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"weightDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a weight.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "\u00b5g",
"description": "(Required) - Unit of the value to be selected from a controlled list (ng, \u00b5g, mg, g, kg, default value - ug)",
"enum": [
"ng",
"\u00b5g",
"mg",
"g",
"kg"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the weight",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided.",
"properties": {
"entry": {
"$ref": "#/$defs/entry"
}
},
"required": [
"entry"
],
"title": "lab_CT",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 02e2da6fb3dfa94515b291ab6e2126991d3c02d7 | 2023-12-07T14:10:15 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"FIBDetails": {
"additionalProperties": false,
"description": "Details about the focussed ion beam (FIB) extension if present.",
"properties": {
"FIBColumn": {
"description": "(Optional) - The name of the I-beam column used",
"type": "string"
},
"FIBExtractor": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The extractor voltage used for the I-Beam"
},
"FIBProbe": {
"description": "(Required) - The settings used for the probe, extractor voltage:milling current. eg. 30kV:50pA",
"type": "string"
},
"FIBSpotSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - spot size of the i-beam at the focus when the sample is in focus (also the spot size on the sample) defined separately as distanceDetails (Allowed units: nm, um, mm, cm, m)"
},
"angleToEBeam": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - angle between e-beam and i-beam defined separately as angleDetails (Allowed units: degree, radian)"
},
"gasInjectionSystem": {
"$ref": "#/$defs/GISDetails",
"description": "(Optional) - Details about the gas injection system (GIS) defined separately as GISDetails"
},
"iBeamSource": {
"$ref": "#/$defs/sourceDetails",
"description": "(Required) - describes the details of the FIB source, defined separately as sourceDetails in which it is important to note the accelerating voltage and beam current of the i-beam"
},
"iBeamWorkingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Working distance of the ion beam (i-beam) defined separately as distanceDetails - this value needs to be entered if the i-beam focus has to be set independently from the e-beam focus (Allowed units: nm, um, mm, cm, m)"
}
},
"required": [
"iBeamSource",
"FIBExtractor",
"FIBProbe"
],
"type": "object"
},
"GISDetails": {
"additionalProperties": false,
"description": "gives the details of the gas injection system (GIS).",
"properties": {
"GISName": {
"description": "(Optional) - Name of the GIS system of datatype string",
"type": "string"
},
"beamDepositionType": {
"description": "(Optional) - type of beam deposition of datatype string to choose between e-beam deposition and i-beam deposition",
"enum": [
"E-beam Deposition",
"I-beam Deposition"
],
"type": "string"
},
"depositionCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current used for performing beam deposition defined separately as currentDetails (Allowed units pA,nA,uA,mA,A)"
},
"depositionSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the deposition defined separately as distanceDetails (Allowed units nm,um,mm,cm,m)"
},
"depositionTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - total time for deposition defined separately as timeDetails (Allowed units ps,ns,us,ms,s)"
}
},
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "degree",
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"default": "\u00b5m",
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "pA",
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string.",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"detectorDetails": {
"additionalProperties": false,
"description": "gives the settings of a detector.",
"properties": {
"componentGeometry": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - xyz coordinates describing the position of the detector defined separately as coordinateSet"
},
"detectorBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - bias voltage applied to the detector defined separately as voltageDetails. Allowed units nV, uV, mV, V, kV"
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector"
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - describes the details of the detector (manufacturerName, modelName and detectorID) as part of manufacturerDetails"
},
"detectorName": {
"description": "(Required) -Name of the detector of datatype string",
"type": "string"
},
"detectorType": {
"default": "Secondary Electron",
"description": "(Optional) - The type of detector (e.g., surface electron detection, secondary electron, back-scattered electron) of datatype string",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (CCYY-MM-DDThh:mm:ss.sss) of the date-time format",
"pattern": "(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z)",
"type": "string"
}
},
"required": [
"detectorName"
],
"type": "object"
},
"detectorSetDetails": {
"additionalProperties": false,
"description": "gives information about signal mixing between two detectors and provides the information about the detector(s).",
"properties": {
"detector1": {
"$ref": "#/$defs/detectorDetails",
"description": "(Required) - gives the settings of one detector defined separately as detectorDetails; entering the details of at least one detector is compulsory"
},
"detector2": {
"$ref": "#/$defs/detectorDetails",
"description": "(Optional) - gives the settings of a second detector defined separately as detectorDetails"
},
"signalMixingDescription": {
"description": "(Optional) - Describes the purpose and technique of signal mixing of datatype string",
"type": "string"
},
"signalMixingDone": {
"default": false,
"description": "(Optional) - whether the detector signals are mixed, true or false, of datatype boolean",
"type": "boolean"
}
},
"required": [
"detector1"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"eBeamDecelerationDetails": {
"additionalProperties": false,
"description": "Details about deceleration of the e- beam.",
"properties": {
"landingEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Landing energy of the e-beam defined separately as energyDetails (allowed units - meV, eV, keV, nJ, mJ, J, kJ, MJ)"
},
"stageBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Bias voltage applied to the stage defined separately biasDetails (allowed units - nV, uV, mV, V, kV, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "keV",
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ; default value - keV) of datatype string",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"entry": {
"additionalProperties": false,
"description": "Required) - The entry level is the root element of the schema. It contains all the metadata describing a CT measurement.",
"properties": {
"definition": {
"description": "(Optional) - Name of the schema to which this entry conforms. In this case, lab_CT should be written",
"type": "string"
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "entryID (Optional) - Identifier of the metadata entry usually provided by the project or the laboratory"
},
"experimentID": {
"$ref": "#/$defs/identifier",
"description": "entryID (Optional) - Identifier of the measurement usually provided by the project or the laboratory"
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings"
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition"
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format"
},
"sample": {
"$ref": "#/$defs/sample",
"description": "(Required)- Details concerning the sample"
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement",
"type": "string"
},
"user": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/user_description.json",
"description": "(Required)- The contact information of the user responsible for the measurement"
}
},
"required": [
"title",
"startTime",
"endTime",
"program",
"user",
"instrument"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/unit time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min) default value - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"imagingDetails": {
"additionalProperties": false,
"description": "describes the imaging settings of the instrument during the measurement.",
"properties": {
"apertureSetting": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Optional) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). The element apertureSetting is defined separately as apertureSettingType which gives the option to choose between current or size. If the size can be set directly, then it is defined with the complex type distanceDetails, else if the aperture setting is controlled with the beam current defined separately as currentDetails"
},
"collectionMethod": {
"default": "normal scan",
"description": "(Optional) - the method of collection of the image, for e.g., normal scan, average of multiple images, integration of multiple images, default value - normal scan, of datatype string",
"type": "string"
},
"cycleTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - the time taken by the beam to scan a frame, defined separately as timeDetails. It is the time needed to scan a line times the number of lines in a frame."
},
"dwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - the dwell time of the beam per pixel, defined separately as timeDetails"
},
"dynamicFocus": {
"description": "(Optional) - To be set to true if dynamic focus is turned on, else false",
"type": "boolean"
},
"noiseReduction": {
"description": "(Optional) - The type of noise reduction used as an enumerated list of six parameters: Pixel Avg, Line Avg, Frame Avg, Pixel Int, Line Int, Frame Int.",
"enum": [
"Pixel Avg",
"Line Avg",
"Frame Avg",
"Pixel Int",
"Line Int",
"Frame Int"
],
"type": "string"
},
"numberOfPixels": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The number of x, y pixels of the image, defined separately as pixelNumberType with separate entries for integer values of xPixels and yPixels"
},
"pixelSize": {
"$ref": "#/$defs/pixelsize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel, normally expressed in nm/pixel, defined separately as pixelSize3D for the mapping along x,y and z directions, with each pixel having a pixelSize, optional uncertainty, optional qualifier and optional notes. The y-pixel-size is to be given only if it is different from the x-pixel-size, and z-pixel-size can be ignored if it is greater than voxel size"
},
"voxel": {
"$ref": "#/$defs/voxelDetails",
"description": "(Optional) - Size of the voxel in case 3D imaging is done for Energy-dispersive X-ray Spectroscopy or Electron-backscatter Diffraction, defined separately as voxelDetails"
}
},
"required": [
"numberOfPixels",
"pixelSize"
],
"type": "object"
},
"institutionDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the institution to which the user is affiliated.",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier pertaining to the institution (e.g. ROR)"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray Target in an SEM based CT set-up",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required) - Details of the pressure maintained in the chamber of the SEM."
},
"electronBeamShift": {
"additionalProperties": false,
"description": "(Required) - The distance by which the electron beam is shifted in the x and y directions.",
"properties": {
"xShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the x direction. Typical unit - \u00b5m."
},
"yShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xShift",
"yShift"
],
"type": "object"
},
"electronProbeCurrent": {},
"objectiveLensAperture": {},
"target": {},
"targetDriftCorrection": {},
"workingDistance": {}
},
"required": [
"chamberPressure",
"electronBeamShift",
"workingDistance",
"targetDriftCorrection",
"objectiveLensAperture",
"electronProbeCurrent",
"target"
],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray enrgy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source"
],
"type": "object"
},
"lifetimeDetails": {
"additionalProperties": false,
"description": "describes a lifetime.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5Ah",
"description": "(Required) - the unit of the value (default value - \u00b5Ah) of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The lifetime of the source expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"bioReactor": {
"additionalProperties": false,
"description": "(Optional) - Details of an in situ bioreactor.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in sterile conditions.",
"type": "boolean"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is decreased. Typical unit - K/min."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is increased, typically in K/min."
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"chamberName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes the resolution of the image split into number of pixels in x and y directions.",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "nm/pixel",
"description": "(Required) - the unit of the value (default value - nm/pixel) of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"pixelsize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm/pixel, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min, default value - max) of datatype string.",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"default": "W",
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW, default value - W) of datatype string.",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "Pa",
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"rampDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a rate at which temperature is increased or decreased.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K/min",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K/min, K/s)",
"enum": [
"K/min",
"K/s"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of temperature increase or decrease.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"sample": {
"additionalProperties": false,
"description": "(Required) - Details concerning the sample.",
"properties": {
"sampleForm": {
"description": "(Optional) - Description of the sample form (e.g., bulk, nanostructured, powder, pellet)",
"type": "string"
},
"sampleHolder": {
"description": "(Optional) - Type of sample holder used",
"type": "string"
},
"sampleID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the sample"
},
"sampleName": {
"description": "(Optional) - Name of the sample",
"type": "string"
},
"samplePreparation": {
"$ref": "#/$defs/samplePrepType",
"description": "(Optional) - Details pertaining to the sample prepapration like date, ID, etc"
},
"sampleSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the sample"
},
"sampleWeight": {
"$ref": "#/$defs/weightDetails",
"description": "(Optional) - Weight of the sample"
},
"storageConditions": {
"default": "Ambient, dry environment",
"description": "(Optional) - Environment conditions in which the sample has to be stored before and after the measurement (e.g., nitrogen atmosphere, hermetically sealed, controlled temperature and pressure).",
"type": "string"
}
},
"type": "object"
},
"samplePrepType": {
"additionalProperties": false,
"description": "(Optional) - Describes the sample preparation process.",
"properties": {
"preparationDate": {
"description": "(Optional) - Date of the sample preparation.",
"format": "date",
"type": "string"
},
"preparationDescription": {
"description": "(Optional) - Short description of the sample preparation.",
"type": "string"
},
"preparationID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the sample preparation."
}
},
"type": "object"
},
"sourceDetails": {
"additionalProperties": false,
"description": "gives details about the electron beam source.",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - the voltage with which the e-beam is accelerated, defined separately as voltageDetails, (includes the voltage value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - \u00b5V, mv, V, kV, MV)"
},
"beamCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the measured current of the e-beam, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
},
"gunPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Gives the pressure maintained in the FIB gun"
},
"gunVacuum": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Gives the pressure maintained in the electron gun"
},
"highCurrent": {
"description": "(Optional) - Is special control of the electron optics enabled to increase the specimen current? true or false",
"type": "boolean"
},
"sourceID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - identifier for the e-beam source"
},
"sourceLifetime": {
"$ref": "#/$defs/lifetimeDetails",
"description": "(Optional) - lifetime of the source (default value - uAh) of datatype string"
},
"sourceName": {
"description": "(Optional) - name of the e-beam source of datatype string",
"type": "string"
}
},
"required": [
"accelerationVoltage"
],
"type": "object"
},
"stageDetails": {
"additionalProperties": false,
"description": "describes the stage settings during a measurement.",
"properties": {
"coordinateReference": {
"default": "origin at centre of sample",
"description": "(Optional) - description of the reference used for defining the coordinates (for eg. - origin at centre of sample, distances from two edges, etc.)",
"type": "string"
},
"coordinates": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - the xyz coordinates of a point expressed separately as coordinateSet which allows entering each of the xyz coordinates along with their optional uncertainties. If correllation images (two reference spots) are available, the coordinates enable correlative microscopy and they need to be entered"
},
"eBeamWorkingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the distance at which the beam is focussed (when the sample is in focus, this will be the distance between the bottom end of the pole-piece of the objective lens and the sample) defined separately as distanceDetails, with the distance value, optional uncertainty, optional notes, optional qualifier and choice of units between nm, um, mm, cm and m"
},
"isCorrelationImage": {
"description": "(Optional) - Whether the image is used for correlating in xyz coordinates with another image? Check if true. If true the coordinates have to be entered for the sake of correlative characterization of datatype boolean",
"type": "boolean"
},
"preTilt": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - predefined angle of a tilted sample holder which is tilted by design defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"stageAlignmentDone": {
"description": "(Optional) - was stage alignment done? (check if true)",
"type": "boolean"
},
"stageTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the stage is actually tilted (Stage at T) defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"tiltCorrectionAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - angle used to correct the tilt of the sample defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"tiltCorrectionType": {
"default": "none",
"description": "(Optional) - the tilt correction type applied to the image to compensate for the tilting, for e.g., sample surface, cross-section, none or manual, default value- none of datatype string",
"type": "string"
}
},
"required": [
"eBeamWorkingDistance",
"stageTiltAngle"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5s",
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s default value - \u00b5s) of datatype string",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "kV",
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV default value - V) of datatype string.",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"voxelDetails": {
"additionalProperties": false,
"description": "describes the size of a voxel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "mm",
"description": "(Required) - the unit of the value of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The voxel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"weightDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a weight.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "\u00b5g",
"description": "(Required) - Unit of the value to be selected from a controlled list (ng, \u00b5g, mg, g, kg, default value - ug)",
"enum": [
"ng",
"\u00b5g",
"mg",
"g",
"kg"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the weight",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided.",
"properties": {
"entry": {
"$ref": "#/$defs/entry"
}
},
"required": [
"entry"
],
"title": "lab_CT",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 7e9928f8ce41b2b75594ade724716f8a01c04f47 | 2024-01-11T10:06:41 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"CTAquisition": {
"additionalProperties": false,
"description": "(Required) - Details about the acquisition.",
"properties": {
"acquisitionScriptName": {
"description": "(Required) - Name of the script used for acquisition.",
"type": "string"
},
"acquisitionTimePerProjection": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time taken for acquisition of a single projection. Typical unit - s."
},
"angularStepSize": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Step size of the rotation of the sample during the CT. Typical unit - degree."
},
"contrastType": {
"description": "(Required) - The contrast type(mode) used - Absorption Contrast or Phase Contrast. If 'Phase Contrast' is selected, please indicate the used Phase Contrast Mode under the field phaseContrastMode.",
"enum": [
"Absorption Contrast",
"Phase Contrast"
],
"type": "string"
},
"endAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - End angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then endAngle is 180\u00b0. Typical unit - degree."
},
"largeFOV": {
"description": "(Required) - To be set to true if large field of view or wide field of view is used.",
"type": "boolean"
},
"numberOfProjections": {
"description": "(Required) - Number of projections acquired during the CT.",
"type": "number"
},
"phaseContrastMode": {
"description": "(Optional) - The phase contrast mode used during acquisition - Zernike phase contrast, propagation-based, grating-based(Hartmann), grating-based(Talbot).",
"enum": [
"Zernike phase contrast",
"Propagation-based",
"Grating-based(Hartmann)",
"Grating-based(Talbot)"
],
"type": "string"
},
"referenceImages": {
"additionalProperties": false,
"description": "(Optional) - Details on the reference images (if used) - number of flats/bright images and number of dark images.",
"properties": {
"numberOfBrightImages": {
"description": "(Optional) - Number of flats or bright images used as reference.",
"type": "number"
},
"numberOfDarkImages": {
"description": "(Optional) - Number of dark images used as reference.",
"type": "number"
}
},
"type": "object"
},
"scanningMode": {
"description": "(Optional) - The scanning mode used during acquisition - helical, raster scanning, fast CT.",
"enum": [
"Helical",
"Raster Scanning",
"Fast CT"
],
"type": "string"
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Start angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then startAngle is -180\u00b0. Typical unit - degree."
},
"totalAcquisitionTime": {
"description": "(Required) - Time taken for acquisition for the entire scan. This is the total scan time, i.e. number of projections multipled by exposure time, but including read-out time. calculated as EndTime-StartTime. Format: hh:mm:ss.",
"format": "time",
"pattern": "^(\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?)$",
"type": "string"
},
"useBadPixelMap": {
"description": "(Optional) - To be set to true if bad pixel map is used. This parameter is relevant for SEM based CT.",
"type": "boolean"
}
},
"required": [
"acquisitionScriptName",
"startAngle",
"endAngle",
"angularStepSize",
"acquisitionTimePerProjection",
"totalAcquisitionTime",
"largeFOV",
"contrastType"
],
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "degree",
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"angleSet": {
"additionalProperties": false,
"description": "(Optional) - Tilt angles alpha, beta and gamma decribing the three angular positions of an item.",
"properties": {
"alpha": {
"description": "(Optional) - Tilt angle alpha of the item.",
"type": "number"
},
"anglesUnit": {
"default": "degree",
"description": "(Optional) - unit of the angles (allowed units - degree or radian)",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"beta": {
"description": "(Optional) - Rotation angle beta of the item.",
"type": "number"
},
"gamma": {
"description": "(Optional) - Angle gamma of the item.",
"type": "number"
}
},
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"default": "\u00b5m",
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "pA",
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string.",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"data": {
"additionalProperties": false,
"description": "(Required) - Details about the data section of the measurement.",
"properties": {
"projections": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"cropping": {
"additionalProperties": false,
"description": "(Optional) - Details about cropping or clipping to select a region of interest(ROI).",
"properties": {
"ROI": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The size of the region of interest (ROI) in integer values of xPixels and yPixels."
},
"offset": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The offset applied to the origin (i.e., centre of the image) to select the region of interest in x and y coordinates."
}
},
"required": [
"ROI",
"offset"
],
"type": "object"
},
"projectionImageDataStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the data structure of the image data of the projections.",
"properties": {
"IOValue": {
"description": "(Required) - The IO value obtained from the metadata.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The dimension of the image as for integer values of xPixels and yPixels."
},
"fileLocation": {
"description": "(Required) - The location where the data file is stored. A URL is preferred if available.",
"type": "string"
},
"greyValueRepresentation": {
"description": "(Optional) - Description about the grey value representation.",
"type": "string"
},
"header": {
"additionalProperties": false,
"description": "(Required) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Required) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"imageCorrection": {
"additionalProperties": false,
"description": "(Optional) - Details about the image correction.",
"properties": {
"isImageCorrected": {
"description": "(Required) - To be set as true if image is corrected.",
"type": "boolean"
},
"linkToReferenceImages": {
"description": "(Required) - Link to the reference images (flats/darks).",
"format": "uri-reference",
"type": "string"
}
},
"required": [
"isImageCorrected",
"linkToReferenceImages"
],
"type": "object"
},
"imageFormats": {
"additionalProperties": false,
"description": "(Required) - The file formats of the images - tiff, png, jpeg. When more than one file formats are there, then the formats are to be entered as an array of strings.",
"properties": {
"fileFormats": {
"oneOf": [
{
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
{
"items": {
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"fileFormats"
],
"type": "object"
},
"imageID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the Image Data."
},
"isPreFiltered": {
"description": "(Optional) - To be set as true if image is prefiltered.",
"type": "boolean"
},
"name": {
"description": "(Required) - Name of the Projection Image Data.",
"type": "string"
},
"numberOfImages": {
"description": "(Required) - Number of images in the data set. It is same as the number of projections.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical x,y length imaged by a single pixel, normally expressed in \u00b5m."
}
},
"required": [
"fileLocation",
"name",
"imageFormats",
"header"
],
"type": "object"
}
},
"required": [
"projectionImageDataStructure"
],
"type": "object"
},
"reconstructedData": {
"additionalProperties": false,
"description": "(Required) - Details about the reconstructed slices. When multiple reconstructions of the same raw data (projections) are present, the corresponding data can be combined as an array of reconstruction data sets, else as a single reconstruction data set.",
"properties": {
"reconstruction": {
"oneOf": [
{
"$ref": "#/$defs/reconstruction"
},
{
"items": {
"$ref": "#/$defs/reconstruction"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"reconstruction"
],
"type": "object"
}
},
"required": [
"projections",
"reconstructedData"
],
"type": "object"
},
"detector": {
"additionalProperties": false,
"description": "gives the settings of a detector or multiple detectors.",
"properties": {
"detectorSettings": {
"oneOf": [
{
"$ref": "#/$defs/detectorSettings"
},
{
"items": {
"$ref": "#/$defs/detectorSettings"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"detectorSettings"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "(Required) - Gives the settings of a single detector.",
"properties": {
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each pixel or voxel in an image. The bit depth determines the number of possible intensity levels that can be assigned to each pixel or voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"cameraGain": {
"description": "(Optional) - The amplification (gain) of the signal from an image sensor in a camera.",
"type": "number"
},
"detectorCoolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Cooling temperature of the detector, if it cooled. Relevant for SEM based CT. Typical unit - K."
},
"detectorDimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Optional) - The dimensions of the detector in integer values of xPixels and yPixels."
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector."
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the detector (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"detectorMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - The motor positions of the detector in cartesian coordinates and tilt angles."
},
"detectorName": {
"description": "(Optional) - Name of the detector of datatype string.",
"type": "string"
},
"detectorPixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical length in cartesian coordinates imaged by a single pixel of the detector. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"detectorType": {
"description": "(Optional) - The type of detector to be selected from a controlled list consisting of CCD, Panel, PCXD, CMOS, Time-Delay Integration (TDI) and Direct Conversion.",
"enum": [
"CCD",
"Panel",
"PCXD",
"CMOS",
"Time-Delay Integration (TDI)",
"Direct Conversion"
],
"type": "string"
},
"energyThreshold": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - A specific energy level used to filter the detected radiation."
},
"exposureTimePerFrame": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Time for which the sample is exposed per frame. Typical unit - s."
},
"frameSkip": {
"additionalProperties": false,
"description": "(Optional) - A numerical representation indicating the number of frames that are skipped or omitted during the acquisition or recording process. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3. If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped.",
"properties": {
"value": {
"oneOf": [
{
"description": "(Optional) - Number of frames skipped during acquisition. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3.",
"type": "number"
},
{
"description": "(Optional) - Pattern of frames skipped during acquisition. E.g. - If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped like [1,3,5]",
"items": {
"type": "number"
},
"minItems": 1,
"type": "array"
}
]
}
},
"type": "object"
},
"framesPerSecond": {
"description": "(Optional) - The number of frames captured in a second.",
"type": "number"
},
"imagePixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical length in cartesian coordinates imaged by a single pixel of the image. It is the native pixel size divided by the total magnification. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"lens": {
"additionalProperties": false,
"description": "(Optional) - Details of a lens, if used with the detector.",
"properties": {
"hasLens": {
"description": "(Required) - To be set to true if the detector has a lens.",
"type": "boolean"
},
"lensFocalLength": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Focal length of the lens."
},
"lensID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the lens."
},
"lensMagnification": {
"description": "(Optional) - Magnification of the lens as a floating point number.",
"type": "number"
},
"lensManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the lens (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"lensName": {
"description": "(Optional) - Name of the lens of datatype string.",
"type": "string"
}
},
"required": [
"lensMagnification",
"lensFocalLength"
],
"type": "object"
},
"numberOfAveragedFramesPerProjection": {
"description": "(Optional) - The number of averaged frames per projection, if averaging is done.",
"type": "number"
},
"sensor": {
"additionalProperties": false,
"description": "(Optional) - Details about a sensor, if present.",
"properties": {
"hasSensor": {
"description": "(Required) - To be set to true if the detector has a sensor.",
"type": "boolean"
},
"sensorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the sensor."
},
"sensorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the sensor (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"sensorMaterial": {
"description": "(Optional) - Material of the sensor of datatype string.",
"type": "string"
},
"sensorName": {
"description": "(Optional) - Name of the sensor of datatype string.",
"type": "string"
},
"sensorThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the sensor."
},
"sensorType": {
"description": "(Optional) - The type of sensor as a string.",
"type": "string"
}
},
"required": [
"hasSensor"
],
"type": "object"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Temperature of the detector."
},
"totalCountsPerProjection": {
"description": "(Optional) - The sum of the intensity values recorded by the X-ray detector for a single projection during a scan.",
"type": "number"
}
},
"required": [
"detectorType",
"detectorManufacturer",
"binning",
"detectorMotorPositions",
"imagePixelSize"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ; default value - keV) of datatype string",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min) default value - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"geometry": {
"additionalProperties": false,
"description": "Describes the geometry of the CT instrument",
"properties": {
"beamGeometry": {
"additionalProperties": false,
"description": "(Required) - Details about beam geometry like beam geometry type and divergence angle.",
"properties": {
"beamGeometryType": {
"description": "(Required) - The type of the beam geometry to be selected between 'collimated' and 'divergent'.",
"enum": [
"collimated",
"divergent"
],
"type": "string"
},
"divergenceAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Angle of divergence when the beam geometry is divergent. Typical unit - degree."
}
},
"type": "object"
},
"geometricMagnification": {
"description": "(Required) - Geometric magnification refers to the ratio of the size of an object's image to the size of the object itself. It is a measure of how much larger the image appears compared to the actual object. Geometric magnification (M) is calculated using the formula M = (SID + SOD) / SID, where SID is the source-to-image distance and SOD is the source-to-object distance.",
"type": "number"
},
"objectToDetectorDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the object and the detector. Typical unit - \u00b5m."
},
"opticalMagnification": {
"description": "(Required) - Optical magnification is calculated as the ratio of the focal length of the objective lens to the focal length of the eyepiece (if an eyepiece is present) in a traditional optical microscope.",
"type": "number"
},
"sourceToObjectDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the source and the object. Typical unit - \u00b5m."
}
},
"required": [
"sourceToObjectDistance",
"objectToDetectorDistance",
"beamGeometry",
"geometricMagnification",
"opticalMagnification"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"CTAquisition": {
"$ref": "#/$defs/CTAquisition",
"description": "(Optional) - Details regarding the acquisition."
},
"calibration": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the calibration and the scaling factor.",
"properties": {
"calibrationType": {
"description": "(Optional) - Type of calibration as a string.",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (YYYY-MM-DDThh:mm:ss.sss) in the ISO 8601 date-time format",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"systemScaling": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scaling factor.",
"properties": {
"adjustSystemScaling": {
"description": "(Required) - To be set to true if system scaling is adjusted, else false.",
"type": "boolean"
},
"measuredScalingFactor": {
"description": "(Optional) - Value of the measured scaling factor.",
"type": "number"
},
"referenceScalingFactor": {
"description": "(Optional) - Value of the reference scaling factor, determined ususally during the data processing.",
"type": "number"
}
},
"required": [
"adjustSystemScaling"
],
"type": "object"
}
},
"type": "object"
},
"detector": {
"$ref": "#/$defs/detector",
"description": "(Optional) - Details regarding the detector."
},
"focalSpotMode": {
"additionalProperties": false,
"description": "(Optional) - Option for setting the size of the focal spot. Some sources have the option to select the target spot size, or focal spot size absolutely by setting a value, while some others give the option of selecting 'small', 'medium' or 'large'. Smaller spot size = higher resolution. Note that the power/current will change with this value. In addition, the detector settings will usually be selected in conjunction. (different scintillator/lens/magnification).",
"properties": {
"selection": {
"description": "(Optional) - Selection of the setting of the size of the focal spot when the option for setting the size of the focal spot by selecting 'small', 'medium' or 'large' according to predefined values set by the manufacturer.",
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the target spot when the option for setting the size of the focal spot absolutely by setting a value is available."
}
},
"type": "object"
},
"geometry": {
"$ref": "#/$defs/geometry",
"description": "(Optional) - Details regarding the geometry."
},
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"optics": {
"$ref": "#/$defs/optics",
"description": "(Optional) - Details about the optics and individual motor positions."
},
"sampleStage": {
"$ref": "#/$defs/sampleStage",
"description": "(Optional) - Details regarding the sample stage."
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray target in an SEM based CT set-up.",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required) - Details of the pressure maintained in the chamber of the SEM."
},
"electronBeamShift": {
"additionalProperties": false,
"description": "(Required) - The distance by which the electron beam is shifted in the x and y directions.",
"properties": {
"xShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the x direction. Typical unit - \u00b5m."
},
"yShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xShift",
"yShift"
],
"type": "object"
},
"electronProbeCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required) - The electron current measured at the probe. Typical unit - \u00b5A."
},
"objectiveLensAperture": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). Typically the diameter of the aperture is set in \u00b5m."
},
"target": {
"additionalProperties": false,
"description": "(Required) - Details regarding the target in SEM based CT, which upon interaction with the e-beam produces the X-rays.",
"properties": {
"targetDriftCorrection": {
"description": "(Required) - If drift correction is activated for the target, this parameter has to be set to true.",
"type": "boolean"
},
"targetMaterial": {
"description": "(Required) - Material with which the target is made.",
"type": "string"
},
"targetShape": {
"description": "(Optional) - Description of the shape or geometry of the target. e.g. - bulk, foil, needle.",
"type": "string"
},
"targetThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Thickness of the target (dimension in Z direction). Default unit - \u00b5m."
},
"targetTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the target is tilted. Typical unit - degree."
}
},
"required": [
"targetMaterial",
"targetThickness",
"targetDriftCorrection",
"targetTiltAngle",
"targetCurrent"
],
"type": "object"
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. In SEM based CT, the beam is focussed on the target material which emits the X-rays upon interaction with the electrons. Default unit - \u00b5m."
}
},
"required": [
"chamberPressure",
"electronBeamShift",
"workingDistance",
"objectiveLensAperture",
"electronProbeCurrent",
"target"
],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
},
"targetCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current measured at the X-ray target, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"sourceDrift": {
"additionalProperties": false,
"description": "(Optional) - Distance by which the source is shifted during the measurement (i.e., end position - start position).",
"properties": {
"xDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the x direction. Typical unit - \u00b5m."
},
"yDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xDrift",
"yDrift"
],
"type": "object"
},
"sourcePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the source."
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray enrgy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source",
"focalSpotMode",
"CTAquisition",
"geometry",
"sampleStage",
"detector"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer.",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"bioReactor": {
"additionalProperties": false,
"description": "(Optional) - Details of an in situ bioreactor.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in sterile conditions.",
"type": "boolean"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is decreased. Typical unit - K/min."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is increased, typically in K/min."
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"anvil": {
"description": "(Optional) - The type of anvil used in the in situ load frame (stage) for applying a particular type of force on the sample. Option to be selected from a controlled list consisting of - Compression, Diamond indentation 90\u00b0 cone, Diamond indentation cube corner, Diamond indentation wedge, Tension, Other. If 'Other' is selected, specify the name of the anvil with a description in the field 'otherAnvil'.",
"enum": [
"Compression",
"Diamond indentation 90\u00b0 cone",
"Diamond indentation cube corner",
"Diamond indentation wedge",
"Tension",
"Other"
],
"type": "string"
},
"blindAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - ed by the load frame(stage). Example: for a CT normally scanned over 180\u00b0 (e.g. -90\u00b0/+90\u00b0), a blind angle of 40\u00b0 due to the in situ cell implies that only 180\u00b0-40\u00b0=140\u00b0 (e.g. -70\u00b0/70\u00b0) is visible. NOTE: for a CT normally scanned over 360\u00b0 (e.g. -180\u00b0/+180\u00b0), a blind angle of 40\u00b0 would require the subtraction of the blind angle twice, implying two scan ranges of 140\u00b0 each (e.g. -160\u00b0/-20\u00b0 and +20\u00b0/+160\u00b0). Typical unit - degree."
},
"displacement": {
"additionalProperties": false,
"description": "(Optional) - Specification on how displacement is applied on the sample. Either 'displacementRate' in \u00b5m/min or 'displacementIncrement' in \u00b5m/acquisition need to be selected.",
"properties": {
"displacementIncrement": {
"description": "(Optional) - The step at which displacement is changed per acquisition in \u00b5m/acquisition.",
"type": "number"
},
"displacementRate": {
"description": "(Optional) - The rate at which displacement is applied on the sample in \u00b5m/min.",
"type": "number"
}
},
"type": "object"
},
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame or anvil (e.g. - size of anvil) relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
},
"maximumDisplacement": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - The maximum displacement allowed in the selected configuration. Typical unit - \u00b5m."
},
"maximumForce": {
"description": "(Optional) - The maximum force that can be applied to the sample in N.",
"type": "number"
},
"otherAnvil": {
"description": "(Optional) - If 'anvil' was selected as 'Other' from the controlled list as it was not listed, please specify the name of the anvil with a description in this field.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the vacuum chamber relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the vacuum chamber relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the vacuum chamber."
},
"chamberName": {
"description": "(Optional) - Name of the vacuum chamber.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"motorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchical level and direction of a motor.",
"properties": {
"motorDirection": {
"description": "(Required) - The direction of movement (for X,Y,Z,M motors) or axis of rotation (for rotating motors) expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the X-stage and perpendicular to the Y-stage. then beam direction = [1 0 0], X-stage-direction = [1 0 0] (positive movement direction away from source towards detector) or can be (-1 0 0) (towards source) and Y-stage-direction = [0 1 0] or can be [0 -1 0] (analogous interpretation). The parameters need to be individually determined for each instrument. For rotating motors, the directional vector of axis of rotation should be given in Cartesian coordinates (counterclockwise, right-hand rule).",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"motorLevel": {
"description": "(Required) - Hierarchy of the motor expressed as an integer.",
"type": "number"
}
},
"type": "object"
},
"motorPositions": {
"additionalProperties": false,
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the motor.",
"properties": {
"angles": {
"$ref": "#/$defs/angleSet",
"description": "(Optional) - The three tilt angles alpha, beta and gamma of the motors controlling the position of the item."
},
"xyzPositions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - The xyz coordinates describing the motor positions of the item."
}
},
"type": "object"
},
"optics": {
"additionalProperties": false,
"description": "(Optional) - Details about the optics and individual motor positions.",
"properties": {
"collimator": {
"additionalProperties": false,
"description": "(Optional) - Details about the collimator and its individual motor positions.",
"properties": {
"collimatorDetails": {
"description": "(Optional) - Details about the collimator relevant for the measurement.",
"type": "string"
},
"collimatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the collimator."
}
},
"type": "object"
},
"condenser": {
"additionalProperties": false,
"description": "(Optional) - Details about the condenser lens and its individual motor positions, if used.",
"properties": {
"condenserDetails": {
"description": "(Optional) - Details about the condenser relevant for the measurement.",
"type": "string"
},
"condenserPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the condenser."
}
},
"type": "object"
},
"fresnelZonePlate": {
"additionalProperties": false,
"description": "(Optional) - Details about the fresnel zone plate and its individual motor positions, if used.",
"properties": {
"fresnelZonePlateDetails": {
"description": "(Optional) - Details about the fresnel zone plate relevant for the measurement.",
"type": "string"
},
"fresnelZonePlatePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the fresnel zone plate."
}
},
"type": "object"
},
"monochromator": {
"additionalProperties": false,
"description": "(Required) - Details about the monochromator and individual motor positions, if used.",
"properties": {
"monochromatorDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the monochromator type type, material, energy and notes.",
"properties": {
"energy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Energy set in the monochromator. Typical unit - eV"
},
"material": {
"description": "(Optional) - Material of the monochromator.",
"type": "string"
},
"monochromatorType": {
"description": "(Optional) - Type of the monochromator.",
"type": "string"
},
"notes": {
"description": "(Optional) - Additional information about the monochromator relevant for the measurement."
}
},
"type": "object"
},
"monochromatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the monochromator."
},
"monochromatorUsed": {
"description": "(Required) - To be set to true if monochromator is used, else false.",
"type": "boolean"
}
},
"required": [
"monochromatorUsed"
],
"type": "object"
},
"phaseRing": {
"additionalProperties": false,
"description": "(Required) - Details about the phase ring and its individual motor positions, if inserted.",
"properties": {
"phaseRingDetails": {
"description": "(Optional) - Details about the phase ring relevant for the measurement.",
"type": "string"
},
"phaseRingPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the phase ring."
}
},
"type": "object"
}
},
"required": [
"monochromator"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes a parameter which can be split into number of pixels in x and y directions like the resolution",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm or \u00b5m, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "nm",
"description": "(Required) - the unit of the size of a single pixel (typical value - nm, \u00b5m) of datatype string",
"enum": [
"nm",
"\u00b5m"
],
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min, default value - max) of datatype string.",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"default": "W",
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW, default value - W) of datatype string.",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "Pa",
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"rampDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a rate at which temperature is increased or decreased.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K/min",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K/min, K/s)",
"enum": [
"K/min",
"K/s"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of temperature increase or decrease.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"reconstruction": {
"additionalProperties": false,
"description": "Data from one single reconstruction.",
"properties": {
"reconstructionDetails": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"additionalFilters": {
"beamHardeningCorrection": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"filterType": {
"description": "(Optional) - Type of the additional filter - Median or Gauss",
"enum": [
"Median",
"Gauss"
],
"type": "string"
},
"phaseRetrieval": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"ringFilter": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
}
},
"algorithm": {
"description": "(Required) - Algorithm used for reconstruction to be selected from FBP - Filtered Back Projection, ART - Algebraic Reconstruction Technique, 3dCT - 3D Computed Tomography and Gridrec.",
"enum": [
"FBP - Filtered Back Projection",
"ART - Algebraic Reconstruction Technique",
"3dCT - 3D Computed Tomography",
"Gridrec"
],
"type": "string"
},
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepthConversionMax": {
"description": "(Required) - Maximum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"bitDepthConversionMin": {
"description": "(Required) - Minimum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"hardwarePlatform": {
"description": "(Optional) - Hardware platform used for reconstruction to be selected between CPU and GPU.",
"enum": [
"CPU",
"GPU"
],
"type": "string"
},
"lastImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the last image for the reconstruction of the 3D Volume, typically an integer.",
"type": "string"
},
"projectionPadding": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the projection padding applied to the raw projection data to address certain issues in the reconstruction process.",
"properties": {
"paddingSize": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - Size of the projection padding used in pixels."
},
"paddingType": {
"description": "(Required) - Type of the projection padding used - Zero Padding, Linear Interpolation Padding, Sinc Interpolation Padding, Shepp-Logan Filtered Back Projection (SL-FBP), Gridding and Extended Field of View (FOV) Padding.",
"enum": [
"Zero Padding",
"Linear Interpolation Padding",
"Sinc Interpolation Padding",
"Shepp-Logan Filtered Back Projection (SL-FBP)",
"Gridding",
"Extended Field of View (FOV) Padding"
],
"type": "string"
}
},
"type": "object"
},
"reconstructionSoftware": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for reconstruction. It may be the same as the acquisition software or a different one."
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Scan angle at which the reconstruction of the 3D Volume starts. Typical unit - degree."
},
"startImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the start image for the reconstruction of the 3D Volume.",
"type": "string"
},
"tomographicProjectionFilter": {
"description": "(Optional) - Name of the tomographic projection filter used to be selected from Ram-Lak Filter, Butterworth Filter, Shepp-Logan Filter, Hann (Hanning) Filter, Gaussian Filter, Cosine Filter, Soft Filtration Method and Hard Filtration Method.",
"enum": [
"Ram-Lak Filter",
"Butterworth Filter",
"Shepp-Logan Filter",
"Hann (Hanning) Filter",
"Gaussian Filter",
"Cosine Filter",
"Soft Filtration Method",
"Hard Filtration Method"
],
"type": "string"
}
},
"required": [
"startImage",
"lastImage",
"startAngle",
"hardwarePlatform",
"algorithm",
"binning"
],
"type": "object"
},
"volumeStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each voxel in the 3D volume. The bit depth determines the number of possible intensity levels that can be assigned to each voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Required) - The dimension of the 3D volume in XYZ coordinates. If the length in Z dimension is not known and instead only the number of slices are known, they need to be separately entered in the field 'numberOfSlices'. Typical unit - \u00b5m."
},
"header": {
"additionalProperties": false,
"description": "(Optional) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Optional) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"name": {
"description": "(Required) - Name of the 3D volume structure (dataset).",
"type": "string"
},
"numberOfSlices": {
"description": "(Optional) - No. of slices which make up the 3D volume.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel/voxel, normally expressed in \u00b5m."
},
"volumeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry of the 3D reconstructed volume usually provided by the project or the laboratory."
}
},
"required": [
"name",
"dimensions",
"bitDepth",
"pixelSize"
],
"type": "object"
}
},
"required": [
"volumeStructure",
"reconstructionDetails"
],
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"sampleStage": {
"additionalProperties": false,
"description": "(Required) - Details about sample stage.",
"properties": {
"stageMotorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchy of the stage motors. This information is required to know how the motor movements affect the positions of the samples, particularly relevant for correlative characterization.",
"properties": {
"beamDirection": {
"description": "(Required) - The beam direction expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the Y-stage and perpendicular to the X-stage. then beam direction = [0 1 0].",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"mMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the M motor (stage) as a vector in cartesian coordiantes. The M motor is usually relevant only for SEM based CT. It is a special motor which counteracts the Z motor."
},
"rMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the R motor (stage) as a vector in cartesian coordiantes. R motor has rotation around z axis +1 (for anticlockwise)."
},
"tMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the T motor (stage) as a vector in cartesian coordiantes. The T motor is usually relevant only for SEM based CT."
},
"xMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the X motor (stage) as a vector in cartesian coordinates."
},
"yMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Y motor (stage) as a vector in cartesian coordinates."
},
"zMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Z motor (stage) as a vector in cartesian coordinates."
}
},
"required": [
"beamDirection",
"xMotor",
"yMotor",
"zMotor",
"rMotor"
],
"type": "object"
},
"stageMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the stage motors."
}
},
"required": [
"stageMotorHierarchy"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5s",
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s default value - \u00b5s) of datatype string",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"user": {
"description": "Basic schema for user description. It can be extended.",
"properties": {
"ORCID": {
"description": "(Optional) - Open Researcher and Contributor ID expressed as a URI",
"pattern": "^https://orcid\\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[X0-9]{1}$",
"type": "string"
},
"affiliation": {
"description": "(Optional) - Details of the institution to which the user is affiliated",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"description": "(Optional) -Identifier of the institution to which the user is affiliated",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be chosen from a controlled list of values (*ROR *GRID *ISNI *URL *DOI *Handle)",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"email": {
"description": "(Optional) - Email of the user",
"format": "email",
"type": "string"
},
"familyName": {
"description": "(Optional) - Family name of the user",
"type": "string"
},
"givenName": {
"description": "(Optional) - Given name of the user",
"type": "string"
},
"role": {
"description": "(Required) - Role of the research user",
"enum": [
"Data Curator",
"Instrument Scientist",
"Team Leader",
"Team Member"
],
"type": "string"
},
"userName": {
"description": "(Required) - Full name of the user in the format (Family Name, Given Name)",
"type": "string"
}
},
"required": [
"userName",
"role"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "kV",
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV default value - V) of datatype string.",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided. Contributors (in alphabetical order of last names): Alexey Boubnov, Rafaela Debastiani, Jonas Fell, Sarah Irvine, Reetu Elza Joseph.",
"properties": {
"consumables": {
"description": "(Optional) - Auxiliary entity used during Fabrication, Sample Preparation or Measurement which has a limited time capacity or is limited in its number of uses before it is disposed of, necessary to the process itself and normally bought from third party manufacturers. Examples are: gloves, syringes, wipes, etching solutions, glass slides, spatulas, weighing paper, two-sided tape.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"data": {
"$ref": "#/$defs/data",
"description": "(Required)- Details concerning the data section of the measurement."
},
"definition": {
"description": "(Required) - Name of the schema to which this entry conforms. In this case, lab_CT should be written.",
"type": "string"
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry usually provided by the project or the laboratory."
},
"equipment": {
"description": "(Optional) - Any kind of physical or virtual item, device, machine or other tools used to perform one or more Fabrication(s), Sample Preparation(s), Model Preparation(s), Data Acquisition(s) and/or any of the processes included in the Data Analysis Lifecycle. Usually, the Equipment is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. Equipment is usually an investment. According to this definition, an Instrument is a particular type of Equipment.",
"type": "string"
},
"experimentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the measurement usually provided by the project or the laboratory."
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings. Instrument is a physical or virtual identifiable piece of Equipment used to perform a Data Acquisition and to generate Raw Data. The Instrument is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. A virtual Instrument may be any computational resource or HPC infrastructure (cloud infrastructure or supercomputer) needed to perform Calculations or Simulations."
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure."
},
"measurementDescription": {
"description": "(Optional) - Description about the measurement.",
"type": "string"
},
"measurementPurpose": {
"description": "(Required) - Measurement is experimental Data Acquisition, typically performed on a Sample using an experimental Technique. It may also be performed during Fabrication or Sample Preparation, e.g., to characterise the intermediate stages and/or the final resulting Precursor(s) or Sample(s), respectively. A Measurement may require the use of Consumables.",
"enum": [
"assessment (to given categories or values)",
"completeness check (presence or absence of given properties)",
"correlative characterization (dedicated sample treatment to emphasise given features)",
"exploratory (routine check of known properties)",
"feasibility (quick check, rough estimate)",
"high quality measurement (precise, careful treatment)",
"test specific hypothesis (focus only on given aspects)",
"other (please specify in the comment)"
],
"type": "string"
},
"parents": {
"description": "(Required) - Parents of this metadata like the metadata document of the sample with which the measurement was performed.",
"items": {
"if": {
"properties": {
"parentType": {
"not": {
"const": "not applicable"
}
}
}
},
"properties": {
"parentReference": {
"description": "If type is 'MetaStore URI' it is possible to easily fill this field in a later stage",
"format": "uri-reference",
"type": "string"
},
"parentReferenceType": {
"default": "MetaStore URI",
"enum": [
"plain text",
"external URL",
"MetaStore URI"
],
"type": "string"
},
"parentType": {
"default": "sample",
"enum": [
"not applicable",
"sample"
],
"type": "string"
}
},
"required": [
"parentType"
],
"then": {
"required": [
"parentReferenceType",
"parentReference"
]
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition."
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format."
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"technique": {
"description": "(Required) - Any experimental, theoretical or computational method used during Data Acquisition or during any of the processes included in the Data Analysis Lifecycle to acquire, process or analyse Research Data about a System or a set of them with an Instrument, which is used to generate this metadata.",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement.",
"type": "string"
},
"user": {
"$ref": "#/$defs/user",
"description": "(Required)- The contact information of the user responsible for the measurement."
}
},
"required": [
"title",
"technique",
"definition",
"parents",
"measurementPurpose",
"startTime",
"endTime",
"program",
"user",
"instrument",
"data"
],
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | a630c6dc650ba68cd6c85f4608ef178b9a85c110 | 2023-11-24T15:29:33 | SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "degree",
"description": "(Unit) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "pA",
"description": "(Optional) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string",
"enum": [
"pA",
"nA",
"uA",
"mA",
"A"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Optional) - Further notes about the value of datatype string",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"detectorDetails": {
"additionalProperties": false,
"description": "(Required) - describes the settings related to the detector with which the image set is acquired",
"properties": {
"detectorSettings": {
"$ref": "#/$defs/detectorSettings",
"description": "(Required) - Settings of the specific detector used. E.g., the Everhart Thornley detector (ETD), is a secondary electron and back-scattered electron detector used in scanning electron microscopes, whihc has then particular settings"
},
"detectorType": {
"description": "(Required) - Type of the detector used",
"enum": [
"ETD",
"CDEM",
"CBS",
"ECD",
"External",
"GBSD",
"GSED",
"ICE",
"LFD",
"LVD",
"LVSED",
"None",
"STEM3",
"STEM3_GMode",
"STEM4",
"T1",
"T2",
"T3",
"TLD"
],
"type": "string"
},
"name": {
"description": "(Optional) - Name of the detector used",
"type": "string"
}
},
"required": [
"detectorType"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "describes the parameters of a detector such as the Everhart Thornley detector (ETD), which is a secondary electron and back-scattered electron detector used in scanning electron microscopes",
"properties": {
"brightness": {
"description": "(Optional) - A number indicating the brightness",
"type": "number"
},
"brightnessdB": {
"description": "(Optional) - Describes the brightness in dB",
"type": "number"
},
"contrast": {
"description": "(Optional) - A number indicating the contrast",
"type": "number"
},
"contrastdB": {
"description": "(Optional) - Describes the contrast in dB",
"type": "number"
},
"enhancedContrast": {
"description": "(Optional) - Describes the enhancement in contrast",
"type": "number"
},
"frontEndVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Bias voltage applied to the front end of the detector "
},
"grid": {
"description": "(Optional) - A number indicating the number of grid elements",
"type": "number"
},
"gridVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage applied to the grid "
},
"minimumDwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Minimum possible dwell time for the detector. IRI: https://purls.helmholtz-metadaten.de/EMG/00000006 "
},
"mix": {
"description": "(Optional) - Signals from different detectors can be overlaid (mixed) and this should, in theory, be the percentage of this detectors contribution to the end result.",
"type": "number"
},
"setting": {
"description": "(Optional) - In case of ETD, this is the bias voltage applied to the detector grid. Note that this block looks different for different detectors. ",
"type": "string"
},
"signal": {
"description": "(Optional) - The signal used for detection",
"enum": [
"SE",
"BSE",
"SI"
],
"type": "string"
}
},
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"eBeamDetails": {
"additionalProperties": false,
"description": "(Required) - Describes the configuration of the electron beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000007",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The potential difference between anode and cathode. The acceleration voltage adds kinetic energy to the particles of the beam. IRI: https://purls.helmholtz-metadaten.de/EMG/00000001 It is defined separately as voltageDetails, (includes the voltage value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - uV, mv, V, kV, MV)"
},
"apertureSetting": {
"additionalProperties": false,
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size (diameter) of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails."
}
},
"type": "object"
},
"beamCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Electrical current which flows along the beam path. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003 It is defined separately as currentDetails (includes the current value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)."
},
"dynamicFocusIsOn": {
"description": "(Optional) - To bet set true if dynamic focus is on. IRI:https://purls.helmholtz-metadaten.de/emg/00000039",
"type": "boolean"
},
"dynamicWDIsOn": {
"description": "(Required) - To bet set true if dynamic working distance is on. IRI: https://purls.helmholtz-metadaten.de/EMG/00000026",
"type": "boolean"
},
"horizontalFieldWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual horizontal length scanned on the sample defined separately as distanceDetails."
},
"imageMode": {
"description": "(Optional) - The type of image mode used. Could be a text or number depending on the instrument.",
"type": "string"
},
"lensMode": {
"description": "(Optional) - The type of image mode used",
"enum": [
"Field-Free",
"Immersion",
"EDS"
],
"type": "string"
},
"magnificationCorrection": {
"description": "(Optional) - To bet set true if magnification correction is on",
"type": "boolean"
},
"preTilt ": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Sometimes, pre-tilted holders are used and the pretilt angle must be given in the acquisition software because actual tilt = stage tilt plus pretilt."
},
"scanRotation": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Angle by which beam scanning direction is rotated"
},
"tiltCorrectionAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - If the sample is tilted, the image is compressed in the vertical direction, i.e. the pixels are not isotropic anymore. Tilt correction adapts the line spacing of the scanning to compensate for this. IRI:https://purls.helmholtz-metadaten.de/emg/00000037"
},
"tiltCorrectionIsOn": {
"description": "(Optional) - To bet set true if tilt correction is on. IRI:https://purls.helmholtz-metadaten.de/emg/00000037",
"type": "boolean"
},
"verticalFieldWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual vertical length scanned on the sample defined separately as distanceDetails."
}
},
"required": [
"accelerationVoltage",
"dynamicWDIsOn",
"verticalFieldWidth",
"horizontalFieldWidth",
"apertureSetting",
"scanRotation"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "J",
"description": "(Optional) - the unit of the value to be selected from a controlled list (nJ, mJ, J, kJ, eV, meV default value - J) of datatype string",
"enum": [
"nJ",
"mJ",
"J",
"kJ",
"eV",
"meV"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"hotStageMEMSDetails": {
"additionalProperties": false,
"description": "describes the parameters related if a hot stage MEMS is used",
"properties": {
"actualTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Describes the actual Temperature measured in the hot stage MEMS"
},
"heatingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Describes the heating current used in the hot stage MEMS"
},
"heatingPower": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Describes the heating power used in the hot stage MEMS"
},
"heatingVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Describes the heating voltage used in the hot stage MEMS"
},
"sampleBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Describes the bias voltage applied to the sample in the hot stage MEMS"
},
"sampleResistance": {
"$ref": "#/$defs/resistanceDetails",
"description": "(Optional) - Describes the target Temperature used in the hot stage MEMS"
},
"targetTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Describes the target Temperature set in the hot stage MEMS"
}
},
"type": "object"
},
"iBeamDetails": {
"additionalProperties": false,
"description": "(Required) - Describes the configuration of the ion beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000016",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The potential difference between anode and cathode. The acceleration voltage adds kinetic energy to the particles of the beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000001 It is defined separately as voltageDetails, (includes the voltage value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - uV, mv, V, kV, MV)"
},
"millingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Electrical current used in SEM-FIB Tomography to mill/cut the sample. In this case this is the same as the beam current of the ion beam. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003 It is defined separately as currentDetails (includes the current value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)."
}
},
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"imageDetails": {
"additionalProperties": false,
"description": "(Required) - describes the settings related to imaging",
"properties": {
"digitalBrightness": {
"description": "(Required) - A number indicating the setting for digital brightness (a basic post-processing method)",
"type": "number"
},
"digitalContrast": {
"description": "(Required) - A number indicating the setting for digital contrast (a basic post-processing method)",
"type": "number"
},
"digitalGamma": {
"description": "(Required) - A number indicating the setting for digital Gamma (a basic post-processing method)",
"type": "number"
},
"driftcorrected": {
"description": "(Required) - To bet set true if drift correction is on",
"type": "boolean"
},
"numberOfPixels": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The number of x, y pixels of the image (Resolution), defined separately as pixelNumberType with separate entries for integer values of xPixels and yPixels"
},
"postprocessing": {
"description": "(Optional) - Describes the post-processing performed on the image",
"type": "string"
},
"transformation": {
"description": "(Optional) - Describes the transformations performed on the image",
"type": "string"
},
"zoomfactor": {
"description": "(Required) - A number indicating the zoom factor",
"type": "number"
}
},
"required": [
"digitalContrast",
"digitalBrightness",
"digitalGamma",
"numberOfPixels",
"driftcorrected",
"zoomfactor"
],
"type": "object"
},
"imagesDetails": {
"desription": "(Required) - Details describing the images in the dataset, including location and image specific parameters",
"properties": {
"format": {
"default": "tiff",
"enum": [
"tiff",
"raw",
"png"
],
"type": "string"
},
"imageMetadataArray": {
"desription": "(Required) - Array containing the images and their specific parameters. No. of images in the array is described by the numberOfItems parameter at the entry level of this schema",
"items": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json"
},
"type": "array"
}
},
"required": [
"imageMetadataArray",
"format"
],
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"beamType": {
"description": "(Required) - The selected beam",
"enum": [
"EBeam",
"IBeam"
],
"type": "string"
},
"detector": {
"description": "(Required) - Details about the detector(s) used for acquisition.",
"items": {
"$ref": "#/$defs/detectorDetails"
},
"type": "array"
},
"eBeam": {
"$ref": "#/$defs/eBeamDetails",
"description": "(Required) - Details about the electron beam"
},
"hotStageMEMS": {
"$ref": "#/$defs/hotStageMEMSDetails",
"description": "(Optional) - Pressure maintained inside the chamber (in which the sample is housed) during the measurement"
},
"iBeam": {
"$ref": "#/$defs/iBeamDetails",
"description": "(Required) - Details about the ion beam"
},
"imaging": {
"$ref": "#/$defs/imageDetails",
"description": "(Optional) - Details about the imaging settings"
},
"numberOfDetectors": {
"description": "Number of detectors used for the acquisition",
"type": "number"
},
"scan": {
"$ref": "#/$defs/scanDetails",
"description": "(Required) - Details about the scan settings"
},
"spot": {
"description": "(Optional) - Qualitative index for beam current. Varies with current setting, i.e. 1.6 nA is spot = 1, 3.2 nA is spot = 2, 0.1 nA = spot =-3, so it can also be negative. May vary between different microscope models.",
"type": "number"
}
},
"required": [
"eBeam",
"scan",
"imaging",
"detector"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes the resolution of the image split into number of pixels in x and y directions.",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "describes a power",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "W",
"description": "(Optional) - the unit of the value to be selected from a controlled list (\u00b5W, mW, W, kW, MW default value - W) of datatype string",
"enum": [
"\u00b5W",
"mW",
"W",
"kW",
"MW"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The power expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "Pa",
"description": "(Optional) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"resistanceDetails": {
"additionalProperties": false,
"description": "describes a resistance",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "ohm",
"description": "(Optional) - the unit of the value to be selected from a controlled list (abohm, ohm, k ohm, M ohm default value - ohm) of datatype string; default unit is ohm",
"enum": [
"abohm",
"ohm",
"k ohm",
"M ohm"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The resistance expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"scanDetails": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scan settings.",
"properties": {
"average": {
"description": "(Optional) - Number of images averaged at each slice",
"type": "number"
},
"dwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time period during which the beam remains on one position/stationary. IRI: https://purls.helmholtz-metadaten.de/EMG/00000006 "
},
"eScan": {
"additionalProperties": false,
"description": "gives settings pertaining to electron beam scan",
"properties": {
"lineAveraging": {
"description": "(Optional) - Number of lines averaged",
"type": "number"
},
"lineIntegration": {
"description": "(Optional) - Number of lines integrated",
"type": "number"
},
"lineTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) -Time period during which a line is fully scanned."
},
"mainsLock": {
"description": "(Optional) - To bet set true if mains lock is on",
"type": "boolean"
},
"scanInterlacing": {
"description": "(Optional) - Number of scans interlaced. This setting splits an imaging area into blocks defined by the number of lines (from 2 to 8). In the first instance, the first line of each block is scanned, then the second one, etc. This imaging method significantly reduces charging.",
"type": "number"
}
},
"type": "object"
},
"frameTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) -Time period during which a frame is fully scanned. IRI: https://purls.helmholtz-metadaten.de/EMG/00000014 "
},
"horizontalFieldSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the actual horizontal length scanned on the sample defined separately as distanceDetails"
},
"integrate": {
"description": "(Optional) - Number of images integrated at each slice",
"type": "number"
},
"internalScan": {
"description": "(Optional) - To bet set true if internal scan is on",
"type": "boolean"
},
"pixelHeight": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual width of a pixel"
},
"pixelWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual width of a pixel"
},
"scanType": {
"description": "(Optional) - The type of scan E-Scan or I-Scan",
"enum": [
"EScan",
"IScan"
],
"type": "string"
},
"verticalFieldSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the actual vertical length scanned on the sample defined separately as distanceDetails"
}
},
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time period. IRI:https://purls.helmholtz-metadaten.de/EMG/00000024",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "us",
"description": "(Optional) - the unit of the value to be selected from a controlled list (ps, ns, us, ms, s default value - us) of datatype string",
"enum": [
"ps",
"ns",
"us",
"ms",
"s"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"user": {
"description": "Contact information of the user responsible for the measurement.",
"properties": {
"ORCID": {
"description": "(Optional) - Open Researcher and Contributor ID expressed as a URI",
"pattern": "^https://orcid\\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[X0-9]{1}$",
"type": "string"
},
"affiliation": {
"description": "(Optional) - Details of the institution to which the user is affiliated",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"description": "(Optional) -Identifier of the institution to which the user is affiliated",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be chosen from a controlled list of values (*ROR *GRID *ISNI *URL *DOI *Handle)",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"email": {
"description": "(Optional) - Email of the user",
"format": "email",
"type": "string"
},
"familyName": {
"description": "(Optional) - Family name of the user",
"type": "string"
},
"givenName": {
"description": "(Optional) - Given name of the user",
"type": "string"
},
"role": {
"description": "(Optional) - Role of the user to be selected from: *Data Curator *Instrument Scientist *Team Leader *Team Member",
"enum": [
"Data Curator",
"Instrument Scientist",
"Team Leader",
"Team Member"
],
"type": "string"
},
"userName": {
"description": "(Required) - Full name of the user recommended in the format (Family Name, Given Name)",
"type": "string"
}
},
"required": [
"userName"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "kV",
"description": "(Optional) - the unit of the value to be selected from a controlled list (uV, mV, V, kV, MV, GV default value - V) of datatype string",
"enum": [
"uV",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The voltage expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes a set of images acquired during the course of a SEM/FIB Tomography experiment. The images in each dataset is taken using a detector (SE, BSE, EDS, EBSD) using a specific configuration. This Schema contains only the parameters which are specific to the entire dataset. The parameters which are particular to each image is located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json. The units are by default to be considred as the SI units unless otherwise specified",
"properties": {
"columns": {
"description": "(Optional) - Number of column in the tiled image grab setting",
"type": "number"
},
"datasetType": {
"default": "SEM",
"description": "(Required) - To be selected from the enumerated list depending on the detector and the angle at which the sample is measured: * SEM Image * SEM Image 2 * EDS * EBSD * BSE * ISE * ISI * SI * InLens * SESI",
"enum": [
"SEM Image",
"SEM Image 2",
"SEM Image 3",
"SEM Image 4",
"SEM Image 5",
"EDS",
"EBSD",
"BSE",
"ISE Image",
"ISI Image",
"SI Image",
"InLens",
"SESI"
],
"type": "string"
},
"definition": {
"description": "(Optional)- Name of the schema to which this entry conforms. In this case, acquisition_dataset is to be written",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Identifier of the dataset. It could be the PID of location where the entire dataset is stored"
},
"images": {
"$ref": "#/$defs/imagesDetails",
"description": "(Required) - Details describing the images in the dataset, including location and image specific parameters"
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings"
},
"numberOfItems": {
"description": "(Required) - Number of Items (images, files). Depends on the number of slices",
"type": "number"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required)- Details concerning the program (or software) used for aquisition"
},
"rows": {
"description": "(Optional) - Number of rows in the tiled image grab setting",
"type": "number"
},
"tileColumn": {
"description": "(Optional) - The selected column in the tiled image grab setting",
"type": "number"
},
"tileRow": {
"description": "(Optional) - The selected row in the tiled image grab setting",
"type": "number"
},
"user": {
"$ref": "#/$defs/user",
"description": "(Optional)- The contact information of the user responsible for the measurement"
}
},
"required": [
"definition",
"program",
"instrument",
"datasetType",
"images",
"displayedEnergyLevel",
"tileRow",
"tileColumn",
"columns",
"rows",
"name",
"numberOfItems"
],
"title": "acquisition_dataset",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | dfe04f53ecc8c55eea9ee29f183bacde7cdf3653 | 2023-11-24T16:24:09 | SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "degree",
"description": "(Unit) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "pA",
"description": "(Optional) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string",
"enum": [
"pA",
"nA",
"uA",
"mA",
"A"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Optional) - Further notes about the value of datatype string",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"detectorDetails": {
"additionalProperties": false,
"description": "(Required) - describes the settings related to the detector with which the image set is acquired",
"properties": {
"detectorSettings": {
"$ref": "#/$defs/detectorSettings",
"description": "(Required) - Settings of the specific detector used. E.g., the Everhart Thornley detector (ETD), is a secondary electron and back-scattered electron detector used in scanning electron microscopes, whihc has then particular settings"
},
"detectorType": {
"description": "(Required) - Type of the detector used",
"enum": [
"ETD",
"CDEM",
"CBS",
"ECD",
"External",
"GBSD",
"GSED",
"ICE",
"LFD",
"LVD",
"LVSED",
"None",
"STEM3",
"STEM3_GMode",
"STEM4",
"T1",
"T2",
"T3",
"TLD"
],
"type": "string"
},
"name": {
"description": "(Optional) - Name of the detector used",
"type": "string"
}
},
"required": [
"detectorType"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "describes the parameters of a detector such as the Everhart Thornley detector (ETD), which is a secondary electron and back-scattered electron detector used in scanning electron microscopes",
"properties": {
"brightness": {
"description": "(Optional) - A number indicating the brightness",
"type": "number"
},
"brightnessdB": {
"description": "(Optional) - Describes the brightness in dB",
"type": "number"
},
"contrast": {
"description": "(Optional) - A number indicating the contrast",
"type": "number"
},
"contrastdB": {
"description": "(Optional) - Describes the contrast in dB",
"type": "number"
},
"enhancedContrast": {
"description": "(Optional) - Describes the enhancement in contrast",
"type": "number"
},
"frontEndVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Bias voltage applied to the front end of the detector "
},
"grid": {
"description": "(Optional) - A number indicating the number of grid elements",
"type": "number"
},
"gridVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage applied to the grid "
},
"minimumDwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Minimum possible dwell time for the detector. IRI: https://purls.helmholtz-metadaten.de/EMG/00000006 "
},
"mix": {
"description": "(Optional) - Signals from different detectors can be overlaid (mixed) and this should, in theory, be the percentage of this detectors contribution to the end result.",
"type": "number"
},
"setting": {
"description": "(Optional) - In case of ETD, this is the bias voltage applied to the detector grid. Note that this block looks different for different detectors. ",
"type": "string"
},
"signal": {
"description": "(Optional) - The signal used for detection",
"enum": [
"SE",
"BSE",
"SI"
],
"type": "string"
}
},
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"eBeamDetails": {
"additionalProperties": false,
"description": "(Required) - Describes the configuration of the electron beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000007",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The potential difference between anode and cathode. The acceleration voltage adds kinetic energy to the particles of the beam. IRI: https://purls.helmholtz-metadaten.de/EMG/00000001 It is defined separately as voltageDetails, (includes the voltage value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - uV, mv, V, kV, MV)"
},
"apertureSetting": {
"additionalProperties": false,
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size (diameter) of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails."
}
},
"type": "object"
},
"beamCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Electrical current which flows along the beam path. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003 It is defined separately as currentDetails (includes the current value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)."
},
"dynamicFocusIsOn": {
"description": "(Optional) - To bet set true if dynamic focus is on. IRI:https://purls.helmholtz-metadaten.de/emg/00000039",
"type": "boolean"
},
"dynamicWDIsOn": {
"description": "(Optional) - To bet set true if dynamic working distance is on. IRI: https://purls.helmholtz-metadaten.de/EMG/00000026",
"type": "boolean"
},
"horizontalFieldWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual horizontal length scanned on the sample defined separately as distanceDetails."
},
"imageMode": {
"description": "(Optional) - The type of image mode used. Could be a text or number depending on the instrument.",
"type": "string"
},
"lensMode": {
"description": "(Optional) - The type of image mode used",
"enum": [
"Field-Free",
"Immersion",
"EDS"
],
"type": "string"
},
"magnificationCorrection": {
"description": "(Optional) - To bet set true if magnification correction is on",
"type": "boolean"
},
"preTilt ": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Sometimes, pre-tilted holders are used and the pretilt angle must be given in the acquisition software because actual tilt = stage tilt plus pretilt."
},
"scanRotation": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Angle by which beam scanning direction is rotated"
},
"tiltCorrectionAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - If the sample is tilted, the image is compressed in the vertical direction, i.e. the pixels are not isotropic anymore. Tilt correction adapts the line spacing of the scanning to compensate for this. IRI:https://purls.helmholtz-metadaten.de/emg/00000037"
},
"tiltCorrectionIsOn": {
"description": "(Optional) - To bet set true if tilt correction is on. IRI:https://purls.helmholtz-metadaten.de/emg/00000037",
"type": "boolean"
},
"verticalFieldWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual vertical length scanned on the sample defined separately as distanceDetails."
}
},
"required": [
"accelerationVoltage",
"verticalFieldWidth",
"horizontalFieldWidth",
"apertureSetting",
"scanRotation"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "J",
"description": "(Optional) - the unit of the value to be selected from a controlled list (nJ, mJ, J, kJ, eV, meV default value - J) of datatype string",
"enum": [
"nJ",
"mJ",
"J",
"kJ",
"eV",
"meV"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"hotStageMEMSDetails": {
"additionalProperties": false,
"description": "describes the parameters related if a hot stage MEMS is used",
"properties": {
"actualTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Describes the actual Temperature measured in the hot stage MEMS"
},
"heatingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Describes the heating current used in the hot stage MEMS"
},
"heatingPower": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Describes the heating power used in the hot stage MEMS"
},
"heatingVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Describes the heating voltage used in the hot stage MEMS"
},
"sampleBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Describes the bias voltage applied to the sample in the hot stage MEMS"
},
"sampleResistance": {
"$ref": "#/$defs/resistanceDetails",
"description": "(Optional) - Describes the target Temperature used in the hot stage MEMS"
},
"targetTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Describes the target Temperature set in the hot stage MEMS"
}
},
"type": "object"
},
"iBeamDetails": {
"additionalProperties": false,
"description": "(Required) - Describes the configuration of the ion beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000016",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The potential difference between anode and cathode. The acceleration voltage adds kinetic energy to the particles of the beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000001 It is defined separately as voltageDetails, (includes the voltage value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - uV, mv, V, kV, MV)"
},
"millingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Electrical current used in SEM-FIB Tomography to mill/cut the sample. In this case this is the same as the beam current of the ion beam. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003 It is defined separately as currentDetails (includes the current value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)."
}
},
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"imageDetails": {
"additionalProperties": false,
"description": "(Required) - describes the settings related to imaging",
"properties": {
"digitalBrightness": {
"description": "(Required) - A number indicating the setting for digital brightness (a basic post-processing method)",
"type": "number"
},
"digitalContrast": {
"description": "(Required) - A number indicating the setting for digital contrast (a basic post-processing method)",
"type": "number"
},
"digitalGamma": {
"description": "(Required) - A number indicating the setting for digital Gamma (a basic post-processing method)",
"type": "number"
},
"driftcorrected": {
"description": "(Required) - To bet set true if drift correction is on",
"type": "boolean"
},
"numberOfPixels": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The number of x, y pixels of the image (Resolution), defined separately as pixelNumberType with separate entries for integer values of xPixels and yPixels"
},
"postprocessing": {
"description": "(Optional) - Describes the post-processing performed on the image",
"type": "string"
},
"transformation": {
"description": "(Optional) - Describes the transformations performed on the image",
"type": "string"
},
"zoomfactor": {
"description": "(Required) - A number indicating the zoom factor",
"type": "number"
}
},
"required": [
"digitalContrast",
"digitalBrightness",
"digitalGamma",
"numberOfPixels",
"driftcorrected",
"zoomfactor"
],
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"beamType": {
"description": "(Required) - The selected beam",
"enum": [
"EBeam",
"IBeam"
],
"type": "string"
},
"detector": {
"oneOf": [
{
"$ref": "#/$defs/detectorDetails",
"description": "(Required) - Details about the detector(s) used for acquisition.",
"type": "object"
},
{
"description": "(Required) - Details about the detector(s) used for acquisition.",
"items": {
"$ref": "#/$defs/detectorDetails"
},
"minItems": 1,
"type": "array"
}
]
},
"eBeam": {
"$ref": "#/$defs/eBeamDetails",
"description": "(Required) - Details about the electron beam"
},
"hotStageMEMS": {
"$ref": "#/$defs/hotStageMEMSDetails",
"description": "(Optional) - Pressure maintained inside the chamber (in which the sample is housed) during the measurement"
},
"iBeam": {
"$ref": "#/$defs/iBeamDetails",
"description": "(Required) - Details about the ion beam"
},
"imaging": {
"$ref": "#/$defs/imageDetails",
"description": "(Optional) - Details about the imaging settings"
},
"numberOfDetectors": {
"description": "Number of detectors used for the acquisition",
"type": "number"
},
"scan": {
"$ref": "#/$defs/scanDetails",
"description": "(Required) - Details about the scan settings"
},
"spot": {
"description": "(Optional) - Qualitative index for beam current. Varies with current setting, i.e. 1.6 nA is spot = 1, 3.2 nA is spot = 2, 0.1 nA = spot =-3, so it can also be negative. May vary between different microscope models.",
"type": "number"
}
},
"required": [
"eBeam",
"scan",
"imaging",
"detector"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes the resolution of the image split into number of pixels in x and y directions.",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "describes a power",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "W",
"description": "(Optional) - the unit of the value to be selected from a controlled list (\u00b5W, mW, W, kW, MW default value - W) of datatype string",
"enum": [
"\u00b5W",
"mW",
"W",
"kW",
"MW"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The power expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "Pa",
"description": "(Optional) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"resistanceDetails": {
"additionalProperties": false,
"description": "describes a resistance",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "ohm",
"description": "(Optional) - the unit of the value to be selected from a controlled list (abohm, ohm, k ohm, M ohm default value - ohm) of datatype string; default unit is ohm",
"enum": [
"abohm",
"ohm",
"k ohm",
"M ohm"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The resistance expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"scanDetails": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scan settings.",
"properties": {
"average": {
"description": "(Optional) - Number of images averaged at each slice",
"type": "number"
},
"dwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time period during which the beam remains on one position/stationary. IRI: https://purls.helmholtz-metadaten.de/EMG/00000006 "
},
"eScan": {
"additionalProperties": false,
"description": "gives settings pertaining to electron beam scan",
"properties": {
"lineAveraging": {
"description": "(Optional) - Number of lines averaged",
"type": "number"
},
"lineIntegration": {
"description": "(Optional) - Number of lines integrated",
"type": "number"
},
"lineTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) -Time period during which a line is fully scanned."
},
"mainsLock": {
"description": "(Optional) - To bet set true if mains lock is on",
"type": "boolean"
},
"scanInterlacing": {
"description": "(Optional) - Number of scans interlaced. This setting splits an imaging area into blocks defined by the number of lines (from 2 to 8). In the first instance, the first line of each block is scanned, then the second one, etc. This imaging method significantly reduces charging.",
"type": "number"
}
},
"type": "object"
},
"frameTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) -Time period during which a frame is fully scanned. IRI: https://purls.helmholtz-metadaten.de/EMG/00000014 "
},
"horizontalFieldSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the actual horizontal length scanned on the sample defined separately as distanceDetails"
},
"integrate": {
"description": "(Optional) - Number of images integrated at each slice",
"type": "number"
},
"internalScan": {
"description": "(Optional) - To bet set true if internal scan is on",
"type": "boolean"
},
"pixelHeight": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual width of a pixel"
},
"pixelWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual width of a pixel"
},
"scanType": {
"description": "(Optional) - The type of scan E-Scan or I-Scan",
"enum": [
"EScan",
"IScan"
],
"type": "string"
},
"verticalFieldSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the actual vertical length scanned on the sample defined separately as distanceDetails"
}
},
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time period. IRI:https://purls.helmholtz-metadaten.de/EMG/00000024",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "us",
"description": "(Optional) - the unit of the value to be selected from a controlled list (ps, ns, us, ms, s default value - us) of datatype string",
"enum": [
"ps",
"ns",
"us",
"ms",
"s"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"user": {
"description": "Contact information of the user responsible for the measurement.",
"properties": {
"ORCID": {
"description": "(Optional) - Open Researcher and Contributor ID expressed as a URI",
"pattern": "^https://orcid\\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[X0-9]{1}$",
"type": "string"
},
"affiliation": {
"description": "(Optional) - Details of the institution to which the user is affiliated",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"description": "(Optional) -Identifier of the institution to which the user is affiliated",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be chosen from a controlled list of values (*ROR *GRID *ISNI *URL *DOI *Handle)",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"email": {
"description": "(Optional) - Email of the user",
"format": "email",
"type": "string"
},
"familyName": {
"description": "(Optional) - Family name of the user",
"type": "string"
},
"givenName": {
"description": "(Optional) - Given name of the user",
"type": "string"
},
"role": {
"description": "(Optional) - Role of the user to be selected from: *Data Curator *Instrument Scientist *Team Leader *Team Member",
"enum": [
"Data Curator",
"Instrument Scientist",
"Team Leader",
"Team Member"
],
"type": "string"
},
"userName": {
"description": "(Required) - Full name of the user recommended in the format (Family Name, Given Name)",
"type": "string"
}
},
"required": [
"userName"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "kV",
"description": "(Optional) - the unit of the value to be selected from a controlled list (uV, mV, V, kV, MV, GV default value - V) of datatype string",
"enum": [
"uV",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The voltage expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes a set of images acquired during the course of a SEM/FIB Tomography experiment. The images in each dataset is taken using a detector (SE, BSE, EDS, EBSD) using a specific configuration. This Schema contains only the parameters which are specific to the entire dataset. The parameters which are particular to each image is located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json. The units are by default to be considred as the SI units unless otherwise specified",
"properties": {
"columns": {
"description": "(Optional) - Number of column in the tiled image grab setting",
"type": "number"
},
"datasetType": {
"default": "SEM",
"description": "(Optional) - To be selected from the enumerated list depending on the detector and the angle at which the sample is measured: * SEM Image * SEM Image 2 * EDS * EBSD * BSE * ISE * ISI * SI * InLens * SESI",
"enum": [
"SEM Image",
"SEM Image 2",
"SEM Image 3",
"SEM Image 4",
"SEM Image 5",
"EDS",
"EBSD",
"BSE",
"ISE Image",
"ISI Image",
"SI Image",
"InLens",
"SESI"
],
"type": "string"
},
"definition": {
"description": "(Optional)- Name of the schema to which this entry conforms. In this case, acquisition_dataset is to be written",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Identifier of the dataset. It could be the PID of location where the entire dataset is stored"
},
"images": {
"desription": "(Required) - Array containing the images and their specific parameters. No. of images in the array is described by the numberOfItems parameter at the entry level of this schema",
"items": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json"
},
"type": "array"
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings"
},
"numberOfItems": {
"description": "(Required) - Number of Items (images, files). Depends on the number of slices",
"type": "number"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required)- Details concerning the program (or software) used for aquisition"
},
"rows": {
"description": "(Optional) - Number of rows in the tiled image grab setting",
"type": "number"
},
"tileColumn": {
"description": "(Optional) - The selected column in the tiled image grab setting",
"type": "number"
},
"tileRow": {
"description": "(Optional) - The selected row in the tiled image grab setting",
"type": "number"
},
"user": {
"$ref": "#/$defs/user",
"description": "(Optional)- The contact information of the user responsible for the measurement"
}
},
"required": [
"program",
"instrument",
"datasetType",
"images",
"numberOfItems"
],
"title": "acquisition_dataset",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 9598907d713cd6ea0837ffbb7046d3700b6e0f8d | 2023-11-24T17:13:52 | SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "degree",
"description": "(Optional) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (pA, nA, \u00b5A, mA, A)",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the current",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "Pa",
"description": "(Optional) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"stage": {
"additionalProperties": false,
"description": "Describes the stage.",
"properties": {
"activeStage": {
"description": "(Required)- Describes the stage in use",
"type": "string"
},
"specTilt": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional)- Pretilt of the sample, usually due to pretilted holder."
},
"stageM": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional)- M coordinate of the position of the stage (additional translation axis available in Zeiss instruments)"
},
"stageR": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Angle by which the stage is rotated"
},
"stageTa": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Tilt angle alpha of the stage"
},
"stageTb": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Tilt angle beta of the stage"
},
"stageX": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- X coordinate of the position of the stage"
},
"stageY": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Y coordinate of the position of the stage"
},
"stageZ": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Z coordinate of the position of the stage"
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. IRI: https://purls.helmholtz-metadaten.de/EMG/00000026"
}
},
"required": [
"workingDistance",
"stageX",
"stageY",
"stageZ",
"stageR",
"stageTa",
"stageTb",
"activeStage"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"vacuum": {
"additionalProperties": false,
"description": "Describes the vacuum maintained in the system.",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- The pressure maintained in the electron chamber"
},
"gas": {
"description": "(Required)- The gas used in the electron chamber",
"type": "string"
},
"humidity": {
"description": "(Required)- Describes the humidity in the chamber during the measurement",
"type": "string"
},
"userMode": {
"description": "(Required)- The type of vacuum slected by the user",
"enum": [
"High vacuum",
"Medium vacuum",
"Low vacuum"
],
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes an individual image acquired during the course of a SEM/FIB Tomography experiment. Each image is taken using a detector (SE, BSE, EDS, EBSD) at each slice cut using FIB. This Schema contains only the parameters which are specific to the individual image. The parameters which are common to the entire set are described by another schema which describes the dataset as a whole and is located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json.",
"properties": {
"creationTime": {
"description": "(Required)- Time of creation of the image",
"pattern": "(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z)",
"type": "string"
},
"definition": {
"description": "(Optional)- Name of the schema to which this entry conforms. In this case, acquisition_image should be written",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Identifier of the image produced by the machine"
},
"fileLink": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Link to the location of the image"
},
"fileName": {
"description": "(Optional)- File name of the image",
"type": "string"
},
"specimenCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional)- Current measured on the specimen during acquisition of the image"
},
"stage": {
"$ref": "#/$defs/stage",
"description": "(Required)- Details concerning stage settings used for aquisition"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional)- Temperature of the sample during acquisition"
},
"vacuum": {
"$ref": "#/$defs/vacuum",
"description": "(Required)- Details concerning the vacuum during aquisition"
}
},
"required": [
"creationTime",
"stage",
"vacuum"
],
"title": "acquisition_image",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | acf9e7d1e9c54a7847ee6899d50b74ea7691ec24 | 2023-12-06T17:21:57 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"FIBDetails": {
"additionalProperties": false,
"description": "Details about the focussed ion beam (FIB) extension if present.",
"properties": {
"FIBColumn": {
"description": "(Optional) - The name of the I-beam column used",
"type": "string"
},
"FIBExtractor": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The extractor voltage used for the I-Beam"
},
"FIBProbe": {
"description": "(Required) - The settings used for the probe, extractor voltage:milling current. eg. 30kV:50pA",
"type": "string"
},
"FIBSpotSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - spot size of the i-beam at the focus when the sample is in focus (also the spot size on the sample) defined separately as distanceDetails (Allowed units: nm, um, mm, cm, m)"
},
"angleToEBeam": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - angle between e-beam and i-beam defined separately as angleDetails (Allowed units: degree, radian)"
},
"gasInjectionSystem": {
"$ref": "#/$defs/GISDetails",
"description": "(Optional) - Details about the gas injection system (GIS) defined separately as GISDetails"
},
"iBeamSource": {
"$ref": "#/$defs/sourceDetails",
"description": "(Required) - describes the details of the FIB source, defined separately as sourceDetails in which it is important to note the accelerating voltage and beam current of the i-beam"
},
"iBeamWorkingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Working distance of the ion beam (i-beam) defined separately as distanceDetails - this value needs to be entered if the i-beam focus has to be set independently from the e-beam focus (Allowed units: nm, um, mm, cm, m)"
}
},
"required": [
"iBeamSource",
"FIBExtractor",
"FIBProbe"
],
"type": "object"
},
"GISDetails": {
"additionalProperties": false,
"description": "gives the details of the gas injection system (GIS).",
"properties": {
"GISName": {
"description": "(Optional) - Name of the GIS system of datatype string",
"type": "string"
},
"beamDepositionType": {
"description": "(Optional) - type of beam deposition of datatype string to choose between e-beam deposition and i-beam deposition",
"enum": [
"E-beam Deposition",
"I-beam Deposition"
],
"type": "string"
},
"depositionCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current used for performing beam deposition defined separately as currentDetails (Allowed units pA,nA,uA,mA,A)"
},
"depositionSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the deposition defined separately as distanceDetails (Allowed units nm,um,mm,cm,m)"
},
"depositionTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - total time for deposition defined separately as timeDetails (Allowed units ps,ns,us,ms,s)"
}
},
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "degree",
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"default": "\u00b5m",
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "pA",
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string.",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"detectorDetails": {
"additionalProperties": false,
"description": "gives the settings of a detector.",
"properties": {
"componentGeometry": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - xyz coordinates describing the position of the detector defined separately as coordinateSet"
},
"detectorBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - bias voltage applied to the detector defined separately as voltageDetails. Allowed units nV, uV, mV, V, kV"
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector"
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - describes the details of the detector (manufacturerName, modelName and detectorID) as part of manufacturerDetails"
},
"detectorName": {
"description": "(Required) -Name of the detector of datatype string",
"type": "string"
},
"detectorType": {
"default": "Secondary Electron",
"description": "(Optional) - The type of detector (e.g., surface electron detection, secondary electron, back-scattered electron) of datatype string",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (CCYY-MM-DDThh:mm:ss.sss) of the date-time format",
"pattern": "(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z)",
"type": "string"
}
},
"required": [
"detectorName"
],
"type": "object"
},
"detectorSetDetails": {
"additionalProperties": false,
"description": "gives information about signal mixing between two detectors and provides the information about the detector(s).",
"properties": {
"detector1": {
"$ref": "#/$defs/detectorDetails",
"description": "(Required) - gives the settings of one detector defined separately as detectorDetails; entering the details of at least one detector is compulsory"
},
"detector2": {
"$ref": "#/$defs/detectorDetails",
"description": "(Optional) - gives the settings of a second detector defined separately as detectorDetails"
},
"signalMixingDescription": {
"description": "(Optional) - Describes the purpose and technique of signal mixing of datatype string",
"type": "string"
},
"signalMixingDone": {
"default": false,
"description": "(Optional) - whether the detector signals are mixed, true or false, of datatype boolean",
"type": "boolean"
}
},
"required": [
"detector1"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"eBeamDecelerationDetails": {
"additionalProperties": false,
"description": "Details about deceleration of the e- beam.",
"properties": {
"landingEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Landing energy of the e-beam defined separately as energyDetails (allowed units - meV, eV, keV, nJ, mJ, J, kJ, MJ)"
},
"stageBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Bias voltage applied to the stage defined separately biasDetails (allowed units - nV, uV, mV, V, kV, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "keV",
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ; default value - keV) of datatype string",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"entry": {
"additionalProperties": false,
"description": "Required) - The entry level is the root element of the schema. It contains all the metadata describing a CT measurement.",
"properties": {
"definition": {
"description": "(Optional) - Name of the schema to which this entry conforms. In this case, lab_CT should be written",
"type": "string"
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "entryID (Optional) - Identifier of the measurement usually provided by the project or the laboratory"
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings"
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition"
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format"
},
"sample": {
"$ref": "#/$defs/sample",
"description": "(Required)- Details concerning the sample"
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement",
"type": "string"
},
"user": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/user_description.json",
"description": "(Required)- The contact information of the user responsible for the measurement"
}
},
"required": [
"title",
"startTime",
"endTime",
"program",
"user",
"instrument"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/unit time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min) default value - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"imagingDetails": {
"additionalProperties": false,
"description": "describes the imaging settings of the instrument during the measurement.",
"properties": {
"apertureSetting": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Optional) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). The element apertureSetting is defined separately as apertureSettingType which gives the option to choose between current or size. If the size can be set directly, then it is defined with the complex type distanceDetails, else if the aperture setting is controlled with the beam current defined separately as currentDetails"
},
"collectionMethod": {
"default": "normal scan",
"description": "(Optional) - the method of collection of the image, for e.g., normal scan, average of multiple images, integration of multiple images, default value - normal scan, of datatype string",
"type": "string"
},
"cycleTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - the time taken by the beam to scan a frame, defined separately as timeDetails. It is the time needed to scan a line times the number of lines in a frame."
},
"dwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - the dwell time of the beam per pixel, defined separately as timeDetails"
},
"dynamicFocus": {
"description": "(Optional) - To be set to true if dynamic focus is turned on, else false",
"type": "boolean"
},
"noiseReduction": {
"description": "(Optional) - The type of noise reduction used as an enumerated list of six parameters: Pixel Avg, Line Avg, Frame Avg, Pixel Int, Line Int, Frame Int.",
"enum": [
"Pixel Avg",
"Line Avg",
"Frame Avg",
"Pixel Int",
"Line Int",
"Frame Int"
],
"type": "string"
},
"numberOfPixels": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The number of x, y pixels of the image, defined separately as pixelNumberType with separate entries for integer values of xPixels and yPixels"
},
"pixelSize": {
"$ref": "#/$defs/pixelsize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel, normally expressed in nm/pixel, defined separately as pixelSize3D for the mapping along x,y and z directions, with each pixel having a pixelSize, optional uncertainty, optional qualifier and optional notes. The y-pixel-size is to be given only if it is different from the x-pixel-size, and z-pixel-size can be ignored if it is greater than voxel size"
},
"voxel": {
"$ref": "#/$defs/voxelDetails",
"description": "(Optional) - Size of the voxel in case 3D imaging is done for Energy-dispersive X-ray Spectroscopy or Electron-backscatter Diffraction, defined separately as voxelDetails"
}
},
"required": [
"numberOfPixels",
"pixelSize"
],
"type": "object"
},
"institutionDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the institution to which the user is affiliated.",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier pertaining to the institution (e.g. ROR)"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray Target in an SEM based CT set-up",
"properties": {},
"required": [],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray enrgy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source"
],
"type": "object"
},
"lifetimeDetails": {
"additionalProperties": false,
"description": "describes a lifetime.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5Ah",
"description": "(Required) - the unit of the value (default value - \u00b5Ah) of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The lifetime of the source expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"description": "(Optional) - The rate at which temperature is increased in K/min.",
"type": "number"
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"pH": {
"additionalProperties": false,
"description": "(Optional) - Details about the pH maintained in the in situ cell.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in steile conditions.",
"type": "boolean"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"chamberName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes the resolution of the image split into number of pixels in x and y directions.",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "nm/pixel",
"description": "(Required) - the unit of the value (default value - nm/pixel) of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"pixelsize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm/pixel, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min, default value - max) of datatype string.",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"default": "W",
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW, default value - W) of datatype string.",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "Pa",
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"sample": {
"additionalProperties": false,
"description": "(Required) - Details concerning the sample.",
"properties": {
"sampleForm": {
"description": "(Optional) - Description of the sample form (e.g., bulk, nanostructured, powder, pellet)",
"type": "string"
},
"sampleHolder": {
"description": "(Optional) - Type of sample holder used",
"type": "string"
},
"sampleID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the sample"
},
"sampleName": {
"description": "(Optional) - Name of the sample",
"type": "string"
},
"samplePreparation": {
"$ref": "#/$defs/samplePrepType",
"description": "(Optional) - Details pertaining to the sample prepapration like date, ID, etc"
},
"sampleSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the sample"
},
"sampleWeight": {
"$ref": "#/$defs/weightDetails",
"description": "(Optional) - Weight of the sample"
},
"storageConditions": {
"default": "Ambient, dry environment",
"description": "(Optional) - Environment conditions in which the sample has to be stored before and after the measurement (e.g., nitrogen atmosphere, hermetically sealed, controlled temperature and pressure).",
"type": "string"
}
},
"type": "object"
},
"samplePrepType": {
"additionalProperties": false,
"description": "(Optional) - Describes the sample preparation process.",
"properties": {
"preparationDate": {
"description": "(Optional) - Date of the sample preparation.",
"format": "date",
"type": "string"
},
"preparationDescription": {
"description": "(Optional) - Short description of the sample preparation.",
"type": "string"
},
"preparationID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the sample preparation."
}
},
"type": "object"
},
"sourceDetails": {
"additionalProperties": false,
"description": "gives details about the electron beam source.",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - the voltage with which the e-beam is accelerated, defined separately as voltageDetails, (includes the voltage value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - \u00b5V, mv, V, kV, MV)"
},
"beamCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the measured current of the e-beam, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
},
"gunPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Gives the pressure maintained in the FIB gun"
},
"gunVacuum": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Gives the pressure maintained in the electron gun"
},
"highCurrent": {
"description": "(Optional) - Is special control of the electron optics enabled to increase the specimen current? true or false",
"type": "boolean"
},
"sourceID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - identifier for the e-beam source"
},
"sourceLifetime": {
"$ref": "#/$defs/lifetimeDetails",
"description": "(Optional) - lifetime of the source (default value - uAh) of datatype string"
},
"sourceName": {
"description": "(Optional) - name of the e-beam source of datatype string",
"type": "string"
}
},
"required": [
"accelerationVoltage"
],
"type": "object"
},
"stageDetails": {
"additionalProperties": false,
"description": "describes the stage settings during a measurement.",
"properties": {
"coordinateReference": {
"default": "origin at centre of sample",
"description": "(Optional) - description of the reference used for defining the coordinates (for eg. - origin at centre of sample, distances from two edges, etc.)",
"type": "string"
},
"coordinates": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - the xyz coordinates of a point expressed separately as coordinateSet which allows entering each of the xyz coordinates along with their optional uncertainties. If correllation images (two reference spots) are available, the coordinates enable correlative microscopy and they need to be entered"
},
"eBeamWorkingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the distance at which the beam is focussed (when the sample is in focus, this will be the distance between the bottom end of the pole-piece of the objective lens and the sample) defined separately as distanceDetails, with the distance value, optional uncertainty, optional notes, optional qualifier and choice of units between nm, um, mm, cm and m"
},
"isCorrelationImage": {
"description": "(Optional) - Whether the image is used for correlating in xyz coordinates with another image? Check if true. If true the coordinates have to be entered for the sake of correlative characterization of datatype boolean",
"type": "boolean"
},
"preTilt": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - predefined angle of a tilted sample holder which is tilted by design defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"stageAlignmentDone": {
"description": "(Optional) - was stage alignment done? (check if true)",
"type": "boolean"
},
"stageTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the stage is actually tilted (Stage at T) defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"tiltCorrectionAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - angle used to correct the tilt of the sample defined separately as angleDetails with the angle value, optional uncertainty, optional notes, optional qualifier and choice of units between degree and radian"
},
"tiltCorrectionType": {
"default": "none",
"description": "(Optional) - the tilt correction type applied to the image to compensate for the tilting, for e.g., sample surface, cross-section, none or manual, default value- none of datatype string",
"type": "string"
}
},
"required": [
"eBeamWorkingDistance",
"stageTiltAngle"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5s",
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s default value - \u00b5s) of datatype string",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "kV",
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV default value - V) of datatype string.",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"voxelDetails": {
"additionalProperties": false,
"description": "describes the size of a voxel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "mm",
"description": "(Required) - the unit of the value of datatype string",
"type": "string"
},
"value": {
"description": "(Required) - The voxel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"weightDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a weight.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "\u00b5g",
"description": "(Required) - Unit of the value to be selected from a controlled list (ng, \u00b5g, mg, g, kg, default value - ug)",
"enum": [
"ng",
"\u00b5g",
"mg",
"g",
"kg"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the weight",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided.",
"properties": {
"entry": {
"$ref": "#/$defs/entry"
}
},
"required": [
"entry"
],
"title": "lab_CT",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | a09c6f31e2763fcff68fac51aa0cb333ed1b1d93 | 2023-11-24T15:14:55 | SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "degree",
"description": "(Unit) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "pA",
"description": "(Optional) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string",
"enum": [
"pA",
"nA",
"uA",
"mA",
"A"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Optional) - Further notes about the value of datatype string",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"detectorDetails": {
"additionalProperties": false,
"description": "(Required) - describes the settings related to the detector with which the image set is acquired",
"properties": {
"detectorSettings": {
"$ref": "#/$defs/detectorSettings",
"description": "(Required) - Settings of the specific detector used. E.g., the Everhart Thornley detector (ETD), is a secondary electron and back-scattered electron detector used in scanning electron microscopes, whihc has then particular settings"
},
"detectorType": {
"description": "(Required) - Type of the detector used",
"enum": [
"ETD",
"CDEM",
"CBS",
"ECD",
"External",
"GBSD",
"GSED",
"ICE",
"LFD",
"LVD",
"LVSED",
"None",
"STEM3",
"STEM3_GMode",
"STEM4",
"T1",
"T2",
"T3",
"TLD"
],
"type": "string"
},
"name": {
"description": "(Optional) - Name of the detector used",
"type": "string"
}
},
"required": [
"detectorType"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "describes the parameters of a detector such as the Everhart Thornley detector (ETD), which is a secondary electron and back-scattered electron detector used in scanning electron microscopes",
"properties": {
"brightness": {
"description": "(Optional) - A number indicating the brightness",
"type": "number"
},
"brightnessdB": {
"description": "(Optional) - Describes the brightness in dB",
"type": "number"
},
"contrast": {
"description": "(Optional) - A number indicating the contrast",
"type": "number"
},
"contrastdB": {
"description": "(Optional) - Describes the contrast in dB",
"type": "number"
},
"enhancedContrast": {
"description": "(Optional) - Describes the enhancement in contrast",
"type": "number"
},
"frontEndVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Bias voltage applied to the front end of the detector "
},
"grid": {
"description": "(Optional) - A number indicating the number of grid elements",
"type": "number"
},
"gridVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage applied to the grid "
},
"minimumDwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Minimum possible dwell time for the detector. IRI: https://purls.helmholtz-metadaten.de/EMG/00000006 "
},
"mix": {
"description": "(Optional) - Signals from different detectors can be overlaid (mixed) and this should, in theory, be the percentage of this detectors contribution to the end result.",
"type": "number"
},
"setting": {
"description": "(Optional) - In case of ETD, this is the bias voltage applied to the detector grid. Note that this block looks different for different detectors. ",
"type": "string"
},
"signal": {
"description": "(Optional) - The signal used for detection",
"enum": [
"SE",
"BSE",
"SI"
],
"type": "string"
}
},
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"eBeamDetails": {
"additionalProperties": false,
"description": "(Required) - Describes the configuration of the electron beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000007",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The potential difference between anode and cathode. The acceleration voltage adds kinetic energy to the particles of the beam. IRI: https://purls.helmholtz-metadaten.de/EMG/00000001 It is defined separately as voltageDetails, (includes the voltage value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - uV, mv, V, kV, MV)"
},
"apertureSetting": {
"additionalProperties": false,
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size (diameter) of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails."
}
},
"type": "object"
},
"beamCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Electrical current which flows along the beam path. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003 It is defined separately as currentDetails (includes the current value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)."
},
"dynamicFocusIsOn": {
"description": "(Optional) - To bet set true if dynamic focus is on. IRI:https://purls.helmholtz-metadaten.de/emg/00000039",
"type": "boolean"
},
"dynamicWDIsOn": {
"description": "(Required) - To bet set true if dynamic working distance is on. IRI: https://purls.helmholtz-metadaten.de/EMG/00000026",
"type": "boolean"
},
"horizontalFieldWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual horizontal length scanned on the sample defined separately as distanceDetails."
},
"imageMode": {
"description": "(Optional) - The type of image mode used. Could be a text or number depending on the instrument.",
"type": "string"
},
"lensMode": {
"description": "(Optional) - The type of image mode used",
"enum": [
"Field-Free",
"Immersion",
"EDS"
],
"type": "string"
},
"magnificationCorrection": {
"description": "(Optional) - To bet set true if magnification correction is on",
"type": "boolean"
},
"preTilt ": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Sometimes, pre-tilted holders are used and the pretilt angle must be given in the acquisition software because actual tilt = stage tilt plus pretilt."
},
"scanRotation": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Angle by which beam scanning direction is rotated"
},
"tiltCorrectionAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - If the sample is tilted, the image is compressed in the vertical direction, i.e. the pixels are not isotropic anymore. Tilt correction adapts the line spacing of the scanning to compensate for this. IRI:https://purls.helmholtz-metadaten.de/emg/00000037"
},
"tiltCorrectionIsOn": {
"description": "(Optional) - To bet set true if tilt correction is on. IRI:https://purls.helmholtz-metadaten.de/emg/00000037",
"type": "boolean"
},
"verticalFieldWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual vertical length scanned on the sample defined separately as distanceDetails."
}
},
"required": [
"accelerationVoltage",
"dynamicWDIsOn",
"verticalFieldWidth",
"horizontalFieldWidth",
"apertureSetting",
"scanRotation"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "J",
"description": "(Optional) - the unit of the value to be selected from a controlled list (nJ, mJ, J, kJ, eV, meV default value - J) of datatype string",
"enum": [
"nJ",
"mJ",
"J",
"kJ",
"eV",
"meV"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"hotStageMEMSDetails": {
"additionalProperties": false,
"description": "describes the parameters related if a hot stage MEMS is used",
"properties": {
"actualTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Describes the actual Temperature measured in the hot stage MEMS"
},
"heatingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Describes the heating current used in the hot stage MEMS"
},
"heatingPower": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Describes the heating power used in the hot stage MEMS"
},
"heatingVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Describes the heating voltage used in the hot stage MEMS"
},
"sampleBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Describes the bias voltage applied to the sample in the hot stage MEMS"
},
"sampleResistance": {
"$ref": "#/$defs/resistanceDetails",
"description": "(Optional) - Describes the target Temperature used in the hot stage MEMS"
},
"targetTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Describes the target Temperature set in the hot stage MEMS"
}
},
"type": "object"
},
"iBeamDetails": {
"additionalProperties": false,
"description": "(Required) - Describes the configuration of the ion beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000016",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The potential difference between anode and cathode. The acceleration voltage adds kinetic energy to the particles of the beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000001 It is defined separately as voltageDetails, (includes the voltage value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - uV, mv, V, kV, MV)"
},
"millingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Electrical current used in SEM-FIB Tomography to mill/cut the sample. In this case this is the same as the beam current of the ion beam. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003 It is defined separately as currentDetails (includes the current value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)."
}
},
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"imageDetails": {
"additionalProperties": false,
"description": "(Required) - describes the settings related to imaging",
"properties": {
"digitalBrightness": {
"description": "(Required) - A number indicating the setting for digital brightness (a basic post-processing method)",
"type": "number"
},
"digitalContrast": {
"description": "(Required) - A number indicating the setting for digital contrast (a basic post-processing method)",
"type": "number"
},
"digitalGamma": {
"description": "(Required) - A number indicating the setting for digital Gamma (a basic post-processing method)",
"type": "number"
},
"driftcorrected": {
"description": "(Required) - To bet set true if drift correction is on",
"type": "boolean"
},
"numberOfPixels": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The number of x, y pixels of the image (Resolution), defined separately as pixelNumberType with separate entries for integer values of xPixels and yPixels"
},
"postprocessing": {
"description": "(Optional) - Describes the post-processing performed on the image",
"type": "string"
},
"transformation": {
"description": "(Optional) - Describes the transformations performed on the image",
"type": "string"
},
"zoomfactor": {
"description": "(Required) - A number indicating the zoom factor",
"type": "number"
}
},
"required": [
"digitalContrast",
"digitalBrightness",
"digitalGamma",
"numberOfPixels",
"driftcorrected",
"zoomfactor"
],
"type": "object"
},
"imagesDetails": {
"desription": "(Required) - Details describing the images in the dataset, including location and image specific parameters",
"properties": {
"format": {
"default": "tiff",
"enum": [
"tiff",
"raw",
"png"
],
"type": "string"
},
"imageMetadataArray": {
"desription": "(Required) - Array containing the images and their specific parameters. No. of images in the array is described by the numberOfItems parameter at the entry level of this schema",
"items": {
"$ref": "https://github.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/blob/68fd9fa5de5dbe56bd7665b6320eb1ca47b4b1e5/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json"
},
"type": "array"
}
},
"required": [
"imageMetadataArray",
"format"
],
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"beamType": {
"description": "(Required) - The selected beam",
"enum": [
"EBeam",
"IBeam"
],
"type": "string"
},
"detector": {
"description": "(Required) - Details about the detector(s) used for acquisition.",
"items": {
"$ref": "#/$defs/detectorDetails"
},
"type": "array"
},
"eBeam": {
"$ref": "#/$defs/eBeamDetails",
"description": "(Required) - Details about the electron beam"
},
"hotStageMEMS": {
"$ref": "#/$defs/hotStageMEMSDetails",
"description": "(Optional) - Pressure maintained inside the chamber (in which the sample is housed) during the measurement"
},
"iBeam": {
"$ref": "#/$defs/iBeamDetails",
"description": "(Required) - Details about the ion beam"
},
"imaging": {
"$ref": "#/$defs/imageDetails",
"description": "(Optional) - Details about the imaging settings"
},
"numberOfDetectors": {
"description": "Number of detectors used for the acquisition",
"type": "number"
},
"scan": {
"$ref": "#/$defs/scanDetails",
"description": "(Required) - Details about the scan settings"
},
"spot": {
"description": "(Optional) - Qualitative index for beam current. Varies with current setting, i.e. 1.6 nA is spot = 1, 3.2 nA is spot = 2, 0.1 nA = spot =-3, so it can also be negative. May vary between different microscope models.",
"type": "number"
}
},
"required": [
"eBeam",
"scan",
"imaging",
"detector"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes the resolution of the image split into number of pixels in x and y directions.",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "describes a power",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "W",
"description": "(Optional) - the unit of the value to be selected from a controlled list (\u00b5W, mW, W, kW, MW default value - W) of datatype string",
"enum": [
"\u00b5W",
"mW",
"W",
"kW",
"MW"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The power expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "Pa",
"description": "(Optional) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"resistanceDetails": {
"additionalProperties": false,
"description": "describes a resistance",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "ohm",
"description": "(Optional) - the unit of the value to be selected from a controlled list (abohm, ohm, k ohm, M ohm default value - ohm) of datatype string; default unit is ohm",
"enum": [
"abohm",
"ohm",
"k ohm",
"M ohm"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The resistance expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"scanDetails": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scan settings.",
"properties": {
"average": {
"description": "(Optional) - Number of images averaged at each slice",
"type": "number"
},
"dwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time period during which the beam remains on one position/stationary. IRI: https://purls.helmholtz-metadaten.de/EMG/00000006 "
},
"eScan": {
"additionalProperties": false,
"description": "gives settings pertaining to electron beam scan",
"properties": {
"lineAveraging": {
"description": "(Optional) - Number of lines averaged",
"type": "number"
},
"lineIntegration": {
"description": "(Optional) - Number of lines integrated",
"type": "number"
},
"lineTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) -Time period during which a line is fully scanned."
},
"mainsLock": {
"description": "(Optional) - To bet set true if mains lock is on",
"type": "boolean"
},
"scanInterlacing": {
"description": "(Optional) - Number of scans interlaced. This setting splits an imaging area into blocks defined by the number of lines (from 2 to 8). In the first instance, the first line of each block is scanned, then the second one, etc. This imaging method significantly reduces charging.",
"type": "number"
}
},
"type": "object"
},
"frameTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) -Time period during which a frame is fully scanned. IRI: https://purls.helmholtz-metadaten.de/EMG/00000014 "
},
"horizontalFieldSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the actual horizontal length scanned on the sample defined separately as distanceDetails"
},
"integrate": {
"description": "(Optional) - Number of images integrated at each slice",
"type": "number"
},
"internalScan": {
"description": "(Optional) - To bet set true if internal scan is on",
"type": "boolean"
},
"pixelHeight": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual width of a pixel"
},
"pixelWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual width of a pixel"
},
"scanType": {
"description": "(Optional) - The type of scan E-Scan or I-Scan",
"enum": [
"EScan",
"IScan"
],
"type": "string"
},
"verticalFieldSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the actual vertical length scanned on the sample defined separately as distanceDetails"
}
},
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time period. IRI:https://purls.helmholtz-metadaten.de/EMG/00000024",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "us",
"description": "(Optional) - the unit of the value to be selected from a controlled list (ps, ns, us, ms, s default value - us) of datatype string",
"enum": [
"ps",
"ns",
"us",
"ms",
"s"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"user": {
"description": "Contact information of the user responsible for the measurement.",
"properties": {
"ORCID": {
"description": "(Optional) - Open Researcher and Contributor ID expressed as a URI",
"pattern": "^https://orcid\\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[X0-9]{1}$",
"type": "string"
},
"affiliation": {
"description": "(Optional) - Details of the institution to which the user is affiliated",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"description": "(Optional) -Identifier of the institution to which the user is affiliated",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be chosen from a controlled list of values (*ROR *GRID *ISNI *URL *DOI *Handle)",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"email": {
"description": "(Optional) - Email of the user",
"format": "email",
"type": "string"
},
"familyName": {
"description": "(Optional) - Family name of the user",
"type": "string"
},
"givenName": {
"description": "(Optional) - Given name of the user",
"type": "string"
},
"role": {
"description": "(Optional) - Role of the user to be selected from: *Data Curator *Instrument Scientist *Team Leader *Team Member",
"enum": [
"Data Curator",
"Instrument Scientist",
"Team Leader",
"Team Member"
],
"type": "string"
},
"userName": {
"description": "(Required) - Full name of the user recommended in the format (Family Name, Given Name)",
"type": "string"
}
},
"required": [
"userName"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "kV",
"description": "(Optional) - the unit of the value to be selected from a controlled list (uV, mV, V, kV, MV, GV default value - V) of datatype string",
"enum": [
"uV",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The voltage expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "https://github.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/blob/68fd9fa5de5dbe56bd7665b6320eb1ca47b4b1e5/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes a set of images acquired during the course of a SEM/FIB Tomography experiment. The images in each dataset is taken using a detector (SE, BSE, EDS, EBSD) using a specific configuration. This Schema contains only the parameters which are specific to the entire dataset. The parameters which are particular to each image is located at https://github.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/blob/68fd9fa5de5dbe56bd7665b6320eb1ca47b4b1e5/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json. The units are by default to be considred as the SI units unless otherwise specified",
"properties": {
"columns": {
"description": "(Optional) - Number of column in the tiled image grab setting",
"type": "number"
},
"datasetType": {
"default": "SEM",
"description": "(Required) - To be selected from the enumerated list depending on the detector and the angle at which the sample is measured: * SEM Image * SEM Image 2 * EDS * EBSD * BSE * ISE * ISI * SI * InLens * SESI",
"enum": [
"SEM Image",
"SEM Image 2",
"SEM Image 3",
"SEM Image 4",
"SEM Image 5",
"EDS",
"EBSD",
"BSE",
"ISE Image",
"ISI Image",
"SI Image",
"InLens",
"SESI"
],
"type": "string"
},
"definition": {
"description": "(Optional)- Name of the schema to which this entry conforms. In this case, acquisition_dataset is to be written",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Identifier of the dataset. It could be the PID of location where the entire dataset is stored"
},
"images": {
"$ref": "#/$defs/imagesDetails",
"description": "(Required) - Details describing the images in the dataset, including location and image specific parameters"
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings"
},
"numberOfItems": {
"description": "(Required) - Number of Items (images, files). Depends on the number of slices",
"type": "number"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required)- Details concerning the program (or software) used for aquisition"
},
"rows": {
"description": "(Optional) - Number of rows in the tiled image grab setting",
"type": "number"
},
"tileColumn": {
"description": "(Optional) - The selected column in the tiled image grab setting",
"type": "number"
},
"tileRow": {
"description": "(Optional) - The selected row in the tiled image grab setting",
"type": "number"
},
"user": {
"$ref": "#/$defs/user",
"description": "(Optional)- The contact information of the user responsible for the measurement"
}
},
"required": [
"definition",
"program",
"instrument",
"datasetType",
"images",
"displayedEnergyLevel",
"tileRow",
"tileColumn",
"columns",
"rows",
"name",
"numberOfItems"
],
"title": "acquisition_dataset",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 835f70140907332e97fc4b0f5e9382c1086e155a | 2024-02-20T09:18:52 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"CTAquisition": {
"additionalProperties": false,
"description": "(Required) - Details about the acquisition.",
"properties": {
"acquisitionScriptName": {
"description": "(Required) - Name of the script used for acquisition.",
"type": "string"
},
"acquisitionTimePerProjection": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time taken for acquisition of a single projection. Typical unit - s."
},
"angularStepSize": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Step size of the rotation of the sample during the CT. Typical unit - degree."
},
"contrastType": {
"description": "(Required) - The contrast type(mode) used - Absorption Contrast or Phase Contrast. If 'Phase Contrast' is selected, please indicate the used Phase Contrast Mode under the field phaseContrastMode.",
"enum": [
"Absorption Contrast",
"Phase Contrast"
],
"type": "string"
},
"endAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - End angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then endAngle is 180\u00b0. Typical unit - degree."
},
"largeFOV": {
"description": "(Required) - To be set to true if large field of view or wide field of view is used.",
"type": "boolean"
},
"numberOfProjections": {
"description": "(Required) - Number of projections acquired during the CT.",
"type": "number"
},
"phaseContrastMode": {
"description": "(Optional) - The phase contrast mode used during acquisition - Zernike phase contrast, propagation-based, grating-based(Hartmann), grating-based(Talbot).",
"enum": [
"Zernike phase contrast",
"Propagation-based",
"Grating-based(Hartmann)",
"Grating-based(Talbot)"
],
"type": "string"
},
"referenceImages": {
"additionalProperties": false,
"description": "(Optional) - Details on the reference images (if used) - number of flats/bright images and number of dark images.",
"properties": {
"numberOfBrightImages": {
"description": "(Optional) - Number of flats or bright images used as reference.",
"type": "number"
},
"numberOfDarkImages": {
"description": "(Optional) - Number of dark images used as reference.",
"type": "number"
}
},
"type": "object"
},
"scanningMode": {
"description": "(Optional) - The scanning mode used during acquisition - helical, raster scanning, fast CT.",
"enum": [
"Helical",
"Raster Scanning",
"Fast CT"
],
"type": "string"
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Start angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then startAngle is -180\u00b0. Typical unit - degree."
},
"totalAcquisitionTime": {
"description": "(Required) - Time taken for acquisition for the entire scan. This is the total scan time, i.e. number of projections multipled by exposure time, but including read-out time. calculated as EndTime-StartTime. Format: hh:mm:ss.",
"format": "time",
"pattern": "^(\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?)$",
"type": "string"
},
"useBadPixelMap": {
"description": "(Optional) - To be set to true if bad pixel map is used. This parameter is relevant for SEM based CT.",
"type": "boolean"
}
},
"required": [
"acquisitionScriptName",
"startAngle",
"endAngle",
"angularStepSize",
"acquisitionTimePerProjection",
"totalAcquisitionTime",
"largeFOV",
"contrastType"
],
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian) of datatype string.",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"angleSet": {
"additionalProperties": false,
"description": "(Optional) - Tilt angles alpha, beta and gamma decribing the three angular positions of an item.",
"properties": {
"alpha": {
"description": "(Optional) - Tilt angle alpha of the item.",
"type": "number"
},
"anglesUnit": {
"description": "(Optional) - unit of the angles (allowed units - degree or radian)",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"beta": {
"description": "(Optional) - Rotation angle beta of the item.",
"type": "number"
},
"gamma": {
"description": "(Optional) - Angle gamma of the item.",
"type": "number"
}
},
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A).",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"data": {
"additionalProperties": false,
"description": "(Required) - Details about the data section of the measurement.",
"properties": {
"projections": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"cropping": {
"additionalProperties": false,
"description": "(Optional) - Details about cropping or clipping to select a region of interest(ROI).",
"properties": {
"ROI": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The size of the region of interest (ROI) in integer values of xPixels and yPixels."
},
"offset": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The offset applied to the origin (i.e., centre of the image) to select the region of interest in x and y coordinates."
}
},
"required": [
"ROI",
"offset"
],
"type": "object"
},
"projectionImageDataStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the data structure of the image data of the projections.",
"properties": {
"IOValue": {
"description": "(Required) - The IO value obtained from the metadata.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The dimension of the image as for integer values of xPixels and yPixels."
},
"fileLocation": {
"description": "(Required) - The location where the data file is stored. A URL is preferred if available.",
"type": "string"
},
"greyValueRepresentation": {
"description": "(Optional) - Description about the grey value representation.",
"type": "string"
},
"header": {
"additionalProperties": false,
"description": "(Required) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Required) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"imageCorrection": {
"additionalProperties": false,
"description": "(Optional) - Details about the image correction.",
"properties": {
"isImageCorrected": {
"description": "(Required) - To be set as true if image is corrected.",
"type": "boolean"
},
"linkToReferenceImages": {
"description": "(Required) - Link to the reference images (flats/darks).",
"format": "uri-reference",
"type": "string"
}
},
"required": [
"isImageCorrected",
"linkToReferenceImages"
],
"type": "object"
},
"imageFormats": {
"additionalProperties": false,
"description": "(Required) - The file formats of the images - tiff, png, jpeg. When more than one file formats are there, then the formats are to be entered as an array of strings.",
"properties": {
"fileFormats": {
"oneOf": [
{
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
{
"items": {
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"fileFormats"
],
"type": "object"
},
"imageID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the Image Data."
},
"isPreFiltered": {
"description": "(Optional) - To be set as true if image is prefiltered.",
"type": "boolean"
},
"name": {
"description": "(Required) - Name of the Projection Image Data.",
"type": "string"
},
"numberOfImages": {
"description": "(Required) - Number of images in the data set. It is same as the number of projections.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical x,y length imaged by a single pixel, normally expressed in \u00b5m."
}
},
"required": [
"fileLocation",
"name",
"imageFormats",
"header"
],
"type": "object"
}
},
"required": [
"projectionImageDataStructure"
],
"type": "object"
},
"reconstructedData": {
"additionalProperties": false,
"description": "(Required) - Details about the reconstructed slices. When multiple reconstructions of the same raw data (projections) are present, the corresponding data can be combined as an array of reconstruction data sets, else as a single reconstruction data set.",
"properties": {
"reconstruction": {
"oneOf": [
{
"$ref": "#/$defs/reconstruction"
},
{
"items": {
"$ref": "#/$defs/reconstruction"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"reconstruction"
],
"type": "object"
}
},
"required": [
"projections",
"reconstructedData"
],
"type": "object"
},
"detector": {
"additionalProperties": false,
"description": "gives the settings of a detector or multiple detectors.",
"properties": {
"detectorSettings": {
"oneOf": [
{
"$ref": "#/$defs/detectorSettings"
},
{
"items": {
"$ref": "#/$defs/detectorSettings"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"detectorSettings"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "(Required) - Gives the settings of a single detector.",
"properties": {
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each pixel or voxel in an image. The bit depth determines the number of possible intensity levels that can be assigned to each pixel or voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"cameraGain": {
"description": "(Optional) - The amplification (gain) of the signal from an image sensor in a camera.",
"type": "number"
},
"detectorCoolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Cooling temperature of the detector, if it cooled. Relevant for SEM based CT. Typical unit - K."
},
"detectorDimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Optional) - The dimensions of the detector in integer values of xPixels and yPixels."
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector."
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the detector (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"detectorMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - The motor positions of the detector in cartesian coordinates and tilt angles."
},
"detectorName": {
"description": "(Optional) - Name of the detector of datatype string.",
"type": "string"
},
"detectorPixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical length in cartesian coordinates imaged by a single pixel of the detector. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"detectorType": {
"description": "(Optional) - The type of detector to be selected from a controlled list consisting of CCD, Panel, PCXD, CMOS, Time-Delay Integration (TDI) and Direct Conversion.",
"enum": [
"CCD",
"Panel",
"PCXD",
"CMOS",
"Time-Delay Integration (TDI)",
"Direct Conversion"
],
"type": "string"
},
"energyThreshold": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - A specific energy level used to filter the detected radiation."
},
"exposureTimePerFrame": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Time for which the sample is exposed per frame. Typical unit - s."
},
"frameSkip": {
"additionalProperties": false,
"description": "(Optional) - A numerical representation indicating the number of frames that are skipped or omitted during the acquisition or recording process. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3. If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped.",
"properties": {
"value": {
"oneOf": [
{
"description": "(Optional) - Number of frames skipped during acquisition. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3.",
"type": "number"
},
{
"description": "(Optional) - Pattern of frames skipped during acquisition. E.g. - If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped like [1,3,5]",
"items": {
"type": "number"
},
"minItems": 1,
"type": "array"
}
]
}
},
"type": "object"
},
"framesPerSecond": {
"description": "(Optional) - The number of frames captured in a second.",
"type": "number"
},
"imagePixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical length in cartesian coordinates imaged by a single pixel of the image. It is the native pixel size divided by the total magnification. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"lens": {
"additionalProperties": false,
"description": "(Optional) - Details of a lens, if used with the detector.",
"properties": {
"hasLens": {
"description": "(Required) - To be set to true if the detector has a lens.",
"type": "boolean"
},
"lensFocalLength": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Focal length of the lens."
},
"lensID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the lens."
},
"lensMagnification": {
"description": "(Optional) - Magnification of the lens as a floating point number.",
"type": "number"
},
"lensManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the lens (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"lensName": {
"description": "(Optional) - Name of the lens of datatype string.",
"type": "string"
}
},
"required": [
"lensMagnification",
"lensFocalLength"
],
"type": "object"
},
"numberOfAveragedFramesPerProjection": {
"description": "(Optional) - The number of averaged frames per projection, if averaging is done.",
"type": "number"
},
"sensor": {
"additionalProperties": false,
"description": "(Optional) - Details about a sensor, if present.",
"properties": {
"hasSensor": {
"description": "(Required) - To be set to true if the detector has a sensor.",
"type": "boolean"
},
"sensorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the sensor."
},
"sensorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the sensor (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"sensorMaterial": {
"description": "(Optional) - Material of the sensor of datatype string.",
"type": "string"
},
"sensorName": {
"description": "(Optional) - Name of the sensor of datatype string.",
"type": "string"
},
"sensorThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the sensor."
},
"sensorType": {
"description": "(Optional) - The type of sensor as a string.",
"type": "string"
}
},
"required": [
"hasSensor"
],
"type": "object"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Temperature of the detector."
},
"totalCountsPerProjection": {
"description": "(Optional) - The sum of the intensity values recorded by the X-ray detector for a single projection during a scan.",
"type": "number"
}
},
"required": [
"detectorType",
"detectorManufacturer",
"binning",
"detectorMotorPositions",
"imagePixelSize"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m).",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ).",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min). Typical unit - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"geometry": {
"additionalProperties": false,
"description": "Describes the geometry of the CT instrument",
"properties": {
"beamGeometry": {
"additionalProperties": false,
"description": "(Required) - Details about beam geometry like beam geometry type and divergence angle.",
"properties": {
"beamGeometryType": {
"description": "(Required) - The type of the beam geometry to be selected between 'collimated' and 'divergent'.",
"enum": [
"collimated",
"divergent"
],
"type": "string"
},
"divergenceAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Angle of divergence when the beam geometry is divergent. Typical unit - degree."
}
},
"type": "object"
},
"geometricMagnification": {
"description": "(Required) - Geometric magnification refers to the ratio of the size of an object's image to the size of the object itself. It is a measure of how much larger the image appears compared to the actual object. Geometric magnification (M) is calculated using the formula M = (SID + SOD) / SID, where SID is the source-to-image distance and SOD is the source-to-object distance.",
"type": "number"
},
"objectToDetectorDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the object and the detector. Typical unit - \u00b5m."
},
"opticalMagnification": {
"description": "(Required) - Optical magnification is calculated as the ratio of the focal length of the objective lens to the focal length of the eyepiece (if an eyepiece is present) in a traditional optical microscope.",
"type": "number"
},
"sourceToObjectDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the source and the object. Typical unit - \u00b5m."
}
},
"required": [
"sourceToObjectDistance",
"objectToDetectorDistance",
"beamGeometry",
"geometricMagnification",
"opticalMagnification"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"CTAquisition": {
"$ref": "#/$defs/CTAquisition",
"description": "(Optional) - Details regarding the acquisition."
},
"calibration": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the calibration and the scaling factor.",
"properties": {
"calibrationType": {
"description": "(Optional) - Type of calibration as a string.",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (YYYY-MM-DDThh:mm:ss.sss) in the ISO 8601 date-time format",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"systemScaling": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scaling factor.",
"properties": {
"adjustSystemScaling": {
"description": "(Required) - To be set to true if system scaling is adjusted, else false.",
"type": "boolean"
},
"measuredScalingFactor": {
"description": "(Optional) - Value of the measured scaling factor.",
"type": "number"
},
"referenceScalingFactor": {
"description": "(Optional) - Value of the reference scaling factor, determined ususally during the data processing.",
"type": "number"
}
},
"required": [
"adjustSystemScaling"
],
"type": "object"
}
},
"type": "object"
},
"detector": {
"$ref": "#/$defs/detector",
"description": "(Optional) - Details regarding the detector."
},
"focalSpotMode": {
"additionalProperties": false,
"description": "(Optional) - Option for setting the size of the focal spot. Some sources have the option to select the target spot size, or focal spot size absolutely by setting a value, while some others give the option of selecting 'small', 'medium' or 'large'. Smaller spot size = higher resolution. Note that the power/current will change with this value. In addition, the detector settings will usually be selected in conjunction. (different scintillator/lens/magnification).",
"properties": {
"selection": {
"description": "(Optional) - Selection of the setting of the size of the focal spot when the option for setting the size of the focal spot by selecting 'small', 'medium' or 'large' according to predefined values set by the manufacturer.",
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the target spot when the option for setting the size of the focal spot absolutely by setting a value is available."
}
},
"type": "object"
},
"geometry": {
"$ref": "#/$defs/geometry",
"description": "(Optional) - Details regarding the geometry."
},
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"optics": {
"$ref": "#/$defs/optics",
"description": "(Optional) - Details about the optics and individual motor positions."
},
"sampleStage": {
"$ref": "#/$defs/sampleStage",
"description": "(Optional) - Details regarding the sample stage."
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray target in an SEM based CT set-up.",
"properties": {
"SEMManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the scanning electron microscope used for SEM based CT."
},
"SEMName": {
"description": "(Required) - Name of the scanning electron microscope used for SEM based CT.",
"type": "string"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the material which acts as the cathode in SEM based CT",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required) - Details of the pressure maintained in the chamber of the SEM."
},
"electronBeamShift": {
"additionalProperties": false,
"description": "(Required) - The distance by which the electron beam is shifted in the x and y directions.",
"properties": {
"xShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the x direction. Typical unit - \u00b5m."
},
"yShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xShift",
"yShift"
],
"type": "object"
},
"electronProbeCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required) - The electron current measured at the probe. Typical unit - \u00b5A."
},
"objectiveLensAperture": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). Typically the diameter of the aperture is set in \u00b5m."
},
"target": {
"additionalProperties": false,
"description": "(Required) - Details regarding the target in SEM based CT, which upon interaction with the e-beam produces the X-rays.",
"properties": {
"targetDriftCorrection": {
"description": "(Required) - If drift correction is activated for the target, this parameter has to be set to true.",
"type": "boolean"
},
"targetMaterial": {
"description": "(Required) - Material with which the target is made.",
"type": "string"
},
"targetShape": {
"description": "(Optional) - Description of the shape or geometry of the target. e.g. - bulk, foil, needle.",
"type": "string"
},
"targetThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Thickness of the target (dimension in Z direction). Default unit - \u00b5m."
},
"targetTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the target is tilted. Typical unit - degree."
}
},
"required": [
"targetMaterial",
"targetThickness",
"targetDriftCorrection",
"targetTiltAngle"
],
"type": "object"
},
"voltage": {},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. In SEM based CT, the beam is focussed on the target material which emits the X-rays upon interaction with the electrons. Default unit - \u00b5m."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray energy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
}
},
"required": [
"chromaticity"
],
"type": "object"
}
},
"required": [
"chamberPressure",
"electronBeamShift",
"workingDistance",
"objectiveLensAperture",
"electronProbeCurrent",
"target"
],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
},
"targetCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current measured at the X-ray target, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"sourceDrift": {
"additionalProperties": false,
"description": "(Optional) - Distance by which the source is shifted during the measurement (i.e., end position - start position).",
"properties": {
"xDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the x direction. Typical unit - \u00b5m."
},
"yDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xDrift",
"yDrift"
],
"type": "object"
},
"sourcePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the source."
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray energy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source",
"focalSpotMode",
"CTAquisition",
"geometry",
"sampleStage",
"detector"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer.",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"bioReactor": {
"additionalProperties": false,
"description": "(Optional) - Details of an in situ bioreactor.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in sterile conditions.",
"type": "boolean"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is decreased. Typical unit - K/min."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is increased, typically in K/min."
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"anvil": {
"description": "(Optional) - The type of anvil used in the in situ load frame (stage) for applying a particular type of force on the sample. Option to be selected from a controlled list consisting of - Compression, Diamond indentation 90\u00b0 cone, Diamond indentation cube corner, Diamond indentation wedge, Tension, Other. If 'Other' is selected, specify the name of the anvil with a description in the field 'otherAnvil'.",
"enum": [
"Compression",
"Diamond indentation 90\u00b0 cone",
"Diamond indentation cube corner",
"Diamond indentation wedge",
"Tension",
"Other"
],
"type": "string"
},
"blindAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - ed by the load frame(stage). Example: for a CT normally scanned over 180\u00b0 (e.g. -90\u00b0/+90\u00b0), a blind angle of 40\u00b0 due to the in situ cell implies that only 180\u00b0-40\u00b0=140\u00b0 (e.g. -70\u00b0/70\u00b0) is visible. NOTE: for a CT normally scanned over 360\u00b0 (e.g. -180\u00b0/+180\u00b0), a blind angle of 40\u00b0 would require the subtraction of the blind angle twice, implying two scan ranges of 140\u00b0 each (e.g. -160\u00b0/-20\u00b0 and +20\u00b0/+160\u00b0). Typical unit - degree."
},
"displacement": {
"additionalProperties": false,
"description": "(Optional) - Specification on how displacement is applied on the sample. Either 'displacementRate' in \u00b5m/min or 'displacementIncrement' in \u00b5m/acquisition need to be selected.",
"properties": {
"displacementIncrement": {
"description": "(Optional) - The step at which displacement is changed per acquisition in \u00b5m/acquisition.",
"type": "number"
},
"displacementRate": {
"description": "(Optional) - The rate at which displacement is applied on the sample in \u00b5m/min.",
"type": "number"
}
},
"type": "object"
},
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame or anvil (e.g. - size of anvil) relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
},
"maximumDisplacement": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - The maximum displacement allowed in the selected configuration. Typical unit - \u00b5m."
},
"maximumForce": {
"description": "(Optional) - The maximum force that can be applied to the sample in N.",
"type": "number"
},
"otherAnvil": {
"description": "(Optional) - If 'anvil' was selected as 'Other' from the controlled list as it was not listed, please specify the name of the anvil with a description in this field.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the vacuum chamber relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the vacuum chamber relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the vacuum chamber."
},
"chamberName": {
"description": "(Optional) - Name of the vacuum chamber.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"motorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchical level and direction of a motor.",
"properties": {
"motorDirection": {
"description": "(Required) - The direction of movement (for X,Y,Z,M motors) or axis of rotation (for rotating motors) expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the X-stage and perpendicular to the Y-stage. then beam direction = [1 0 0], X-stage-direction = [1 0 0] (positive movement direction away from source towards detector) or can be (-1 0 0) (towards source) and Y-stage-direction = [0 1 0] or can be [0 -1 0] (analogous interpretation). The parameters need to be individually determined for each instrument. For rotating motors, the directional vector of axis of rotation should be given in Cartesian coordinates (counterclockwise, right-hand rule).",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"motorLevel": {
"description": "(Required) - Hierarchy of the motor expressed as an integer.",
"type": "number"
}
},
"type": "object"
},
"motorPositions": {
"additionalProperties": false,
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the motor.",
"properties": {
"angles": {
"$ref": "#/$defs/angleSet",
"description": "(Optional) - The three tilt angles alpha, beta and gamma of the motors controlling the position of the item."
},
"xyzPositions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - The xyz coordinates describing the motor positions of the item."
}
},
"type": "object"
},
"optics": {
"additionalProperties": false,
"description": "(Optional) - Details about the optics and individual motor positions.",
"properties": {
"collimator": {
"additionalProperties": false,
"description": "(Optional) - Details about the collimator and its individual motor positions.",
"properties": {
"collimatorDetails": {
"description": "(Optional) - Details about the collimator relevant for the measurement.",
"type": "string"
},
"collimatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the collimator."
}
},
"type": "object"
},
"condenser": {
"additionalProperties": false,
"description": "(Optional) - Details about the condenser lens and its individual motor positions, if used.",
"properties": {
"condenserDetails": {
"description": "(Optional) - Details about the condenser relevant for the measurement.",
"type": "string"
},
"condenserPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the condenser."
}
},
"type": "object"
},
"fresnelZonePlate": {
"additionalProperties": false,
"description": "(Optional) - Details about the fresnel zone plate and its individual motor positions, if used.",
"properties": {
"fresnelZonePlateDetails": {
"description": "(Optional) - Details about the fresnel zone plate relevant for the measurement.",
"type": "string"
},
"fresnelZonePlatePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the fresnel zone plate."
}
},
"type": "object"
},
"monochromator": {
"additionalProperties": false,
"description": "(Required) - Details about the monochromator and individual motor positions, if used.",
"properties": {
"monochromatorDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the monochromator type type, material, energy and notes.",
"properties": {
"energy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Energy set in the monochromator. Typical unit - eV."
},
"material": {
"description": "(Optional) - Material of the monochromator.",
"type": "string"
},
"monochromatorType": {
"description": "(Optional) - Type of the monochromator.",
"type": "string"
},
"notes": {
"description": "(Optional) - Additional information about the monochromator relevant for the measurement."
}
},
"type": "object"
},
"monochromatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the monochromator."
},
"monochromatorUsed": {
"description": "(Required) - To be set to true if monochromator is used, else false.",
"type": "boolean"
}
},
"required": [
"monochromatorUsed"
],
"type": "object"
},
"phaseRing": {
"additionalProperties": false,
"description": "(Required) - Details about the phase ring and its individual motor positions, if inserted.",
"properties": {
"phaseRingDetails": {
"description": "(Optional) - Details about the phase ring relevant for the measurement.",
"type": "string"
},
"phaseRingPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the phase ring."
}
},
"type": "object"
}
},
"required": [
"monochromator"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes a parameter which can be split into number of pixels in x and y directions like the resolution",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm or \u00b5m, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the size of a single pixel (typical value - nm, \u00b5m) of datatype string",
"enum": [
"nm",
"\u00b5m"
],
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min).",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW).",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi).",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"rampDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a rate at which temperature is increased or decreased.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K/min, K/s).",
"enum": [
"K/min",
"K/s"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of temperature increase or decrease.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"reconstruction": {
"additionalProperties": false,
"description": "Data from one single reconstruction.",
"properties": {
"reconstructionDetails": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"additionalFilters": {
"beamHardeningCorrection": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"filterType": {
"description": "(Optional) - Type of the additional filter - Median or Gauss",
"enum": [
"Median",
"Gauss"
],
"type": "string"
},
"phaseRetrieval": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"ringFilter": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
}
},
"algorithm": {
"description": "(Required) - Algorithm used for reconstruction to be selected from FBP - Filtered Back Projection, ART - Algebraic Reconstruction Technique, 3dCT - 3D Computed Tomography and Gridrec.",
"enum": [
"FBP - Filtered Back Projection",
"ART - Algebraic Reconstruction Technique",
"3dCT - 3D Computed Tomography",
"Gridrec"
],
"type": "string"
},
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepthConversionMax": {
"description": "(Required) - Maximum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"bitDepthConversionMin": {
"description": "(Required) - Minimum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"hardwarePlatform": {
"description": "(Optional) - Hardware platform used for reconstruction to be selected between CPU and GPU.",
"enum": [
"CPU",
"GPU"
],
"type": "string"
},
"lastImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the last image for the reconstruction of the 3D Volume, typically an integer.",
"type": "string"
},
"projectionPadding": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the projection padding applied to the raw projection data to address certain issues in the reconstruction process.",
"properties": {
"paddingSize": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - Size of the projection padding used in pixels."
},
"paddingType": {
"description": "(Required) - Type of the projection padding used - Zero Padding, Linear Interpolation Padding, Sinc Interpolation Padding, Shepp-Logan Filtered Back Projection (SL-FBP), Gridding and Extended Field of View (FOV) Padding.",
"enum": [
"Zero Padding",
"Linear Interpolation Padding",
"Sinc Interpolation Padding",
"Shepp-Logan Filtered Back Projection (SL-FBP)",
"Gridding",
"Extended Field of View (FOV) Padding"
],
"type": "string"
}
},
"type": "object"
},
"reconstructionSoftware": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for reconstruction. It may be the same as the acquisition software or a different one."
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Scan angle at which the reconstruction of the 3D Volume starts. Typical unit - degree."
},
"startImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the start image for the reconstruction of the 3D Volume.",
"type": "string"
},
"tomographicProjectionFilter": {
"description": "(Optional) - Name of the tomographic projection filter used to be selected from Ram-Lak Filter, Butterworth Filter, Shepp-Logan Filter, Hann (Hanning) Filter, Gaussian Filter, Cosine Filter, Soft Filtration Method and Hard Filtration Method.",
"enum": [
"Ram-Lak Filter",
"Butterworth Filter",
"Shepp-Logan Filter",
"Hann (Hanning) Filter",
"Gaussian Filter",
"Cosine Filter",
"Soft Filtration Method",
"Hard Filtration Method"
],
"type": "string"
}
},
"required": [
"startImage",
"lastImage",
"startAngle",
"hardwarePlatform",
"algorithm",
"binning"
],
"type": "object"
},
"volumeStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each voxel in the 3D volume. The bit depth determines the number of possible intensity levels that can be assigned to each voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Required) - The dimension of the 3D volume in XYZ coordinates. If the length in Z dimension is not known and instead only the number of slices are known, they need to be separately entered in the field 'numberOfSlices'. Typical unit - \u00b5m."
},
"header": {
"additionalProperties": false,
"description": "(Optional) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Optional) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"name": {
"description": "(Required) - Name of the 3D volume structure (dataset).",
"type": "string"
},
"numberOfSlices": {
"description": "(Optional) - No. of slices which make up the 3D volume.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel/voxel, normally expressed in \u00b5m."
},
"volumeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry of the 3D reconstructed volume usually provided by the project or the laboratory."
}
},
"required": [
"name",
"dimensions",
"bitDepth",
"pixelSize"
],
"type": "object"
}
},
"required": [
"volumeStructure",
"reconstructionDetails"
],
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"sampleStage": {
"additionalProperties": false,
"description": "(Required) - Details about sample stage.",
"properties": {
"stageMotorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchy of the stage motors. This information is required to know how the motor movements affect the positions of the samples, particularly relevant for correlative characterization.",
"properties": {
"beamDirection": {
"description": "(Required) - The beam direction expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the Y-stage and perpendicular to the X-stage. then beam direction = [0 1 0].",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"mMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the M motor (stage) as a vector in cartesian coordiantes. The M motor is usually relevant only for SEM based CT. It is a special motor which counteracts the Z motor."
},
"rMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the R motor (stage) as a vector in cartesian coordiantes. R motor has rotation around z axis +1 (for anticlockwise)."
},
"tMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the T motor (stage) as a vector in cartesian coordiantes. The T motor is usually relevant only for SEM based CT."
},
"xMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the X motor (stage) as a vector in cartesian coordinates."
},
"yMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Y motor (stage) as a vector in cartesian coordinates."
},
"zMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Z motor (stage) as a vector in cartesian coordinates."
}
},
"required": [
"beamDirection",
"xMotor",
"yMotor",
"zMotor",
"rMotor"
],
"type": "object"
},
"stageMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the stage motors."
}
},
"required": [
"stageMotorHierarchy"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s).",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"user": {
"description": "Basic schema for user description. It can be extended.",
"properties": {
"ORCID": {
"description": "(Optional) - Open Researcher and Contributor ID expressed as a URI",
"pattern": "^https://orcid\\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[X0-9]{1}$",
"type": "string"
},
"affiliation": {
"description": "(Optional) - Details of the institution to which the user is affiliated",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"description": "(Optional) -Identifier of the institution to which the user is affiliated",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be chosen from a controlled list of values (*ROR *GRID *ISNI *URL *DOI *Handle)",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"email": {
"description": "(Optional) - Email of the user",
"format": "email",
"type": "string"
},
"familyName": {
"description": "(Optional) - Family name of the user",
"type": "string"
},
"givenName": {
"description": "(Optional) - Given name of the user",
"type": "string"
},
"role": {
"description": "(Required) - Role of the research user",
"enum": [
"Data Curator",
"Instrument Scientist",
"Team Leader",
"Team Member"
],
"type": "string"
},
"userName": {
"description": "(Required) - Full name of the user in the format (Family Name, Given Name)",
"type": "string"
}
},
"required": [
"userName",
"role"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV).",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided. Contributors (in alphabetical order of last names): Alexey Boubnov, Rafaela Debastiani, Jonas Fell, Sarah Irvine, Reetu Elza Joseph.",
"properties": {
"consumables": {
"description": "(Optional) - Auxiliary entity used during Fabrication, Sample Preparation or Measurement which has a limited time capacity or is limited in its number of uses before it is disposed of, necessary to the process itself and normally bought from third party manufacturers. Examples are: gloves, syringes, wipes, etching solutions, glass slides, spatulas, weighing paper, two-sided tape.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"data": {
"$ref": "#/$defs/data",
"description": "(Required)- Details concerning the data section of the measurement."
},
"definition": {
"description": "(Required) - Name of the schema to which this entry conforms. In this case, lab_CT should be written.",
"type": "string"
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry usually provided by the project or the laboratory."
},
"equipment": {
"description": "(Optional) - Any kind of physical or virtual item, device, machine or other tools used to perform one or more Fabrication(s), Sample Preparation(s), Model Preparation(s), Data Acquisition(s) and/or any of the processes included in the Data Analysis Lifecycle. Usually, the Equipment is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. Equipment is usually an investment. According to this definition, an Instrument is a particular type of Equipment.",
"type": "string"
},
"experimentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the measurement usually provided by the project or the laboratory."
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings. Instrument is a physical or virtual identifiable piece of Equipment used to perform a Data Acquisition and to generate Raw Data. The Instrument is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. A virtual Instrument may be any computational resource or HPC infrastructure (cloud infrastructure or supercomputer) needed to perform Calculations or Simulations."
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure."
},
"measurementDescription": {
"description": "(Optional) - Description about the measurement.",
"type": "string"
},
"measurementPurpose": {
"description": "(Required) - Measurement is experimental Data Acquisition, typically performed on a Sample using an experimental Technique. It may also be performed during Fabrication or Sample Preparation, e.g., to characterise the intermediate stages and/or the final resulting Precursor(s) or Sample(s), respectively. A Measurement may require the use of Consumables.",
"enum": [
"assessment (to given categories or values)",
"completeness check (presence or absence of given properties)",
"correlative characterization (dedicated sample treatment to emphasise given features)",
"exploratory (routine check of known properties)",
"feasibility (quick check, rough estimate)",
"high quality measurement (precise, careful treatment)",
"test specific hypothesis (focus only on given aspects)",
"other (please specify in the comment)"
],
"type": "string"
},
"parents": {
"description": "(Required) - Parents of this metadata like the metadata document of the sample with which the measurement was performed.",
"items": {
"if": {
"properties": {
"parentType": {
"not": {
"const": "not applicable"
}
}
}
},
"properties": {
"parentReference": {
"description": "If type is 'MetaStore URI' it is possible to easily fill this field in a later stage",
"format": "uri-reference",
"type": "string"
},
"parentReferenceType": {
"default": "MetaStore URI",
"enum": [
"plain text",
"external URL",
"MetaStore URI"
],
"type": "string"
},
"parentType": {
"default": "sample",
"enum": [
"not applicable",
"sample"
],
"type": "string"
}
},
"required": [
"parentType"
],
"then": {
"required": [
"parentReferenceType",
"parentReference"
]
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition."
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format."
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"technique": {
"description": "(Required) - Any experimental, theoretical or computational method used during Data Acquisition or during any of the processes included in the Data Analysis Lifecycle to acquire, process or analyse Research Data about a System or a set of them with an Instrument, which is used to generate this metadata.",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement.",
"type": "string"
},
"user": {
"$ref": "#/$defs/user",
"description": "(Required)- The contact information of the user responsible for the measurement."
}
},
"required": [
"title",
"technique",
"definition",
"parents",
"measurementPurpose",
"startTime",
"endTime",
"program",
"user",
"instrument",
"data"
],
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 8ac1403aff29207d2374a9ba1e237e357cfb99c3 | 2024-03-04T13:50:36 | SEM-FIB_Tomography/SEM_FIB_Tomography_Acquisition_Main.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"acquisition": {
"additionalProperties": false,
"description": "This level is the root element of the schema. It contains all the metadata describing an acquisition as part of an SEM/FIB Tomography measurement which might include multiple detectors.",
"properties": {
"dataset": {
"description": "Array of all the dataset-metadata acquired using multiple detectors",
"items": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json"
},
"type": "array"
},
"genericMetadata": {
"additionalProperties": false,
"description": "Describes all the generic metadata common to the acquisition",
"properties": {
"ESEM": {
"description": "To be set to true if environmental SEM is used",
"type": "boolean"
},
"angleToEBeam": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - angle between e-beam and i-beam defined separately as angleDetails (Allowed units: degree, radian). It is specified by the manufacturer and a property of the geometry of the instrument."
},
"applicationID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Details concerning the program (or software) used for aquisition"
},
"column": {
"description": "The name of the column used in the instrument",
"type": "string"
},
"consumables": {
"description": "(Optional) - Auxiliary entity used during Fabrication, Sample Preparation or Measurement which has a limited time capacity or is limited in its number of uses before it is disposed of, necessary to the process itself and normally bought from third party manufacturers. Examples are: gloves, syringes, wipes, etching solutions, glass slides, spatulas, weighing paper, two-sided tape.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"equipment": {
"description": "(Optional) - Any kind of physical or virtual item, device, machine or other tools used to perform one or more Fabrication(s), Sample Preparation(s), Model Preparation(s), Data Acquisition(s) and/or any of the processes included in the Data Analysis Lifecycle. Usually, the Equipment is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. Equipment is usually an investment. According to this definition, an Instrument is a particular type of Equipment.",
"type": "string"
},
"eucentricWorkingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "The Working Distance when the smaple is at the eucentric height"
},
"fileVersion": {
"description": "The file version of the measurement data of the project",
"type": "string"
},
"measurementDescription": {
"description": "(Optional) - Description about the measurement.",
"type": "string"
},
"measurementPurpose": {
"description": "(Required) - Measurement is experimental Data Acquisition, typically performed on a Sample using an experimental Technique. It may also be performed during Fabrication or Sample Preparation, e.g., to characterise the intermediate stages and/or the final resulting Precursor(s) or Sample(s), respectively. A Measurement may require the use of Consumables.",
"enum": [
"assessment (to given categories or values)",
"completeness check (presence or absence of given properties)",
"correlative characterization (dedicated sample treatment to emphasise given features)",
"exploratory (routine check of known properties)",
"feasibility (quick check, rough estimate)",
"high quality measurement (precise, careful treatment)",
"test specific hypothesis (focus only on given aspects)",
"other (please specify in the comment)"
],
"type": "string"
},
"millingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "The total height of the area which is cut into slices in the z dimension. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003"
},
"millingLocationDepth": {
"$ref": "#/$defs/distanceDetails",
"description": "The total width of the area which is cut into slices in the y dimension"
},
"millingLocationHeight": {
"$ref": "#/$defs/distanceDetails",
"description": "The total height of the area which is cut into slices in the z dimension"
},
"millingLocationWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "The total width of the area which is cut into slices in the x dimension"
},
"millingLocationX": {
"$ref": "#/$defs/distanceDetails",
"description": "X coordinate begin of the milling location from the origin."
},
"millingLocationY": {
"$ref": "#/$defs/distanceDetails",
"description": "Y coordinate of the begin of the milling location from the origin."
},
"millingMaterial": {
"description": "Material which is milled",
"type": "string"
},
"numberOfCuts": {
"description": "The number of slices into which the sample is cut during the course of the SEM/FIB Tomography",
"type": "number"
},
"parents": {
"description": "(Required) - Parents of this metadata like the metadata document of the sample with which the measurement was performed.",
"items": {
"if": {
"properties": {
"parentType": {
"not": {
"const": "not applicable"
}
}
}
},
"properties": {
"parentReference": {
"description": "If type is 'MetaStore URI' it is possible to easily fill this field in a later stage",
"format": "uri-reference",
"type": "string"
},
"parentReferenceType": {
"default": "MetaStore URI",
"enum": [
"plain text",
"external URL",
"MetaStore URI"
],
"type": "string"
},
"parentType": {
"default": "sample",
"enum": [
"not applicable",
"sample"
],
"type": "string"
}
},
"required": [
"parentType"
],
"then": {
"required": [
"parentReferenceType",
"parentReference"
]
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Optional)- Details concerning the program (or software) used for aquisition"
},
"projectDescription": {
"description": "Description about the project containing the acquistion datasets",
"type": "string"
},
"projectID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Details concerning the program (or software) used for aquisition"
},
"projectName": {
"description": "The name of the project containing the acquistion datasets",
"type": "string"
},
"pump": {
"description": "The name of the pump used in the instrument",
"type": "string"
},
"source": {
"description": "The type of the source used in the instrument. The source is a physical part of an electron or ion microscope from which the particles that form the beam are emitted. IRI: https://purls.helmholtz-metadaten.de/EMG/00000021",
"type": "string"
},
"stage": {
"description": "The dimensions of the stage used in the instrument",
"type": "string"
},
"systemType": {
"description": "Describes the system type used - the name of the instrument",
"type": "string"
},
"technique": {
"description": "(Required) - Any experimental, theoretical or computational method used during Data Acquisition or during any of the processes included in the Data Analysis Lifecycle to acquire, process or analyse Research Data about a System or a set of them with an Instrument, which is used to generate this metadata.",
"type": "string"
},
"userDescription": {
"description": "Additional description provided by the user about the measurement or the sample",
"type": "string"
},
"zCutSpacing": {
"$ref": "#/$defs/distanceDetails",
"description": "The spacing between individual slices in z dimension"
}
},
"required": [
"angleToEBeam",
"zCutSpacing",
"projectName",
"applicationID",
"program",
"technique",
"measurementPurpose",
"parents"
],
"type": "object"
}
},
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min)",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (degree, radian).",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A).",
"enum": [
"pA",
"nA",
"uA",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m).",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_Acquisition_Main.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes the entire acquisition process during an SEM_FIB_Tomography measurement. The acquisition comprises of multiple datasets which are described using the schema located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json. The images in each dataset is taken using a detector (SE, BSE, EDS, EBSD) using a specific configuration. Each image is described by the schema located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json. The units are by default to be considered as the SI units unless otherwise specified",
"properties": {
"acquisition": {
"$ref": "#/$defs/acquisition"
}
},
"required": [
"acquisition"
],
"title": "acquisition_main",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | a630c6dc650ba68cd6c85f4608ef178b9a85c110 | 2023-11-24T15:29:33 | SEM-FIB_Tomography/SEM_FIB_Tomography_Acquisition_Main.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"acquisition": {
"additionalProperties": false,
"description": "The entry level is the root element of the schema. It contains all the metadata describing an acquisition as part of an SEM/FIB Tomography measurement which might include multiple detectors.",
"properties": {
"dataset": {
"description": "Array of all the dataset-metadata acquired using multiple detetors",
"items": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json"
},
"type": "array"
},
"genericMetadata": {
"additionalProperties": false,
"description": "Describes all the generic metadata common to the acquisition",
"properties": {
"ESEM": {
"description": "To be set to true if environmental SEM is used",
"type": "boolean"
},
"angleToEBeam": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - angle between e-beam and i-beam defined separately as angleDetails (Allowed units: degree, radian). It is specified by the manufacturer and a property of the geometry of the instrument."
},
"applicationID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Details concerning the program (or software) used for aquisition"
},
"column": {
"description": "The name of the column used in the instrument",
"type": "string"
},
"eucentricWorkingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "The Working Distance when the smaple is at the eucentric height"
},
"fileVersion": {
"description": "The file version of the measurement data of the project",
"type": "string"
},
"millingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "The total height of the area which is cut into slices in the z dimension. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003"
},
"millingLocationDepth": {
"$ref": "#/$defs/distanceDetails",
"description": "The total width of the area which is cut into slices in the y dimension"
},
"millingLocationHeight": {
"$ref": "#/$defs/distanceDetails",
"description": "The total height of the area which is cut into slices in the z dimension"
},
"millingLocationWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "The total width of the area which is cut into slices in the x dimension"
},
"millingLocationX": {
"$ref": "#/$defs/distanceDetails",
"description": "X coordinate begin of the milling location from the origin."
},
"millingLocationY": {
"$ref": "#/$defs/distanceDetails",
"description": "Y coordinate of the begin of the milling location from the origin."
},
"millingMaterial": {
"description": "Material which is milled",
"type": "string"
},
"numberOfCuts": {
"description": "The number of slices into which the sample is cut during the course of the SEM/FIB Tomography",
"type": "number"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Optional)- Details concerning the program (or software) used for aquisition"
},
"projectDescription": {
"description": "Description about the project containing the acquistion datasets",
"type": "string"
},
"projectID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Details concerning the program (or software) used for aquisition"
},
"projectName": {
"description": "The name of the project containing the acquistion datasets",
"type": "string"
},
"pump": {
"description": "The name of the pump used in the instrument",
"type": "string"
},
"source": {
"description": "The type of the source used in the instrument. The source is a physical part of an electron or ion microscope from which the particles that form the beam are emitted. IRI: https://purls.helmholtz-metadaten.de/EMG/00000021",
"type": "string"
},
"stage": {
"description": "The dimensions of the stage used in the instrument",
"type": "string"
},
"systemType": {
"description": "Describes the system type used - the name of the instrument",
"type": "string"
},
"userDescription": {
"description": "Additional description provided by the user about the measurement or the sample",
"type": "string"
},
"zCutSpacing": {
"$ref": "#/$defs/distanceDetails",
"description": "The spacing between individual slices in z dimension"
}
},
"required": [
"angleToEBeam",
"zCutSpacing",
"projectName",
"applicationID",
"program"
],
"type": "object"
}
},
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "degree",
"description": "(Optional) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "pA",
"description": "(Optional) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string",
"enum": [
"pA",
"nA",
"uA",
"mA",
"A"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Optional) - Further notes about the value of datatype string",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_Acquisition_Main.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes the entire acquisition process during an SEM_FIB_Tomography measurement. The acquisition comprises of multiple datasets which are described using the schema located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json. The images in each dataset is taken using a detector (SE, BSE, EDS, EBSD) using a specific configuration. Each image is described by the schema located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json. The units are by default to be considred as the SI units unless otherwise specified",
"properties": {
"acquisition": {
"$ref": "#/$defs/acquisition"
}
},
"required": [
"acquisition"
],
"title": "acquisition_main",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 3efafa1dcae624876fa35d0ab1990ad04780fc32 | 2024-03-05T21:39:17 | SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Unit) - the unit of the value to be selected from a controlled list (degree, radian).",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A).",
"enum": [
"pA",
"nA",
"uA",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"detectorDetails": {
"additionalProperties": false,
"description": "(Required) - describes the settings related to the detector with which the image set is acquired",
"properties": {
"detectorSettings": {
"$ref": "#/$defs/detectorSettings",
"description": "(Optional) - Settings of the specific detector used. E.g., the Everhart Thornley detector (ETD), is a secondary electron and back-scattered electron detector used in scanning electron microscopes, whihc has then particular settings"
},
"detectorType": {
"description": "(Required) - Type of the detector used",
"enum": [
"ETD",
"CDEM",
"CBS",
"ECD",
"External",
"GBSD",
"GSED",
"ICE",
"LFD",
"LVD",
"LVSED",
"None",
"STEM3",
"STEM3_GMode",
"STEM4",
"T1",
"T2",
"T3",
"TLD"
],
"type": "string"
},
"name": {
"description": "(Optional) - Name of the detector used",
"type": "string"
}
},
"required": [
"detectorType"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "describes the parameters of a detector such as the Everhart Thornley detector (ETD), which is a secondary electron and back-scattered electron detector used in scanning electron microscopes",
"properties": {
"brightness": {
"description": "(Optional) - A number indicating the brightness",
"type": "number"
},
"brightnessdB": {
"description": "(Optional) - Describes the brightness in dB",
"type": "number"
},
"contrast": {
"description": "(Optional) - A number indicating the contrast",
"type": "number"
},
"contrastdB": {
"description": "(Optional) - Describes the contrast in dB",
"type": "number"
},
"enhancedContrast": {
"description": "(Optional) - Describes the enhancement in contrast",
"type": "number"
},
"frontEndVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Bias voltage applied to the front end of the detector "
},
"grid": {
"description": "(Optional) - A number indicating the number of grid elements",
"type": "number"
},
"gridVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage applied to the grid "
},
"minimumDwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Minimum possible dwell time for the detector. IRI: https://purls.helmholtz-metadaten.de/EMG/00000006 "
},
"mix": {
"description": "(Optional) - Signals from different detectors can be overlaid (mixed) and this should, in theory, be the percentage of this detectors contribution to the end result.",
"type": "number"
},
"setting": {
"description": "(Optional) - In case of ETD, this is the bias voltage applied to the detector grid. Note that this block looks different for different detectors. ",
"type": "number"
},
"signal": {
"description": "(Optional) - The signal used for detection",
"enum": [
"SE",
"BSE",
"SI"
],
"type": "string"
}
},
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m).",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"eBeamDetails": {
"additionalProperties": false,
"description": "(Required) - Describes the configuration of the electron beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000007",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The potential difference between anode and cathode. The acceleration voltage adds kinetic energy to the particles of the beam. IRI: https://purls.helmholtz-metadaten.de/EMG/00000001 It is defined separately as voltageDetails, (includes the voltage value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - uV, mv, V, kV, MV)"
},
"apertureSetting": {
"additionalProperties": false,
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size (diameter) of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails."
}
},
"type": "object"
},
"beamCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Electrical current which flows along the beam path. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003 It is defined separately as currentDetails (includes the current value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)."
},
"dynamicFocusIsOn": {
"description": "(Optional) - To bet set true if dynamic focus is on. IRI:https://purls.helmholtz-metadaten.de/emg/00000039",
"type": "boolean"
},
"dynamicWDIsOn": {
"description": "(Optional) - To bet set true if dynamic working distance is on. IRI: https://purls.helmholtz-metadaten.de/EMG/00000026",
"type": "boolean"
},
"horizontalFieldWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual horizontal length scanned on the sample defined separately as distanceDetails."
},
"imageMode": {
"description": "(Optional) - The type of image mode used. Could be a text or number depending on the instrument.",
"type": "string"
},
"lensMode": {
"description": "(Optional) - The type of image mode used",
"enum": [
"Field-Free",
"Immersion",
"EDS"
],
"type": "string"
},
"magnificationCorrection": {
"description": "(Optional) - To bet set true if magnification correction is on",
"type": "boolean"
},
"preTilt ": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Sometimes, pre-tilted holders are used and the pretilt angle must be given in the acquisition software because actual tilt = stage tilt plus pretilt."
},
"scanRotation": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Angle by which beam scanning direction is rotated"
},
"tiltCorrectionAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - If the sample is tilted, the image is compressed in the vertical direction, i.e. the pixels are not isotropic anymore. Tilt correction adapts the line spacing of the scanning to compensate for this. IRI:https://purls.helmholtz-metadaten.de/emg/00000037"
},
"tiltCorrectionIsOn": {
"description": "(Optional) - To bet set true if tilt correction is on. IRI:https://purls.helmholtz-metadaten.de/emg/00000037",
"type": "boolean"
},
"verticalFieldWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual vertical length scanned on the sample defined separately as distanceDetails."
}
},
"required": [
"accelerationVoltage",
"verticalFieldWidth",
"horizontalFieldWidth",
"apertureSetting",
"scanRotation"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (nJ, mJ, J, kJ, eV, meV).",
"enum": [
"nJ",
"mJ",
"J",
"kJ",
"eV",
"meV"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"hotStageMEMSDetails": {
"additionalProperties": false,
"description": "describes the parameters related if a hot stage MEMS is used",
"properties": {
"actualTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Describes the actual Temperature measured in the hot stage MEMS"
},
"heatingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Describes the heating current used in the hot stage MEMS"
},
"heatingPower": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Describes the heating power used in the hot stage MEMS"
},
"heatingVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Describes the heating voltage used in the hot stage MEMS"
},
"sampleBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Describes the bias voltage applied to the sample in the hot stage MEMS"
},
"sampleResistance": {
"$ref": "#/$defs/resistanceDetails",
"description": "(Optional) - Describes the target Temperature used in the hot stage MEMS"
},
"targetTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Describes the target Temperature set in the hot stage MEMS"
}
},
"type": "object"
},
"iBeamDetails": {
"additionalProperties": false,
"description": "(Required) - Describes the configuration of the ion beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000016",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The potential difference between anode and cathode. The acceleration voltage adds kinetic energy to the particles of the beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000001 It is defined separately as voltageDetails, (includes the voltage value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - uV, mv, V, kV, MV)"
},
"millingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Electrical current used in SEM-FIB Tomography to mill/cut the sample. In this case this is the same as the beam current of the ion beam. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003 It is defined separately as currentDetails (includes the current value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)."
}
},
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"imageDetails": {
"additionalProperties": false,
"description": "(Required) - describes the settings related to imaging",
"properties": {
"digitalBrightness": {
"description": "(Required) - A number indicating the setting for digital brightness (a basic post-processing method)",
"type": "number"
},
"digitalContrast": {
"description": "(Required) - A number indicating the setting for digital contrast (a basic post-processing method)",
"type": "number"
},
"digitalGamma": {
"description": "(Required) - A number indicating the setting for digital Gamma (a basic post-processing method)",
"type": "number"
},
"driftcorrected": {
"description": "(Required) - To bet set true if drift correction is on",
"type": "boolean"
},
"numberOfPixels": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The number of x, y pixels of the image (Resolution), defined separately as pixelNumberType with separate entries for integer values of xPixels and yPixels"
},
"postprocessing": {
"description": "(Optional) - Describes the post-processing performed on the image",
"type": "string"
},
"transformation": {
"description": "(Optional) - Describes the transformations performed on the image",
"type": "string"
},
"zoomfactor": {
"description": "(Required) - A number indicating the zoom factor",
"type": "number"
}
},
"required": [
"digitalContrast",
"digitalBrightness",
"digitalGamma",
"numberOfPixels",
"driftcorrected",
"zoomfactor"
],
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"beamType": {
"description": "(Required) - The selected beam",
"enum": [
"EBeam",
"IBeam"
],
"type": "string"
},
"detector": {
"oneOf": [
{
"$ref": "#/$defs/detectorDetails",
"description": "(Required) - Details about the detector used for acquisition."
},
{
"description": "(Required) - Details about the detector(s) used for acquisition.",
"items": {
"$ref": "#/$defs/detectorDetails"
},
"minItems": 1,
"type": "array"
}
]
},
"eBeam": {
"$ref": "#/$defs/eBeamDetails",
"description": "(Optional - Details about the electron beam"
},
"hotStageMEMS": {
"$ref": "#/$defs/hotStageMEMSDetails",
"description": "(Optional) - Pressure maintained inside the chamber (in which the sample is housed) during the measurement"
},
"iBeam": {
"$ref": "#/$defs/iBeamDetails",
"description": "(Optional) - Details about the ion beam"
},
"imaging": {
"$ref": "#/$defs/imageDetails",
"description": "(Optional) - Details about the imaging settings"
},
"numberOfDetectors": {
"description": "Number of detectors used for the acquisition",
"type": "number"
},
"scan": {
"$ref": "#/$defs/scanDetails",
"description": "(Required) - Details about the scan settings"
},
"spot": {
"description": "(Optional) - Qualitative index for beam current. Varies with current setting, i.e. 1.6 nA is spot = 1, 3.2 nA is spot = 2, 0.1 nA = spot =-3, so it can also be negative. May vary between different microscope models.",
"type": "number"
}
},
"required": [
"scan",
"imaging",
"detector"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes the resolution of the image split into number of pixels in x and y directions.",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "describes a power",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (\u00b5W, mW, W, kW, MW).",
"enum": [
"\u00b5W",
"mW",
"W",
"kW",
"MW"
],
"type": "string"
},
"value": {
"description": "(Required) - The power expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi).",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"resistanceDetails": {
"additionalProperties": false,
"description": "describes a resistance",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (abohm, ohm, k ohm, M ohm).",
"enum": [
"abohm",
"ohm",
"k ohm",
"M ohm"
],
"type": "string"
},
"value": {
"description": "(Required) - The resistance expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"scanDetails": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scan settings.",
"properties": {
"average": {
"description": "(Optional) - Number of images averaged at each slice",
"type": "number"
},
"dwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time period during which the beam remains on one position/stationary. IRI: https://purls.helmholtz-metadaten.de/EMG/00000006 "
},
"eScan": {
"additionalProperties": false,
"description": "gives settings pertaining to electron beam scan",
"properties": {
"lineAveraging": {
"description": "(Optional) - Number of lines averaged",
"type": "number"
},
"lineIntegration": {
"description": "(Optional) - Number of lines integrated",
"type": "number"
},
"lineTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) -Time period during which a line is fully scanned."
},
"mainsLock": {
"description": "(Optional) - To bet set true if mains lock is on",
"type": "boolean"
},
"scanInterlacing": {
"description": "(Optional) - Number of scans interlaced. This setting splits an imaging area into blocks defined by the number of lines (from 2 to 8). In the first instance, the first line of each block is scanned, then the second one, etc. This imaging method significantly reduces charging.",
"type": "number"
}
},
"type": "object"
},
"frameTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) -Time period during which a frame is fully scanned. IRI: https://purls.helmholtz-metadaten.de/EMG/00000014 "
},
"horizontalFieldSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the actual horizontal length scanned on the sample defined separately as distanceDetails"
},
"integrate": {
"description": "(Optional) - Number of images integrated at each slice",
"type": "number"
},
"internalScan": {
"description": "(Optional) - To bet set true if internal scan is on",
"type": "boolean"
},
"pixelHeight": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual width of a pixel"
},
"pixelWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual width of a pixel"
},
"scanType": {
"description": "(Optional) - The type of scan E-Scan or I-Scan",
"enum": [
"EScan",
"IScan"
],
"type": "string"
},
"verticalFieldSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the actual vertical length scanned on the sample defined separately as distanceDetails"
}
},
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF).",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time period. IRI:https://purls.helmholtz-metadaten.de/EMG/00000024",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (ps, ns, us, ms, s).",
"enum": [
"ps",
"ns",
"us",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (uV, mV, V, kV, MV, GV).",
"enum": [
"uV",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes a set of images acquired during the course of a SEM/FIB Tomography experiment. The images in each dataset is taken using a detector (SE, BSE, EDS, EBSD) using a specific configuration. This Schema contains only the parameters which are specific to the entire dataset. The parameters which are particular to each image is located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json. The units are by default to be considred as the SI units unless otherwise specified",
"properties": {
"columns": {
"description": "(Optional) - Number of column in the tiled image grab setting",
"type": "number"
},
"datasetType": {
"description": "(Optional) - To be selected from the enumerated list depending on the detector and the angle at which the sample is measured: * SEM Image * SEM Image 2 * EDS * EBSD * BSE * ISE * ISI * SI * InLens * SESI",
"enum": [
"SEM Image",
"SEM Image 2",
"SEM Image 3",
"SEM Image 4",
"SEM Image 5",
"EDS",
"EBSD",
"BSE",
"ISE Image",
"ISI Image",
"SI Image",
"InLens",
"SESI",
"FIB Image",
"FIB Multi-Detector Image-Q1",
"FIB Multi-Detector Image-Q2",
"SEM Multi-Detector Image-Q1",
"SEM Multi-Detector Image-Q2"
],
"type": "string"
},
"definition": {
"description": "(Optional)- Name of the schema to which this entry conforms. In this case, acquisition_dataset is to be written",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Identifier of the dataset. It could be the PID of location where the entire dataset is stored"
},
"images": {
"desription": "(Required) - Array containing the images and their specific parameters. No. of images in the array is described by the numberOfItems parameter at the entry level of this schema",
"items": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json"
},
"type": "array"
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings"
},
"numberOfItems": {
"description": "(Required) - Number of Items (images, files). Depends on the number of slices",
"type": "number"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required)- Details concerning the program (or software) used for aquisition"
},
"rows": {
"description": "(Optional) - Number of rows in the tiled image grab setting",
"type": "number"
},
"tileColumn": {
"description": "(Optional) - The selected column in the tiled image grab setting",
"type": "number"
},
"tileRow": {
"description": "(Optional) - The selected row in the tiled image grab setting",
"type": "number"
},
"user": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/user_description.json",
"description": "(Optional)- The contact information of the user responsible for the measurement"
}
},
"required": [
"program",
"instrument",
"datasetType",
"images",
"numberOfItems"
],
"title": "acquisition_dataset",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 42086aeef2e0aa90738045cd0418be08db819893 | 2023-11-27T13:27:32 | SEM-FIB_Tomography/SEM_FIB_Tomography_Acquisition_Main.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"acquisition": {
"additionalProperties": false,
"description": "The entry level is the root element of the schema. It contains all the metadata describing an acquisition as part of an SEM/FIB Tomography measurement which might include multiple detectors.",
"properties": {
"dataset": {
"description": "Array of all the dataset-metadata acquired using multiple detetors",
"items": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json"
},
"type": "array"
},
"genericMetadata": {
"additionalProperties": false,
"description": "Describes all the generic metadata common to the acquisition",
"properties": {
"ESEM": {
"description": "To be set to true if environmental SEM is used",
"type": "boolean"
},
"angleToEBeam": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - angle between e-beam and i-beam defined separately as angleDetails (Allowed units: degree, radian). It is specified by the manufacturer and a property of the geometry of the instrument."
},
"applicationID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Details concerning the program (or software) used for aquisition"
},
"column": {
"description": "The name of the column used in the instrument",
"type": "string"
},
"eucentricWorkingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "The Working Distance when the smaple is at the eucentric height"
},
"fileVersion": {
"description": "The file version of the measurement data of the project",
"type": "string"
},
"millingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "The total height of the area which is cut into slices in the z dimension. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003"
},
"millingLocationDepth": {
"$ref": "#/$defs/distanceDetails",
"description": "The total width of the area which is cut into slices in the y dimension"
},
"millingLocationHeight": {
"$ref": "#/$defs/distanceDetails",
"description": "The total height of the area which is cut into slices in the z dimension"
},
"millingLocationWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "The total width of the area which is cut into slices in the x dimension"
},
"millingLocationX": {
"$ref": "#/$defs/distanceDetails",
"description": "X coordinate begin of the milling location from the origin."
},
"millingLocationY": {
"$ref": "#/$defs/distanceDetails",
"description": "Y coordinate of the begin of the milling location from the origin."
},
"millingMaterial": {
"description": "Material which is milled",
"type": "string"
},
"numberOfCuts": {
"description": "The number of slices into which the sample is cut during the course of the SEM/FIB Tomography",
"type": "number"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Optional)- Details concerning the program (or software) used for aquisition"
},
"projectDescription": {
"description": "Description about the project containing the acquistion datasets",
"type": "string"
},
"projectID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Details concerning the program (or software) used for aquisition"
},
"projectName": {
"description": "The name of the project containing the acquistion datasets",
"type": "string"
},
"pump": {
"description": "The name of the pump used in the instrument",
"type": "string"
},
"source": {
"description": "The type of the source used in the instrument. The source is a physical part of an electron or ion microscope from which the particles that form the beam are emitted. IRI: https://purls.helmholtz-metadaten.de/EMG/00000021",
"type": "string"
},
"stage": {
"description": "The dimensions of the stage used in the instrument",
"type": "string"
},
"systemType": {
"description": "Describes the system type used - the name of the instrument",
"type": "string"
},
"userDescription": {
"description": "Additional description provided by the user about the measurement or the sample",
"type": "string"
},
"zCutSpacing": {
"$ref": "#/$defs/distanceDetails",
"description": "The spacing between individual slices in z dimension"
}
},
"required": [
"angleToEBeam",
"zCutSpacing",
"projectName",
"applicationID",
"program"
],
"type": "object"
}
},
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "degree",
"description": "(Optional) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "pA",
"description": "(Optional) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string",
"enum": [
"pA",
"nA",
"uA",
"mA",
"A"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Optional) - Further notes about the value of datatype string",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_Acquisition_Main.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes the entire acquisition process during an SEM_FIB_Tomography measurement. The acquisition comprises of multiple datasets which are described using the schema located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json. The images in each dataset is taken using a detector (SE, BSE, EDS, EBSD) using a specific configuration. Each image is described by the schema located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json. The units are by default to be considered as the SI units unless otherwise specified",
"properties": {
"acquisition": {
"$ref": "#/$defs/acquisition"
}
},
"required": [
"acquisition"
],
"title": "acquisition_main",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | dc83d55d23cc448877a0a9eb2a7ea23d4957be93 | 2024-02-26T12:40:52 | SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"angleDetails": {
"additionalProperties": false,
"description": "Describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (degree, radian).",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (pA, nA, \u00b5A, mA, A).",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the current.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m).",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi).",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"stage": {
"additionalProperties": false,
"description": "Describes the stage.",
"properties": {
"activeStage": {
"description": "(Required)- Describes the stage in use",
"type": "string"
},
"specTilt": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional)- Pretilt of the sample, usually due to pretilted holder."
},
"stageM": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional)- M coordinate of the position of the stage (additional translation axis available in Zeiss instruments)"
},
"stageR": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Angle by which the stage is rotated"
},
"stageTa": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Tilt angle alpha of the stage"
},
"stageTb": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Tilt angle beta of the stage"
},
"stageX": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- X coordinate of the position of the stage"
},
"stageY": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Y coordinate of the position of the stage"
},
"stageZ": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Z coordinate of the position of the stage"
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. IRI: https://purls.helmholtz-metadaten.de/EMG/00000026"
}
},
"required": [
"workingDistance",
"stageX",
"stageY",
"stageZ",
"stageR",
"stageTa",
"stageTb",
"activeStage"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF).",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"vacuum": {
"additionalProperties": false,
"description": "Describes the vacuum maintained in the system.",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- The pressure maintained in the electron chamber"
},
"gas": {
"description": "(Required)- The gas used in the electron chamber",
"type": "string"
},
"humidity": {
"description": "(Required)- Describes the humidity in the chamber during the measurement",
"type": "string"
},
"userMode": {
"description": "(Required)- The type of vacuum slected by the user",
"enum": [
"High vacuum",
"Medium vacuum",
"Low vacuum"
],
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes an individual image acquired during the course of a SEM/FIB Tomography experiment. Each image is taken using a detector (SE, BSE, EDS, EBSD) at each slice cut using FIB. This Schema contains only the parameters which are specific to the individual image. The parameters which are common to the entire set are described by another schema which describes the dataset as a whole and is located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json.",
"properties": {
"creationTime": {
"description": "(Required)- Time of creation of the image",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z?)$",
"type": "string"
},
"definition": {
"description": "(Optional)- Name of the schema to which this entry conforms. In this case, acquisition_image should be written",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Identifier of the image produced by the machine"
},
"fileLink": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Link to the location of the image"
},
"fileName": {
"description": "(Optional)- File name of the image",
"type": "string"
},
"specimenCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional)- Current measured on the specimen during acquisition of the image"
},
"stage": {
"$ref": "#/$defs/stage",
"description": "(Required)- Details concerning stage settings used for aquisition"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional)- Temperature of the sample during acquisition"
},
"vacuum": {
"$ref": "#/$defs/vacuum",
"description": "(Required)- Details concerning the vacuum during aquisition"
}
},
"required": [
"creationTime",
"stage",
"vacuum"
],
"title": "acquisition_image",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 6a6a1a232795c9b88a3cc2c47258040cae2fc0a1 | 2023-06-06T09:04:56 | Reference_Dataset_Zenodo/pp18_file_schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$id": "https://github.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/blob/faeeb3856a267e10bd94c904a5e763ba3ad1e9fe/Reference_Dataset_Zenodo/pp18_file_schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes the metadata of a single file in the reference dataset by BAM. It contains the metadata of the results of ASTM E139 -11 creep tests on a reference material of Nimonic 75 nickel-base alloy",
"properties": {
"bucket": {
"description": "(Required) - string indicating the dataset in which the document is contained",
"type": "string"
},
"checksum": {
"description": "(Required) - checksum of the document",
"type": "string"
},
"key": {
"description": "(Required) - key of the document (File name)",
"type": "string"
},
"links": {
"properties": {
"self": {
"description": "(Required) - URL/ link to the document",
"type": "string"
}
},
"required": [
"self"
],
"type": "object"
},
"size": {
"description": "(Required) - Size of the document in bytes",
"type": "number"
},
"type": {
"description": "(Required) - File type of the document",
"type": "string"
}
},
"required": [
"links",
"checksum",
"bucket",
"key",
"type",
"size"
],
"title": "Metadata of BAM reference data (individual files): results of ASTM E139 -11 creep tests on a reference material of Nimonic 75 nickel-base alloy",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | f16cf99ae75177cd676c9fd0c1740fd5cead39a5 | 2023-06-06T10:13:23 | Reference_Dataset_Zenodo/pp18_file_schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$id": "https://github.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/blob/faeeb3856a267e10bd94c904a5e763ba3ad1e9fe/Reference_Dataset_Zenodo/pp18_file_schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes the metadata of a single file in the reference dataset by BAM on Zenodo",
"properties": {
"bucket": {
"description": "(Required) - string indicating the dataset in which the document is contained",
"type": "string"
},
"checksum": {
"description": "(Required) - checksum of the document",
"type": "string"
},
"key": {
"description": "(Required) - key of the document (File name)",
"type": "string"
},
"links": {
"properties": {
"self": {
"description": "(Required) - URL/ link to the document",
"type": "string"
}
},
"required": [
"self"
],
"type": "object"
},
"size": {
"description": "(Required) - Size of the document in bytes",
"type": "number"
},
"type": {
"description": "(Required) - File type of the document",
"type": "string"
}
},
"required": [
"links",
"checksum",
"bucket",
"key",
"type",
"size"
],
"title": "Metadata Schema of BAM reference data (individual files)",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | e443a6e0079f61bbf49f6eb83fd631f120894eb8 | 2023-11-24T16:53:38 | SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "degree",
"description": "(Unit) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "pA",
"description": "(Optional) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string",
"enum": [
"pA",
"nA",
"uA",
"mA",
"A"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Optional) - Further notes about the value of datatype string",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"detectorDetails": {
"additionalProperties": false,
"description": "(Required) - describes the settings related to the detector with which the image set is acquired",
"properties": {
"detectorSettings": {
"$ref": "#/$defs/detectorSettings",
"description": "(Required) - Settings of the specific detector used. E.g., the Everhart Thornley detector (ETD), is a secondary electron and back-scattered electron detector used in scanning electron microscopes, whihc has then particular settings"
},
"detectorType": {
"description": "(Required) - Type of the detector used",
"enum": [
"ETD",
"CDEM",
"CBS",
"ECD",
"External",
"GBSD",
"GSED",
"ICE",
"LFD",
"LVD",
"LVSED",
"None",
"STEM3",
"STEM3_GMode",
"STEM4",
"T1",
"T2",
"T3",
"TLD"
],
"type": "string"
},
"name": {
"description": "(Optional) - Name of the detector used",
"type": "string"
}
},
"required": [
"detectorType"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "describes the parameters of a detector such as the Everhart Thornley detector (ETD), which is a secondary electron and back-scattered electron detector used in scanning electron microscopes",
"properties": {
"brightness": {
"description": "(Optional) - A number indicating the brightness",
"type": "number"
},
"brightnessdB": {
"description": "(Optional) - Describes the brightness in dB",
"type": "number"
},
"contrast": {
"description": "(Optional) - A number indicating the contrast",
"type": "number"
},
"contrastdB": {
"description": "(Optional) - Describes the contrast in dB",
"type": "number"
},
"enhancedContrast": {
"description": "(Optional) - Describes the enhancement in contrast",
"type": "number"
},
"frontEndVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Bias voltage applied to the front end of the detector "
},
"grid": {
"description": "(Optional) - A number indicating the number of grid elements",
"type": "number"
},
"gridVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage applied to the grid "
},
"minimumDwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Minimum possible dwell time for the detector. IRI: https://purls.helmholtz-metadaten.de/EMG/00000006 "
},
"mix": {
"description": "(Optional) - Signals from different detectors can be overlaid (mixed) and this should, in theory, be the percentage of this detectors contribution to the end result.",
"type": "number"
},
"setting": {
"description": "(Optional) - In case of ETD, this is the bias voltage applied to the detector grid. Note that this block looks different for different detectors. ",
"type": "number"
},
"signal": {
"description": "(Optional) - The signal used for detection",
"enum": [
"SE",
"BSE",
"SI"
],
"type": "string"
}
},
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"eBeamDetails": {
"additionalProperties": false,
"description": "(Required) - Describes the configuration of the electron beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000007",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The potential difference between anode and cathode. The acceleration voltage adds kinetic energy to the particles of the beam. IRI: https://purls.helmholtz-metadaten.de/EMG/00000001 It is defined separately as voltageDetails, (includes the voltage value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - uV, mv, V, kV, MV)"
},
"apertureSetting": {
"additionalProperties": false,
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size (diameter) of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails."
}
},
"type": "object"
},
"beamCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Electrical current which flows along the beam path. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003 It is defined separately as currentDetails (includes the current value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)."
},
"dynamicFocusIsOn": {
"description": "(Optional) - To bet set true if dynamic focus is on. IRI:https://purls.helmholtz-metadaten.de/emg/00000039",
"type": "boolean"
},
"dynamicWDIsOn": {
"description": "(Optional) - To bet set true if dynamic working distance is on. IRI: https://purls.helmholtz-metadaten.de/EMG/00000026",
"type": "boolean"
},
"horizontalFieldWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual horizontal length scanned on the sample defined separately as distanceDetails."
},
"imageMode": {
"description": "(Optional) - The type of image mode used. Could be a text or number depending on the instrument.",
"type": "string"
},
"lensMode": {
"description": "(Optional) - The type of image mode used",
"enum": [
"Field-Free",
"Immersion",
"EDS"
],
"type": "string"
},
"magnificationCorrection": {
"description": "(Optional) - To bet set true if magnification correction is on",
"type": "boolean"
},
"preTilt ": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Sometimes, pre-tilted holders are used and the pretilt angle must be given in the acquisition software because actual tilt = stage tilt plus pretilt."
},
"scanRotation": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Angle by which beam scanning direction is rotated"
},
"tiltCorrectionAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - If the sample is tilted, the image is compressed in the vertical direction, i.e. the pixels are not isotropic anymore. Tilt correction adapts the line spacing of the scanning to compensate for this. IRI:https://purls.helmholtz-metadaten.de/emg/00000037"
},
"tiltCorrectionIsOn": {
"description": "(Optional) - To bet set true if tilt correction is on. IRI:https://purls.helmholtz-metadaten.de/emg/00000037",
"type": "boolean"
},
"verticalFieldWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual vertical length scanned on the sample defined separately as distanceDetails."
}
},
"required": [
"accelerationVoltage",
"verticalFieldWidth",
"horizontalFieldWidth",
"apertureSetting",
"scanRotation"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "J",
"description": "(Optional) - the unit of the value to be selected from a controlled list (nJ, mJ, J, kJ, eV, meV default value - J) of datatype string",
"enum": [
"nJ",
"mJ",
"J",
"kJ",
"eV",
"meV"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"hotStageMEMSDetails": {
"additionalProperties": false,
"description": "describes the parameters related if a hot stage MEMS is used",
"properties": {
"actualTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Describes the actual Temperature measured in the hot stage MEMS"
},
"heatingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Describes the heating current used in the hot stage MEMS"
},
"heatingPower": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Describes the heating power used in the hot stage MEMS"
},
"heatingVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Describes the heating voltage used in the hot stage MEMS"
},
"sampleBias": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Describes the bias voltage applied to the sample in the hot stage MEMS"
},
"sampleResistance": {
"$ref": "#/$defs/resistanceDetails",
"description": "(Optional) - Describes the target Temperature used in the hot stage MEMS"
},
"targetTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Describes the target Temperature set in the hot stage MEMS"
}
},
"type": "object"
},
"iBeamDetails": {
"additionalProperties": false,
"description": "(Required) - Describes the configuration of the ion beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000016",
"properties": {
"accelerationVoltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - The potential difference between anode and cathode. The acceleration voltage adds kinetic energy to the particles of the beam. IRI:https://purls.helmholtz-metadaten.de/EMG/00000001 It is defined separately as voltageDetails, (includes the voltage value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - uV, mv, V, kV, MV)"
},
"millingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Electrical current used in SEM-FIB Tomography to mill/cut the sample. In this case this is the same as the beam current of the ion beam. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003 It is defined separately as currentDetails (includes the current value, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)."
}
},
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"imageDetails": {
"additionalProperties": false,
"description": "(Required) - describes the settings related to imaging",
"properties": {
"digitalBrightness": {
"description": "(Required) - A number indicating the setting for digital brightness (a basic post-processing method)",
"type": "number"
},
"digitalContrast": {
"description": "(Required) - A number indicating the setting for digital contrast (a basic post-processing method)",
"type": "number"
},
"digitalGamma": {
"description": "(Required) - A number indicating the setting for digital Gamma (a basic post-processing method)",
"type": "number"
},
"driftcorrected": {
"description": "(Required) - To bet set true if drift correction is on",
"type": "boolean"
},
"numberOfPixels": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The number of x, y pixels of the image (Resolution), defined separately as pixelNumberType with separate entries for integer values of xPixels and yPixels"
},
"postprocessing": {
"description": "(Optional) - Describes the post-processing performed on the image",
"type": "string"
},
"transformation": {
"description": "(Optional) - Describes the transformations performed on the image",
"type": "string"
},
"zoomfactor": {
"description": "(Required) - A number indicating the zoom factor",
"type": "number"
}
},
"required": [
"digitalContrast",
"digitalBrightness",
"digitalGamma",
"numberOfPixels",
"driftcorrected",
"zoomfactor"
],
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"beamType": {
"description": "(Required) - The selected beam",
"enum": [
"EBeam",
"IBeam"
],
"type": "string"
},
"detector": {
"oneOf": [
{
"$ref": "#/$defs/detectorDetails",
"description": "(Required) - Details about the detector used for acquisition."
},
{
"description": "(Required) - Details about the detector(s) used for acquisition.",
"items": {
"$ref": "#/$defs/detectorDetails"
},
"minItems": 1,
"type": "array"
}
]
},
"eBeam": {
"$ref": "#/$defs/eBeamDetails",
"description": "(Required) - Details about the electron beam"
},
"hotStageMEMS": {
"$ref": "#/$defs/hotStageMEMSDetails",
"description": "(Optional) - Pressure maintained inside the chamber (in which the sample is housed) during the measurement"
},
"iBeam": {
"$ref": "#/$defs/iBeamDetails",
"description": "(Required) - Details about the ion beam"
},
"imaging": {
"$ref": "#/$defs/imageDetails",
"description": "(Optional) - Details about the imaging settings"
},
"numberOfDetectors": {
"description": "Number of detectors used for the acquisition",
"type": "number"
},
"scan": {
"$ref": "#/$defs/scanDetails",
"description": "(Required) - Details about the scan settings"
},
"spot": {
"description": "(Optional) - Qualitative index for beam current. Varies with current setting, i.e. 1.6 nA is spot = 1, 3.2 nA is spot = 2, 0.1 nA = spot =-3, so it can also be negative. May vary between different microscope models.",
"type": "number"
}
},
"required": [
"eBeam",
"scan",
"imaging",
"detector"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes the resolution of the image split into number of pixels in x and y directions.",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "describes a power",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "W",
"description": "(Optional) - the unit of the value to be selected from a controlled list (\u00b5W, mW, W, kW, MW default value - W) of datatype string",
"enum": [
"\u00b5W",
"mW",
"W",
"kW",
"MW"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The power expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "Pa",
"description": "(Optional) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"resistanceDetails": {
"additionalProperties": false,
"description": "describes a resistance",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "ohm",
"description": "(Optional) - the unit of the value to be selected from a controlled list (abohm, ohm, k ohm, M ohm default value - ohm) of datatype string; default unit is ohm",
"enum": [
"abohm",
"ohm",
"k ohm",
"M ohm"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The resistance expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"scanDetails": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scan settings.",
"properties": {
"average": {
"description": "(Optional) - Number of images averaged at each slice",
"type": "number"
},
"dwellTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time period during which the beam remains on one position/stationary. IRI: https://purls.helmholtz-metadaten.de/EMG/00000006 "
},
"eScan": {
"additionalProperties": false,
"description": "gives settings pertaining to electron beam scan",
"properties": {
"lineAveraging": {
"description": "(Optional) - Number of lines averaged",
"type": "number"
},
"lineIntegration": {
"description": "(Optional) - Number of lines integrated",
"type": "number"
},
"lineTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) -Time period during which a line is fully scanned."
},
"mainsLock": {
"description": "(Optional) - To bet set true if mains lock is on",
"type": "boolean"
},
"scanInterlacing": {
"description": "(Optional) - Number of scans interlaced. This setting splits an imaging area into blocks defined by the number of lines (from 2 to 8). In the first instance, the first line of each block is scanned, then the second one, etc. This imaging method significantly reduces charging.",
"type": "number"
}
},
"type": "object"
},
"frameTime": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) -Time period during which a frame is fully scanned. IRI: https://purls.helmholtz-metadaten.de/EMG/00000014 "
},
"horizontalFieldSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the actual horizontal length scanned on the sample defined separately as distanceDetails"
},
"integrate": {
"description": "(Optional) - Number of images integrated at each slice",
"type": "number"
},
"internalScan": {
"description": "(Optional) - To bet set true if internal scan is on",
"type": "boolean"
},
"pixelHeight": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual width of a pixel"
},
"pixelWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - the actual width of a pixel"
},
"scanType": {
"description": "(Optional) - The type of scan E-Scan or I-Scan",
"enum": [
"EScan",
"IScan"
],
"type": "string"
},
"verticalFieldSize": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the actual vertical length scanned on the sample defined separately as distanceDetails"
}
},
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time period. IRI:https://purls.helmholtz-metadaten.de/EMG/00000024",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "us",
"description": "(Optional) - the unit of the value to be selected from a controlled list (ps, ns, us, ms, s default value - us) of datatype string",
"enum": [
"ps",
"ns",
"us",
"ms",
"s"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"user": {
"description": "Contact information of the user responsible for the measurement.",
"properties": {
"ORCID": {
"description": "(Optional) - Open Researcher and Contributor ID expressed as a URI",
"pattern": "^https://orcid\\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[X0-9]{1}$",
"type": "string"
},
"affiliation": {
"description": "(Optional) - Details of the institution to which the user is affiliated",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"description": "(Optional) -Identifier of the institution to which the user is affiliated",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be chosen from a controlled list of values (*ROR *GRID *ISNI *URL *DOI *Handle)",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"email": {
"description": "(Optional) - Email of the user",
"format": "email",
"type": "string"
},
"familyName": {
"description": "(Optional) - Family name of the user",
"type": "string"
},
"givenName": {
"description": "(Optional) - Given name of the user",
"type": "string"
},
"role": {
"description": "(Optional) - Role of the user to be selected from: *Data Curator *Instrument Scientist *Team Leader *Team Member",
"enum": [
"Data Curator",
"Instrument Scientist",
"Team Leader",
"Team Member"
],
"type": "string"
},
"userName": {
"description": "(Required) - Full name of the user recommended in the format (Family Name, Given Name)",
"type": "string"
}
},
"required": [
"userName"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "kV",
"description": "(Optional) - the unit of the value to be selected from a controlled list (uV, mV, V, kV, MV, GV default value - V) of datatype string",
"enum": [
"uV",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The voltage expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes a set of images acquired during the course of a SEM/FIB Tomography experiment. The images in each dataset is taken using a detector (SE, BSE, EDS, EBSD) using a specific configuration. This Schema contains only the parameters which are specific to the entire dataset. The parameters which are particular to each image is located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json. The units are by default to be considred as the SI units unless otherwise specified",
"properties": {
"columns": {
"description": "(Optional) - Number of column in the tiled image grab setting",
"type": "number"
},
"datasetType": {
"default": "SEM",
"description": "(Optional) - To be selected from the enumerated list depending on the detector and the angle at which the sample is measured: * SEM Image * SEM Image 2 * EDS * EBSD * BSE * ISE * ISI * SI * InLens * SESI",
"enum": [
"SEM Image",
"SEM Image 2",
"SEM Image 3",
"SEM Image 4",
"SEM Image 5",
"EDS",
"EBSD",
"BSE",
"ISE Image",
"ISI Image",
"SI Image",
"InLens",
"SESI"
],
"type": "string"
},
"definition": {
"description": "(Optional)- Name of the schema to which this entry conforms. In this case, acquisition_dataset is to be written",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Identifier of the dataset. It could be the PID of location where the entire dataset is stored"
},
"images": {
"desription": "(Required) - Array containing the images and their specific parameters. No. of images in the array is described by the numberOfItems parameter at the entry level of this schema",
"items": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json"
},
"type": "array"
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings"
},
"numberOfItems": {
"description": "(Required) - Number of Items (images, files). Depends on the number of slices",
"type": "number"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required)- Details concerning the program (or software) used for aquisition"
},
"rows": {
"description": "(Optional) - Number of rows in the tiled image grab setting",
"type": "number"
},
"tileColumn": {
"description": "(Optional) - The selected column in the tiled image grab setting",
"type": "number"
},
"tileRow": {
"description": "(Optional) - The selected row in the tiled image grab setting",
"type": "number"
},
"user": {
"$ref": "#/$defs/user",
"description": "(Optional)- The contact information of the user responsible for the measurement"
}
},
"required": [
"program",
"instrument",
"datasetType",
"images",
"numberOfItems"
],
"title": "acquisition_dataset",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 25fb0153a0a3fb35da57208d64d2629ca4fc5d55 | 2024-02-09T12:31:44 | SEM-FIB_Tomography/SEM_FIB_Tomography_Acquisition_Main.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"acquisition": {
"additionalProperties": false,
"description": "The entry level is the root element of the schema. It contains all the metadata describing an acquisition as part of an SEM/FIB Tomography measurement which might include multiple detectors.",
"properties": {
"dataset": {
"description": "Array of all the dataset-metadata acquired using multiple detectors",
"items": {
"$ref": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json"
},
"type": "array"
},
"genericMetadata": {
"additionalProperties": false,
"description": "Describes all the generic metadata common to the acquisition",
"properties": {
"ESEM": {
"description": "To be set to true if environmental SEM is used",
"type": "boolean"
},
"angleToEBeam": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - angle between e-beam and i-beam defined separately as angleDetails (Allowed units: degree, radian). It is specified by the manufacturer and a property of the geometry of the instrument."
},
"applicationID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Details concerning the program (or software) used for aquisition"
},
"column": {
"description": "The name of the column used in the instrument",
"type": "string"
},
"consumables": {
"description": "(Optional) - Auxiliary entity used during Fabrication, Sample Preparation or Measurement which has a limited time capacity or is limited in its number of uses before it is disposed of, necessary to the process itself and normally bought from third party manufacturers. Examples are: gloves, syringes, wipes, etching solutions, glass slides, spatulas, weighing paper, two-sided tape.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"equipment": {
"description": "(Optional) - Any kind of physical or virtual item, device, machine or other tools used to perform one or more Fabrication(s), Sample Preparation(s), Model Preparation(s), Data Acquisition(s) and/or any of the processes included in the Data Analysis Lifecycle. Usually, the Equipment is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. Equipment is usually an investment. According to this definition, an Instrument is a particular type of Equipment.",
"type": "string"
},
"eucentricWorkingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "The Working Distance when the smaple is at the eucentric height"
},
"fileVersion": {
"description": "The file version of the measurement data of the project",
"type": "string"
},
"measurementDescription": {
"description": "(Optional) - Description about the measurement.",
"type": "string"
},
"measurementPurpose": {
"description": "(Required) - Measurement is experimental Data Acquisition, typically performed on a Sample using an experimental Technique. It may also be performed during Fabrication or Sample Preparation, e.g., to characterise the intermediate stages and/or the final resulting Precursor(s) or Sample(s), respectively. A Measurement may require the use of Consumables.",
"enum": [
"assessment (to given categories or values)",
"completeness check (presence or absence of given properties)",
"correlative characterization (dedicated sample treatment to emphasise given features)",
"exploratory (routine check of known properties)",
"feasibility (quick check, rough estimate)",
"high quality measurement (precise, careful treatment)",
"test specific hypothesis (focus only on given aspects)",
"other (please specify in the comment)"
],
"type": "string"
},
"millingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "The total height of the area which is cut into slices in the z dimension. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003"
},
"millingLocationDepth": {
"$ref": "#/$defs/distanceDetails",
"description": "The total width of the area which is cut into slices in the y dimension"
},
"millingLocationHeight": {
"$ref": "#/$defs/distanceDetails",
"description": "The total height of the area which is cut into slices in the z dimension"
},
"millingLocationWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "The total width of the area which is cut into slices in the x dimension"
},
"millingLocationX": {
"$ref": "#/$defs/distanceDetails",
"description": "X coordinate begin of the milling location from the origin."
},
"millingLocationY": {
"$ref": "#/$defs/distanceDetails",
"description": "Y coordinate of the begin of the milling location from the origin."
},
"millingMaterial": {
"description": "Material which is milled",
"type": "string"
},
"numberOfCuts": {
"description": "The number of slices into which the sample is cut during the course of the SEM/FIB Tomography",
"type": "number"
},
"parents": {
"description": "(Required) - Parents of this metadata like the metadata document of the sample with which the measurement was performed.",
"items": {
"if": {
"properties": {
"parentType": {
"not": {
"const": "not applicable"
}
}
}
},
"properties": {
"parentReference": {
"description": "If type is 'MetaStore URI' it is possible to easily fill this field in a later stage",
"format": "uri-reference",
"type": "string"
},
"parentReferenceType": {
"default": "MetaStore URI",
"enum": [
"plain text",
"external URL",
"MetaStore URI"
],
"type": "string"
},
"parentType": {
"default": "sample",
"enum": [
"not applicable",
"sample"
],
"type": "string"
}
},
"required": [
"parentType"
],
"then": {
"required": [
"parentReferenceType",
"parentReference"
]
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Optional)- Details concerning the program (or software) used for aquisition"
},
"projectDescription": {
"description": "Description about the project containing the acquistion datasets",
"type": "string"
},
"projectID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Details concerning the program (or software) used for aquisition"
},
"projectName": {
"description": "The name of the project containing the acquistion datasets",
"type": "string"
},
"pump": {
"description": "The name of the pump used in the instrument",
"type": "string"
},
"source": {
"description": "The type of the source used in the instrument. The source is a physical part of an electron or ion microscope from which the particles that form the beam are emitted. IRI: https://purls.helmholtz-metadaten.de/EMG/00000021",
"type": "string"
},
"stage": {
"description": "The dimensions of the stage used in the instrument",
"type": "string"
},
"systemType": {
"description": "Describes the system type used - the name of the instrument",
"type": "string"
},
"technique": {
"description": "(Required) - Any experimental, theoretical or computational method used during Data Acquisition or during any of the processes included in the Data Analysis Lifecycle to acquire, process or analyse Research Data about a System or a set of them with an Instrument, which is used to generate this metadata.",
"type": "string"
},
"userDescription": {
"description": "Additional description provided by the user about the measurement or the sample",
"type": "string"
},
"zCutSpacing": {
"$ref": "#/$defs/distanceDetails",
"description": "The spacing between individual slices in z dimension"
}
},
"required": [
"angleToEBeam",
"zCutSpacing",
"projectName",
"applicationID",
"program",
"technique",
"measurementPurpose",
"parents"
],
"type": "object"
}
},
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min)",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (degree, radian).",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A).",
"enum": [
"pA",
"nA",
"uA",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m).",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_Acquisition_Main.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes the entire acquisition process during an SEM_FIB_Tomography measurement. The acquisition comprises of multiple datasets which are described using the schema located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json. The images in each dataset is taken using a detector (SE, BSE, EDS, EBSD) using a specific configuration. Each image is described by the schema located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json. The units are by default to be considered as the SI units unless otherwise specified",
"properties": {
"acquisition": {
"$ref": "#/$defs/acquisition"
}
},
"required": [
"acquisition"
],
"title": "acquisition_main",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | e09b1abd17b8df1d17736b068120806174d90ed8 | 2024-02-27T09:47:06 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"CTAquisition": {
"additionalProperties": false,
"description": "(Required) - Details about the acquisition.",
"properties": {
"acquisitionScriptName": {
"description": "(Required) - Name of the script used for acquisition.",
"type": "string"
},
"acquisitionTimePerProjection": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time taken for acquisition of a single projection. Typical unit - s."
},
"angularStepSize": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Step size of the rotation of the sample during the CT. Typical unit - degree."
},
"contrastType": {
"description": "(Required) - The contrast type(mode) used - Absorption Contrast or Phase Contrast. If 'Phase Contrast' is selected, please indicate the used Phase Contrast Mode under the field phaseContrastMode.",
"enum": [
"Absorption Contrast",
"Phase Contrast"
],
"type": "string"
},
"endAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - End angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then endAngle is 180\u00b0. Typical unit - degree."
},
"largeFOV": {
"description": "(Required) - To be set to true if large field of view or wide field of view is used.",
"type": "boolean"
},
"numberOfProjections": {
"description": "(Required) - Number of projections acquired during the CT.",
"type": "number"
},
"phaseContrastMode": {
"description": "(Optional) - The phase contrast mode used during acquisition - Zernike phase contrast, propagation-based, grating-based(Hartmann), grating-based(Talbot).",
"enum": [
"Zernike phase contrast",
"Propagation-based",
"Grating-based(Hartmann)",
"Grating-based(Talbot)"
],
"type": "string"
},
"referenceImages": {
"additionalProperties": false,
"description": "(Optional) - Details on the reference images (if used) - number of flats/bright images and number of dark images.",
"properties": {
"numberOfBrightImages": {
"description": "(Optional) - Number of flats or bright images used as reference.",
"type": "number"
},
"numberOfDarkImages": {
"description": "(Optional) - Number of dark images used as reference.",
"type": "number"
}
},
"type": "object"
},
"scanningMode": {
"description": "(Optional) - The scanning mode used during acquisition - helical, raster scanning, fast CT.",
"enum": [
"Helical",
"Raster Scanning",
"Fast CT"
],
"type": "string"
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Start angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then startAngle is -180\u00b0. Typical unit - degree."
},
"totalAcquisitionTime": {
"description": "(Required) - Time taken for acquisition for the entire scan. This is the total scan time, i.e. number of projections multipled by exposure time, but including read-out time. calculated as EndTime-StartTime. Format: hh:mm:ss.",
"format": "time",
"pattern": "^(\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?)$",
"type": "string"
},
"useBadPixelMap": {
"description": "(Optional) - To be set to true if bad pixel map is used. This parameter is relevant for SEM based CT.",
"type": "boolean"
}
},
"required": [
"acquisitionScriptName",
"startAngle",
"endAngle",
"angularStepSize",
"acquisitionTimePerProjection",
"totalAcquisitionTime",
"largeFOV",
"contrastType"
],
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian) of datatype string.",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"angleSet": {
"additionalProperties": false,
"description": "(Optional) - Tilt angles alpha, beta and gamma decribing the three angular positions of an item.",
"properties": {
"alpha": {
"description": "(Optional) - Tilt angle alpha of the item.",
"type": "number"
},
"anglesUnit": {
"description": "(Optional) - unit of the angles (allowed units - degree or radian)",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"beta": {
"description": "(Optional) - Rotation angle beta of the item.",
"type": "number"
},
"gamma": {
"description": "(Optional) - Angle gamma of the item.",
"type": "number"
}
},
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A).",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"data": {
"additionalProperties": false,
"description": "(Required) - Details about the data section of the measurement.",
"properties": {
"projections": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"cropping": {
"additionalProperties": false,
"description": "(Optional) - Details about cropping or clipping to select a region of interest(ROI).",
"properties": {
"ROI": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The size of the region of interest (ROI) in integer values of xPixels and yPixels."
},
"offset": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The offset applied to the origin (i.e., centre of the image) to select the region of interest in x and y coordinates."
}
},
"required": [
"ROI",
"offset"
],
"type": "object"
},
"projectionImageDataStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the data structure of the image data of the projections.",
"properties": {
"IOValue": {
"description": "(Required) - The IO value obtained from the metadata.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The dimension of the image as for integer values of xPixels and yPixels."
},
"fileLocation": {
"description": "(Required) - The location where the data file is stored. A URL is preferred if available.",
"type": "string"
},
"greyValueRepresentation": {
"description": "(Optional) - Description about the grey value representation.",
"type": "string"
},
"header": {
"additionalProperties": false,
"description": "(Required) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Required) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"imageCorrection": {
"additionalProperties": false,
"description": "(Optional) - Details about the image correction.",
"properties": {
"isImageCorrected": {
"description": "(Required) - To be set as true if image is corrected.",
"type": "boolean"
},
"linkToReferenceImages": {
"description": "(Required) - Link to the reference images (flats/darks).",
"format": "uri-reference",
"type": "string"
}
},
"required": [
"isImageCorrected",
"linkToReferenceImages"
],
"type": "object"
},
"imageFormats": {
"additionalProperties": false,
"description": "(Required) - The file formats of the images - tiff, png, jpeg. When more than one file formats are there, then the formats are to be entered as an array of strings.",
"properties": {
"fileFormats": {
"oneOf": [
{
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
{
"items": {
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"fileFormats"
],
"type": "object"
},
"imageID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the Image Data."
},
"isPreFiltered": {
"description": "(Optional) - To be set as true if image is prefiltered.",
"type": "boolean"
},
"name": {
"description": "(Required) - Name of the Projection Image Data.",
"type": "string"
},
"numberOfImages": {
"description": "(Required) - Number of images in the data set. It is same as the number of projections.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical x,y length imaged by a single pixel, normally expressed in \u00b5m."
}
},
"required": [
"fileLocation",
"name",
"imageFormats",
"header"
],
"type": "object"
}
},
"required": [
"projectionImageDataStructure"
],
"type": "object"
},
"reconstructedData": {
"additionalProperties": false,
"description": "(Required) - Details about the reconstructed slices. When multiple reconstructions of the same raw data (projections) are present, the corresponding data can be combined as an array of reconstruction data sets, else as a single reconstruction data set.",
"properties": {
"reconstruction": {
"oneOf": [
{
"$ref": "#/$defs/reconstruction"
},
{
"items": {
"$ref": "#/$defs/reconstruction"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"reconstruction"
],
"type": "object"
}
},
"required": [
"projections",
"reconstructedData"
],
"type": "object"
},
"detector": {
"additionalProperties": false,
"description": "gives the settings of a detector or multiple detectors.",
"properties": {
"detectorSettings": {
"oneOf": [
{
"$ref": "#/$defs/detectorSettings"
},
{
"items": {
"$ref": "#/$defs/detectorSettings"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"detectorSettings"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "(Required) - Gives the settings of a single detector.",
"properties": {
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each pixel or voxel in an image. The bit depth determines the number of possible intensity levels that can be assigned to each pixel or voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"cameraGain": {
"description": "(Optional) - The amplification (gain) of the signal from an image sensor in a camera.",
"type": "number"
},
"detectorCoolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Cooling temperature of the detector, if it cooled. Relevant for SEM based CT. Typical unit - K."
},
"detectorDimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Optional) - The dimensions of the detector in integer values of xPixels and yPixels."
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector."
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the detector (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"detectorMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - The motor positions of the detector in cartesian coordinates and tilt angles."
},
"detectorName": {
"description": "(Optional) - Name of the detector of datatype string.",
"type": "string"
},
"detectorPixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical length in cartesian coordinates imaged by a single pixel of the detector. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"detectorType": {
"description": "(Optional) - The type of detector to be selected from a controlled list consisting of CCD, Panel, PCXD, CMOS, Time-Delay Integration (TDI) and Direct Conversion.",
"enum": [
"CCD",
"Panel",
"PCXD",
"CMOS",
"Time-Delay Integration (TDI)",
"Direct Conversion"
],
"type": "string"
},
"energyThreshold": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - A specific energy level used to filter the detected radiation."
},
"exposureTimePerFrame": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Time for which the sample is exposed per frame. Typical unit - s."
},
"frameSkip": {
"additionalProperties": false,
"description": "(Optional) - A numerical representation indicating the number of frames that are skipped or omitted during the acquisition or recording process. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3. If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped.",
"properties": {
"value": {
"oneOf": [
{
"description": "(Optional) - Number of frames skipped during acquisition. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3.",
"type": "number"
},
{
"description": "(Optional) - Pattern of frames skipped during acquisition. E.g. - If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped like [1,3,5]",
"items": {
"type": "number"
},
"minItems": 1,
"type": "array"
}
]
}
},
"type": "object"
},
"framesPerSecond": {
"description": "(Optional) - The number of frames captured in a second.",
"type": "number"
},
"imagePixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical length in cartesian coordinates imaged by a single pixel of the image. It is the native pixel size divided by the total magnification. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"lens": {
"additionalProperties": false,
"description": "(Optional) - Details of a lens, if used with the detector.",
"properties": {
"hasLens": {
"description": "(Required) - To be set to true if the detector has a lens.",
"type": "boolean"
},
"lensFocalLength": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Focal length of the lens."
},
"lensID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the lens."
},
"lensMagnification": {
"description": "(Optional) - Magnification of the lens as a floating point number.",
"type": "number"
},
"lensManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the lens (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"lensName": {
"description": "(Optional) - Name of the lens of datatype string.",
"type": "string"
}
},
"required": [
"lensMagnification",
"lensFocalLength"
],
"type": "object"
},
"numberOfAveragedFramesPerProjection": {
"description": "(Optional) - The number of averaged frames per projection, if averaging is done.",
"type": "number"
},
"sensor": {
"additionalProperties": false,
"description": "(Optional) - Details about a sensor, if present.",
"properties": {
"hasSensor": {
"description": "(Required) - To be set to true if the detector has a sensor.",
"type": "boolean"
},
"sensorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the sensor."
},
"sensorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the sensor (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"sensorMaterial": {
"description": "(Optional) - Material of the sensor of datatype string.",
"type": "string"
},
"sensorName": {
"description": "(Optional) - Name of the sensor of datatype string.",
"type": "string"
},
"sensorThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the sensor."
},
"sensorType": {
"description": "(Optional) - The type of sensor as a string.",
"type": "string"
}
},
"required": [
"hasSensor"
],
"type": "object"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Temperature of the detector."
},
"totalCountsPerProjection": {
"description": "(Optional) - The sum of the intensity values recorded by the X-ray detector for a single projection during a scan.",
"type": "number"
}
},
"required": [
"detectorType",
"detectorManufacturer",
"binning",
"detectorMotorPositions",
"imagePixelSize"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m).",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ).",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min). Typical unit - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"geometry": {
"additionalProperties": false,
"description": "Describes the geometry of the CT instrument",
"properties": {
"beamGeometry": {
"additionalProperties": false,
"description": "(Required) - Details about beam geometry like beam geometry type and divergence angle.",
"properties": {
"beamGeometryType": {
"description": "(Required) - The type of the beam geometry to be selected between 'collimated' and 'divergent'.",
"enum": [
"collimated",
"divergent"
],
"type": "string"
},
"divergenceAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Angle of divergence when the beam geometry is divergent. Typical unit - degree."
}
},
"type": "object"
},
"geometricMagnification": {
"description": "(Required) - Geometric magnification refers to the ratio of the size of an object's image to the size of the object itself. It is a measure of how much larger the image appears compared to the actual object. Geometric magnification (M) is calculated using the formula M = (SID + SOD) / SID, where SID is the source-to-image distance and SOD is the source-to-object distance.",
"type": "number"
},
"objectToDetectorDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the object and the detector. Typical unit - \u00b5m."
},
"opticalMagnification": {
"description": "(Required) - Optical magnification is calculated as the ratio of the focal length of the objective lens to the focal length of the eyepiece (if an eyepiece is present) in a traditional optical microscope.",
"type": "number"
},
"sourceToObjectDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the source and the object. Typical unit - \u00b5m."
}
},
"required": [
"sourceToObjectDistance",
"objectToDetectorDistance",
"beamGeometry",
"geometricMagnification",
"opticalMagnification"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"CTAquisition": {
"$ref": "#/$defs/CTAquisition",
"description": "(Optional) - Details regarding the acquisition."
},
"calibration": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the calibration and the scaling factor.",
"properties": {
"calibrationType": {
"description": "(Optional) - Type of calibration as a string.",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (YYYY-MM-DDThh:mm:ss.sss) in the ISO 8601 date-time format",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z?)$",
"type": "string"
},
"systemScaling": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scaling factor.",
"properties": {
"adjustSystemScaling": {
"description": "(Required) - To be set to true if system scaling is adjusted, else false.",
"type": "boolean"
},
"measuredScalingFactor": {
"description": "(Optional) - Value of the measured scaling factor.",
"type": "number"
},
"referenceScalingFactor": {
"description": "(Optional) - Value of the reference scaling factor, determined ususally during the data processing.",
"type": "number"
}
},
"required": [
"adjustSystemScaling"
],
"type": "object"
}
},
"type": "object"
},
"detector": {
"$ref": "#/$defs/detector",
"description": "(Optional) - Details regarding the detector."
},
"focalSpotMode": {
"additionalProperties": false,
"description": "(Optional) - Option for setting the size of the focal spot. Some sources have the option to select the target spot size, or focal spot size absolutely by setting a value, while some others give the option of selecting 'small', 'medium' or 'large'. Smaller spot size = higher resolution. Note that the power/current will change with this value. In addition, the detector settings will usually be selected in conjunction. (different scintillator/lens/magnification).",
"properties": {
"selection": {
"description": "(Optional) - Selection of the setting of the size of the focal spot when the option for setting the size of the focal spot by selecting 'small', 'medium' or 'large' according to predefined values set by the manufacturer.",
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the target spot when the option for setting the size of the focal spot absolutely by setting a value is available."
}
},
"type": "object"
},
"geometry": {
"$ref": "#/$defs/geometry",
"description": "(Optional) - Details regarding the geometry."
},
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"optics": {
"$ref": "#/$defs/optics",
"description": "(Optional) - Details about the optics and individual motor positions."
},
"sampleStage": {
"$ref": "#/$defs/sampleStage",
"description": "(Optional) - Details regarding the sample stage."
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray target in an SEM based CT set-up.",
"properties": {
"SEMManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the scanning electron microscope used for SEM based CT."
},
"SEMName": {
"description": "(Optional) - Name of the scanning electron microscope used for SEM based CT.",
"type": "string"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the material which acts as the cathode in SEM based CT",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details of the pressure maintained in the chamber of the SEM."
},
"electronBeamShift": {
"additionalProperties": false,
"description": "(Optional) - The distance by which the electron beam is shifted in the x and y directions.",
"properties": {
"xShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Beam shift in the x direction. Typical unit - \u00b5m."
},
"yShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Beam shift in the y direction. Typical unit - \u00b5m."
}
},
"type": "object"
},
"electronProbeCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required) - The electron current measured at the probe. Typical unit - \u00b5A."
},
"objectiveLensAperture": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). Typically the diameter of the aperture is set in \u00b5m."
},
"target": {
"additionalProperties": false,
"description": "(Required) - Details regarding the target in SEM based CT, which upon interaction with the e-beam produces the X-rays.",
"properties": {
"targetDriftCorrection": {
"description": "(Required) - If drift correction is activated for the target, this parameter has to be set to true.",
"type": "boolean"
},
"targetMaterial": {
"description": "(Required) - Material with which the target is made.",
"type": "string"
},
"targetShape": {
"description": "(Optional) - Description of the shape or geometry of the target. e.g. - bulk, foil, needle.",
"type": "string"
},
"targetThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Thickness of the target (dimension in Z direction). Default unit - \u00b5m."
},
"targetTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the target is tilted. Typical unit - degree."
}
},
"required": [
"targetMaterial",
"targetThickness",
"targetDriftCorrection",
"targetTiltAngle"
],
"type": "object"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Required) - Acceleration Voltage set in the SEM. Default unit - kV."
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. In SEM based CT, the beam is focussed on the target material which emits the X-rays upon interaction with the electrons. Default unit - \u00b5m."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray energy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Optional) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"xrayCharacteristicLine": {
"description": "(Optional) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"workingDistance",
"objectiveLensAperture",
"electronProbeCurrent",
"voltage",
"target"
],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
},
"targetCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current measured at the X-ray target, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"sourceDrift": {
"additionalProperties": false,
"description": "(Optional) - Distance by which the source is shifted during the measurement (i.e., end position - start position).",
"properties": {
"xDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the x direction. Typical unit - \u00b5m."
},
"yDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xDrift",
"yDrift"
],
"type": "object"
},
"sourcePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the source."
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray energy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source",
"focalSpotMode",
"CTAquisition",
"geometry",
"sampleStage",
"detector"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer.",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"bioReactor": {
"additionalProperties": false,
"description": "(Optional) - Details of an in situ bioreactor.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in sterile conditions.",
"type": "boolean"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is decreased. Typical unit - K/min."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is increased, typically in K/min."
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"anvil": {
"description": "(Optional) - The type of anvil used in the in situ load frame (stage) for applying a particular type of force on the sample. Option to be selected from a controlled list consisting of - Compression, Diamond indentation 90\u00b0 cone, Diamond indentation cube corner, Diamond indentation wedge, Tension, Other. If 'Other' is selected, specify the name of the anvil with a description in the field 'otherAnvil'.",
"enum": [
"Compression",
"Diamond indentation 90\u00b0 cone",
"Diamond indentation cube corner",
"Diamond indentation wedge",
"Tension",
"Other"
],
"type": "string"
},
"blindAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - ed by the load frame(stage). Example: for a CT normally scanned over 180\u00b0 (e.g. -90\u00b0/+90\u00b0), a blind angle of 40\u00b0 due to the in situ cell implies that only 180\u00b0-40\u00b0=140\u00b0 (e.g. -70\u00b0/70\u00b0) is visible. NOTE: for a CT normally scanned over 360\u00b0 (e.g. -180\u00b0/+180\u00b0), a blind angle of 40\u00b0 would require the subtraction of the blind angle twice, implying two scan ranges of 140\u00b0 each (e.g. -160\u00b0/-20\u00b0 and +20\u00b0/+160\u00b0). Typical unit - degree."
},
"displacement": {
"additionalProperties": false,
"description": "(Optional) - Specification on how displacement is applied on the sample. Either 'displacementRate' in \u00b5m/min or 'displacementIncrement' in \u00b5m/acquisition need to be selected.",
"properties": {
"displacementIncrement": {
"description": "(Optional) - The step at which displacement is changed per acquisition in \u00b5m/acquisition.",
"type": "number"
},
"displacementRate": {
"description": "(Optional) - The rate at which displacement is applied on the sample in \u00b5m/min.",
"type": "number"
}
},
"type": "object"
},
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame or anvil (e.g. - size of anvil) relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
},
"maximumDisplacement": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - The maximum displacement allowed in the selected configuration. Typical unit - \u00b5m."
},
"maximumForce": {
"description": "(Optional) - The maximum force that can be applied to the sample in N.",
"type": "number"
},
"otherAnvil": {
"description": "(Optional) - If 'anvil' was selected as 'Other' from the controlled list as it was not listed, please specify the name of the anvil with a description in this field.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the vacuum chamber relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the vacuum chamber relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the vacuum chamber."
},
"chamberName": {
"description": "(Optional) - Name of the vacuum chamber.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"motorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchical level and direction of a motor.",
"properties": {
"motorDirection": {
"description": "(Required) - The direction of movement (for X,Y,Z,M motors) or axis of rotation (for rotating motors) expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the X-stage and perpendicular to the Y-stage. then beam direction = [1 0 0], X-stage-direction = [1 0 0] (positive movement direction away from source towards detector) or can be (-1 0 0) (towards source) and Y-stage-direction = [0 1 0] or can be [0 -1 0] (analogous interpretation). The parameters need to be individually determined for each instrument. For rotating motors, the directional vector of axis of rotation should be given in Cartesian coordinates (counterclockwise, right-hand rule).",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"motorLevel": {
"description": "(Required) - Hierarchy of the motor expressed as an integer.",
"type": "number"
}
},
"type": "object"
},
"motorPositions": {
"additionalProperties": false,
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the motor.",
"properties": {
"angles": {
"$ref": "#/$defs/angleSet",
"description": "(Optional) - The three tilt angles alpha, beta and gamma of the motors controlling the position of the item."
},
"xyzPositions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - The xyz coordinates describing the motor positions of the item."
}
},
"type": "object"
},
"optics": {
"additionalProperties": false,
"description": "(Optional) - Details about the optics and individual motor positions.",
"properties": {
"collimator": {
"additionalProperties": false,
"description": "(Optional) - Details about the collimator and its individual motor positions.",
"properties": {
"collimatorDetails": {
"description": "(Optional) - Details about the collimator relevant for the measurement.",
"type": "string"
},
"collimatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the collimator."
}
},
"type": "object"
},
"condenser": {
"additionalProperties": false,
"description": "(Optional) - Details about the condenser lens and its individual motor positions, if used.",
"properties": {
"condenserDetails": {
"description": "(Optional) - Details about the condenser relevant for the measurement.",
"type": "string"
},
"condenserPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the condenser."
}
},
"type": "object"
},
"fresnelZonePlate": {
"additionalProperties": false,
"description": "(Optional) - Details about the fresnel zone plate and its individual motor positions, if used.",
"properties": {
"fresnelZonePlateDetails": {
"description": "(Optional) - Details about the fresnel zone plate relevant for the measurement.",
"type": "string"
},
"fresnelZonePlatePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the fresnel zone plate."
}
},
"type": "object"
},
"monochromator": {
"additionalProperties": false,
"description": "(Required) - Details about the monochromator and individual motor positions, if used.",
"properties": {
"monochromatorDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the monochromator type type, material, energy and notes.",
"properties": {
"energy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Energy set in the monochromator. Typical unit - eV."
},
"material": {
"description": "(Optional) - Material of the monochromator.",
"type": "string"
},
"monochromatorType": {
"description": "(Optional) - Type of the monochromator.",
"type": "string"
},
"notes": {
"description": "(Optional) - Additional information about the monochromator relevant for the measurement."
}
},
"type": "object"
},
"monochromatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the monochromator."
},
"monochromatorUsed": {
"description": "(Required) - To be set to true if monochromator is used, else false.",
"type": "boolean"
}
},
"required": [
"monochromatorUsed"
],
"type": "object"
},
"phaseRing": {
"additionalProperties": false,
"description": "(Required) - Details about the phase ring and its individual motor positions, if inserted.",
"properties": {
"phaseRingDetails": {
"description": "(Optional) - Details about the phase ring relevant for the measurement.",
"type": "string"
},
"phaseRingPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the phase ring."
}
},
"type": "object"
}
},
"required": [
"monochromator"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes a parameter which can be split into number of pixels in x and y directions like the resolution",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm or \u00b5m, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the size of a single pixel (typical value - nm, \u00b5m) of datatype string",
"enum": [
"nm",
"\u00b5m"
],
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min).",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW).",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi).",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"rampDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a rate at which temperature is increased or decreased.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K/min, K/s).",
"enum": [
"K/min",
"K/s"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of temperature increase or decrease.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"reconstruction": {
"additionalProperties": false,
"description": "Data from one single reconstruction.",
"properties": {
"reconstructionDetails": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"additionalFilters": {
"beamHardeningCorrection": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"filterType": {
"description": "(Optional) - Type of the additional filter - Median or Gauss",
"enum": [
"Median",
"Gauss"
],
"type": "string"
},
"phaseRetrieval": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"ringFilter": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
}
},
"algorithm": {
"description": "(Required) - Algorithm used for reconstruction to be selected from FBP - Filtered Back Projection, ART - Algebraic Reconstruction Technique, 3dCT - 3D Computed Tomography and Gridrec.",
"enum": [
"FBP - Filtered Back Projection",
"ART - Algebraic Reconstruction Technique",
"3dCT - 3D Computed Tomography",
"Gridrec"
],
"type": "string"
},
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepthConversionMax": {
"description": "(Required) - Maximum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"bitDepthConversionMin": {
"description": "(Required) - Minimum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"hardwarePlatform": {
"description": "(Optional) - Hardware platform used for reconstruction to be selected between CPU and GPU.",
"enum": [
"CPU",
"GPU"
],
"type": "string"
},
"lastImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the last image for the reconstruction of the 3D Volume, typically an integer.",
"type": "string"
},
"projectionPadding": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the projection padding applied to the raw projection data to address certain issues in the reconstruction process.",
"properties": {
"paddingSize": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - Size of the projection padding used in pixels."
},
"paddingType": {
"description": "(Required) - Type of the projection padding used - Zero Padding, Linear Interpolation Padding, Sinc Interpolation Padding, Shepp-Logan Filtered Back Projection (SL-FBP), Gridding and Extended Field of View (FOV) Padding.",
"enum": [
"Zero Padding",
"Linear Interpolation Padding",
"Sinc Interpolation Padding",
"Shepp-Logan Filtered Back Projection (SL-FBP)",
"Gridding",
"Extended Field of View (FOV) Padding"
],
"type": "string"
}
},
"type": "object"
},
"reconstructionSoftware": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for reconstruction. It may be the same as the acquisition software or a different one."
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Scan angle at which the reconstruction of the 3D Volume starts. Typical unit - degree."
},
"startImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the start image for the reconstruction of the 3D Volume.",
"type": "string"
},
"tomographicProjectionFilter": {
"description": "(Optional) - Name of the tomographic projection filter used to be selected from Ram-Lak Filter, Butterworth Filter, Shepp-Logan Filter, Hann (Hanning) Filter, Gaussian Filter, Cosine Filter, Soft Filtration Method and Hard Filtration Method.",
"enum": [
"Ram-Lak Filter",
"Butterworth Filter",
"Shepp-Logan Filter",
"Hann (Hanning) Filter",
"Gaussian Filter",
"Cosine Filter",
"Soft Filtration Method",
"Hard Filtration Method"
],
"type": "string"
}
},
"required": [
"startImage",
"lastImage",
"startAngle",
"hardwarePlatform",
"algorithm",
"binning"
],
"type": "object"
},
"volumeStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each voxel in the 3D volume. The bit depth determines the number of possible intensity levels that can be assigned to each voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Required) - The dimension of the 3D volume in XYZ coordinates. If the length in Z dimension is not known and instead only the number of slices are known, they need to be separately entered in the field 'numberOfSlices'. Typical unit - \u00b5m."
},
"header": {
"additionalProperties": false,
"description": "(Optional) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Optional) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"name": {
"description": "(Required) - Name of the 3D volume structure (dataset).",
"type": "string"
},
"numberOfSlices": {
"description": "(Optional) - No. of slices which make up the 3D volume.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel/voxel, normally expressed in \u00b5m."
},
"volumeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry of the 3D reconstructed volume usually provided by the project or the laboratory."
}
},
"required": [
"name",
"dimensions",
"bitDepth",
"pixelSize"
],
"type": "object"
}
},
"required": [
"volumeStructure",
"reconstructionDetails"
],
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"sampleStage": {
"additionalProperties": false,
"description": "(Required) - Details about sample stage.",
"properties": {
"stageMotorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchy of the stage motors. This information is required to know how the motor movements affect the positions of the samples, particularly relevant for correlative characterization.",
"properties": {
"beamDirection": {
"description": "(Required) - The beam direction expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the Y-stage and perpendicular to the X-stage. then beam direction = [0 1 0].",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"mMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the M motor (stage) as a vector in cartesian coordiantes. The M motor is usually relevant only for SEM based CT. It is a special motor which counteracts the Z motor."
},
"rMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the R motor (stage) as a vector in cartesian coordiantes. R motor has rotation around z axis +1 (for anticlockwise)."
},
"tMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the T motor (stage) as a vector in cartesian coordiantes. The T motor is usually relevant only for SEM based CT."
},
"xMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the X motor (stage) as a vector in cartesian coordinates."
},
"yMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Y motor (stage) as a vector in cartesian coordinates."
},
"zMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Z motor (stage) as a vector in cartesian coordinates."
}
},
"required": [
"beamDirection",
"xMotor",
"yMotor",
"zMotor",
"rMotor"
],
"type": "object"
},
"stageMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the stage motors."
}
},
"required": [
"stageMotorHierarchy"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s).",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"user": {
"description": "Basic schema for user description. It can be extended.",
"properties": {
"ORCID": {
"description": "(Optional) - Open Researcher and Contributor ID expressed as a URI",
"pattern": "^https://orcid\\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[X0-9]{1}$",
"type": "string"
},
"affiliation": {
"description": "(Optional) - Details of the institution to which the user is affiliated",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"description": "(Optional) -Identifier of the institution to which the user is affiliated",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be chosen from a controlled list of values (*ROR *GRID *ISNI *URL *DOI *Handle)",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"email": {
"description": "(Optional) - Email of the user",
"format": "email",
"type": "string"
},
"familyName": {
"description": "(Optional) - Family name of the user",
"type": "string"
},
"givenName": {
"description": "(Optional) - Given name of the user",
"type": "string"
},
"role": {
"description": "(Required) - Role of the research user",
"enum": [
"Data Curator",
"Instrument Scientist",
"Team Leader",
"Team Member"
],
"type": "string"
},
"userName": {
"description": "(Required) - Full name of the user in the format (Family Name, Given Name)",
"type": "string"
}
},
"required": [
"userName",
"role"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV).",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided. Contributors (in alphabetical order of last names): Alexey Boubnov, Rafaela Debastiani, Jonas Fell, Sarah Irvine, Reetu Elza Joseph.",
"properties": {
"consumables": {
"description": "(Optional) - Auxiliary entity used during Fabrication, Sample Preparation or Measurement which has a limited time capacity or is limited in its number of uses before it is disposed of, necessary to the process itself and normally bought from third party manufacturers. Examples are: gloves, syringes, wipes, etching solutions, glass slides, spatulas, weighing paper, two-sided tape.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"data": {
"$ref": "#/$defs/data",
"description": "(Required)- Details concerning the data section of the measurement."
},
"definition": {
"description": "(Required) - Name of the schema to which this entry conforms. In this case, lab_CT should be written.",
"type": "string"
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format YYYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z?)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry usually provided by the project or the laboratory."
},
"equipment": {
"description": "(Optional) - Any kind of physical or virtual item, device, machine or other tools used to perform one or more Fabrication(s), Sample Preparation(s), Model Preparation(s), Data Acquisition(s) and/or any of the processes included in the Data Analysis Lifecycle. Usually, the Equipment is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. Equipment is usually an investment. According to this definition, an Instrument is a particular type of Equipment.",
"type": "string"
},
"experimentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the measurement usually provided by the project or the laboratory."
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings. Instrument is a physical or virtual identifiable piece of Equipment used to perform a Data Acquisition and to generate Raw Data. The Instrument is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. A virtual Instrument may be any computational resource or HPC infrastructure (cloud infrastructure or supercomputer) needed to perform Calculations or Simulations."
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure."
},
"measurementDescription": {
"description": "(Optional) - Description about the measurement.",
"type": "string"
},
"measurementPurpose": {
"description": "(Required) - Measurement is experimental Data Acquisition, typically performed on a Sample using an experimental Technique. It may also be performed during Fabrication or Sample Preparation, e.g., to characterise the intermediate stages and/or the final resulting Precursor(s) or Sample(s), respectively. A Measurement may require the use of Consumables.",
"enum": [
"assessment (to given categories or values)",
"completeness check (presence or absence of given properties)",
"correlative characterization (dedicated sample treatment to emphasise given features)",
"exploratory (routine check of known properties)",
"feasibility (quick check, rough estimate)",
"high quality measurement (precise, careful treatment)",
"test specific hypothesis (focus only on given aspects)",
"other (please specify in the comment)"
],
"type": "string"
},
"parents": {
"description": "(Required) - Parents of this metadata like the metadata document of the sample with which the measurement was performed.",
"items": {
"if": {
"properties": {
"parentType": {
"not": {
"const": "not applicable"
}
}
}
},
"properties": {
"parentReference": {
"description": "If type is 'MetaStore URI' it is possible to easily fill this field in a later stage",
"format": "uri-reference",
"type": "string"
},
"parentReferenceType": {
"default": "MetaStore URI",
"enum": [
"plain text",
"external URL",
"MetaStore URI"
],
"type": "string"
},
"parentType": {
"default": "sample",
"enum": [
"not applicable",
"sample"
],
"type": "string"
}
},
"required": [
"parentType"
],
"then": {
"required": [
"parentReferenceType",
"parentReference"
]
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition."
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format."
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format YYYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z?)$",
"type": "string"
},
"technique": {
"description": "(Required) - Any experimental, theoretical or computational method used during Data Acquisition or during any of the processes included in the Data Analysis Lifecycle to acquire, process or analyse Research Data about a System or a set of them with an Instrument, which is used to generate this metadata.",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement.",
"type": "string"
},
"user": {
"$ref": "#/$defs/user",
"description": "(Required)- The contact information of the user responsible for the measurement."
}
},
"required": [
"title",
"technique",
"definition",
"parents",
"measurementPurpose",
"startTime",
"endTime",
"program",
"user",
"instrument",
"data"
],
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 6fcb392901482a3666586a06209c0d586f07b42d | 2023-06-06T09:01:42 | Reference_Dataset_Zenodo/pp18_file_schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$id": "https://github.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/blob/faeeb3856a267e10bd94c904a5e763ba3ad1e9fe/Reference_Dataset_Zenodo/pp18_file_schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes the metadata of a single file in the reference dataset by BAM. It contains the metadata of the results of ASTM E139 -11 creep tests on a reference material of Nimonic 75 nickel-base alloy",
"properties": {
"bucket": {
"description": "(Required) - string indicating the dataset in which the document is contained",
"type": "string"
},
"checksum": {
"description": "(Required) - checksum of the document",
"type": "string"
},
"key": {
"description": "(Required) - key of the document (File name)",
"type": "string"
},
"links": {
"properties": {
"self": {
"description": "(Required) - URL/ link to the document",
"type": "string"
}
},
"required": [
"self"
],
"type": "object"
},
"size": {
"description": "(Required) - Size of the document in bytes",
"type": "string"
},
"type": {
"description": "(Required) - File type of the document",
"type": "string"
}
},
"required": [
"links",
"checksum",
"bucket",
"key",
"type",
"size"
],
"title": "Metadata of BAM reference data (individual files): results of ASTM E139 -11 creep tests on a reference material of Nimonic 75 nickel-base alloy",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 367ef5aab390b3bd55f98c559882f9ce54003536 | 2024-01-08T14:20:27 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"CTAquisition": {
"additionalProperties": false,
"description": "(Required) - Details about the acquisition.",
"properties": {
"acquisitionScriptName": {
"description": "(Required) - Name of the script used for acquisition.",
"type": "string"
},
"acquisitionTimePerProjection": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time taken for acquisition of a single projection. Typical unit - s."
},
"angularStepSize": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Step size of the rotation of the sample during the CT. Typical unit - degree."
},
"contrastType": {
"description": "(Required) - The contrast type(mode) used - Absorption Contrast or Phase Contrast. If 'Phase Contrast' is selected, please indicate the used Phase Contrast Mode under the field phaseContrastMode.",
"enum": [
"Absorption Contrast",
"Phase Contrast"
],
"type": "string"
},
"endAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - End angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then endAngle is 180\u00b0. Typical unit - degree."
},
"largeFOV": {
"description": "(Required) - To be set to true if large field of view or wide field of view is used.",
"type": "boolean"
},
"numberOfProjections": {
"description": "(Required) - Number of projections acquired during the CT.",
"type": "number"
},
"phaseContrastMode": {
"description": "(Optional) - The phase contrast mode used during acquisition - Zernike phase contrast, propagation-based, grating-based(Hartmann), grating-based(Talbot).",
"enum": [
"Zernike phase contrast",
"Propagation-based",
"Grating-based(Hartmann)",
"Grating-based(Talbot)"
],
"type": "string"
},
"referenceImages": {
"additionalProperties": false,
"description": "(Optional) - Details on the reference images (if used) - number of flats/bright images and number of dark images.",
"properties": {
"numberOfBrightImages": {
"description": "(Optional) - Number of flats or bright images used as reference.",
"type": "number"
},
"numberOfDarkImages": {
"description": "(Optional) - Number of dark images used as reference.",
"type": "number"
}
},
"type": "object"
},
"scanningMode": {
"description": "(Optional) - The scanning mode used during acquisition - helical, raster scanning, fast CT.",
"enum": [
"Helical",
"Raster Scanning",
"Fast CT"
],
"type": "string"
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Start angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then startAngle is -180\u00b0. Typical unit - degree."
},
"totalAcquisitionTime": {
"description": "(Required) - Time taken for acquisition for the entire scan. This is the total scan time, i.e. number of projections multipled by exposure time, but including read-out time. calculated as EndTime-StartTime. Format: hh:mm:ss.",
"format": "time",
"pattern": "^(\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?)$",
"type": "string"
},
"useBadPixelMap": {
"description": "(Optional) - To be set to true if bad pixel map is used. This parameter is relevant for SEM based CT.",
"type": "boolean"
}
},
"required": [
"acquisitionScriptName",
"startAngle",
"endAngle",
"angularStepSize",
"acquisitionTimePerProjection",
"totalAcquisitionTime",
"largeFOV",
"contrastType"
],
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "degree",
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"angleSet": {
"additionalProperties": false,
"description": "(Optional) - Tilt angles alpha, beta and gamma decribing the three angular positions of an item.",
"properties": {
"alpha": {
"description": "(Optional) - Tilt angle alpha of the item.",
"type": "number"
},
"anglesUnit": {
"default": "degree",
"description": "(Optional) - unit of the angles (allowed units - degree or radian)",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"beta": {
"description": "(Optional) - Rotation angle beta of the item.",
"type": "number"
},
"gamma": {
"description": "(Optional) - Angle gamma of the item.",
"type": "number"
}
},
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"default": "\u00b5m",
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "pA",
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string.",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"data": {
"additionalProperties": false,
"description": "(Required) - Details about the data section of the measurement.",
"properties": {
"projections": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"cropping": {
"additionalProperties": false,
"description": "(Optional) - Details about cropping or clipping to select a region of interest(ROI).",
"properties": {
"ROI": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The size of the region of interest (ROI) in integer values of xPixels and yPixels."
},
"offset": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The offset applied to the origin (i.e., centre of the image) to select the region of interest in x and y coordinates."
}
},
"required": [
"ROI",
"offset"
],
"type": "object"
},
"projectionImageDataStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the data structure of the image data of the projections.",
"properties": {
"IOValue": {
"description": "(Required) - The IO value obtained from the metadata.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The dimension of the image as for integer values of xPixels and yPixels."
},
"fileLocation": {
"description": "(Required) - The location where the data file is stored. A URL is preferred if available.",
"type": "string"
},
"greyValueRepresentation": {
"description": "(Optional) - Description about the grey value representation.",
"type": "string"
},
"header": {
"additionalProperties": false,
"description": "(Required) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Required) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"imageCorrection": {
"additionalProperties": false,
"description": "(Optional) - Details about the image correction.",
"properties": {
"isImageCorrected": {
"description": "(Required) - To be set as true if image is corrected.",
"type": "boolean"
},
"linkToReferenceImages": {
"description": "(Required) - Link to the reference images (flats/darks).",
"format": "uri-reference",
"type": "string"
}
},
"required": [
"isImageCorrected",
"linkToReferenceImages"
],
"type": "object"
},
"imageFormats": {
"additionalProperties": false,
"description": "(Required) - The file formats of the images - tiff, png, jpeg. When more than one file formats are there, then the formats are to be entered as an array of strings.",
"properties": {
"fileFormats": {
"oneOf": [
{
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
{
"items": {
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"fileFormats"
],
"type": "object"
},
"imageID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the Image Data."
},
"isPreFiltered": {
"description": "(Optional) - To be set as true if image is prefiltered.",
"type": "boolean"
},
"name": {
"description": "(Required) - Name of the Projection Image Data.",
"type": "string"
},
"numberOfImages": {
"description": "(Required) - Number of images in the data set. It is same as the number of projections.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical x,y length imaged by a single pixel, normally expressed in \u00b5m."
}
},
"required": [
"fileLocation",
"name",
"imageFormats",
"header"
],
"type": "object"
}
},
"required": [
"projectionImageDataStructure"
],
"type": "object"
},
"reconstructedData": {
"additionalProperties": false,
"description": "(Required) - Details about the reconstructed slices. When multiple reconstructions of the same raw data (projections) are present, the corresponding data can be combined as an array of reconstruction data sets, else as a single reconstruction data set.",
"properties": {
"reconstruction": {
"oneOf": [
{
"$ref": "#/$defs/reconstruction"
},
{
"items": {
"$ref": "#/$defs/reconstruction"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"reconstruction"
],
"type": "object"
}
},
"required": [
"projections",
"reconstructedData"
],
"type": "object"
},
"detector": {
"additionalProperties": false,
"description": "gives the settings of a detector or multiple detectors.",
"properties": {
"detectorSettings": {
"oneOf": [
{
"$ref": "#/$defs/detectorSettings"
},
{
"items": {
"$ref": "#/$defs/detectorSettings"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"detectorSettings"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "(Required) - Gives the settings of a single detector.",
"properties": {
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each pixel or voxel in an image. The bit depth determines the number of possible intensity levels that can be assigned to each pixel or voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"cameraGain": {
"description": "(Optional) - The amplification (gain) of the signal from an image sensor in a camera.",
"type": "number"
},
"detectorCoolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Cooling temperature of the detector, if it cooled. Relevant for SEM based CT. Typical unit - K."
},
"detectorDimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Optional) - The dimensions of the detector in integer values of xPixels and yPixels."
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector."
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the detector (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"detectorMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - The motor positions of the detector in cartesian coordinates and tilt angles."
},
"detectorName": {
"description": "(Optional) - Name of the detector of datatype string.",
"type": "string"
},
"detectorPixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical length in cartesian coordinates imaged by a single pixel of the detector. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"detectorType": {
"description": "(Optional) - The type of detector to be selected from a controlled list consisting of CCD, Panel, PCXD, CMOS, Time-Delay Integration (TDI) and Direct Conversion.",
"enum": [
"CCD",
"Panel",
"PCXD",
"CMOS",
"Time-Delay Integration (TDI)",
"Direct Conversion"
],
"type": "string"
},
"energyThreshold": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - A specific energy level used to filter the detected radiation."
},
"exposureTimePerFrame": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Time for which the sample is exposed per frame. Typical unit - s."
},
"frameSkip": {
"additionalProperties": false,
"description": "(Optional) - A numerical representation indicating the number of frames that are skipped or omitted during the acquisition or recording process. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3. If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped.",
"properties": {
"value": {
"oneOf": [
{
"description": "(Optional) - Number of frames skipped during acquisition. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3.",
"type": "number"
},
{
"description": "(Optional) - Pattern of frames skipped during acquisition. E.g. - If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped like [1,3,5]",
"items": {
"type": "number"
},
"minItems": 1,
"type": "array"
}
]
}
},
"type": "object"
},
"framesPerSecond": {
"description": "(Optional) - The number of frames captured in a second.",
"type": "number"
},
"imagePixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical length in cartesian coordinates imaged by a single pixel of the image. It is the native pixel size divided by the total magnification. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"lens": {
"additionalProperties": false,
"description": "(Optional) - Details of a lens, if used with the detector.",
"properties": {
"hasLens": {
"description": "(Required) - To be set to true if the detector has a lens.",
"type": "boolean"
},
"lensFocalLength": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Focal length of the lens."
},
"lensID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the lens."
},
"lensMagnification": {
"description": "(Optional) - Magnification of the lens as a floating point number.",
"type": "number"
},
"lensManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the lens (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"lensName": {
"description": "(Optional) - Name of the lens of datatype string.",
"type": "string"
}
},
"required": [
"lensMagnification",
"lensFocalLength"
],
"type": "object"
},
"numberOfAveragedFramesPerProjection": {
"description": "(Optional) - The number of averaged frames per projection, if averaging is done.",
"type": "number"
},
"sensor": {
"additionalProperties": false,
"description": "(Optional) - Details about a sensor, if present.",
"properties": {
"hasSensor": {
"description": "(Required) - To be set to true if the detector has a sensor.",
"type": "boolean"
},
"sensorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the sensor."
},
"sensorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the sensor (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"sensorMaterial": {
"description": "(Optional) - Material of the sensor of datatype string.",
"type": "string"
},
"sensorName": {
"description": "(Optional) - Name of the sensor of datatype string.",
"type": "string"
},
"sensorThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the sensor."
},
"sensorType": {
"description": "(Optional) - The type of sensor as a string.",
"type": "string"
}
},
"required": [
"hasSensor"
],
"type": "object"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Temperature of the detector."
},
"totalCountsPerProjection": {
"description": "(Optional) - The sum of the intensity values recorded by the X-ray detector for a single projection during a scan.",
"type": "number"
}
},
"required": [
"detectorType",
"detectorManufacturer",
"binning",
"detectorMotorPositions",
"imagePixelSize"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ; default value - keV) of datatype string",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"default": "mm",
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min) default value - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"geometry": {
"additionalProperties": false,
"description": "Describes the geometry of the CT instrument",
"properties": {
"beamGeometry": {
"additionalProperties": false,
"description": "(Required) - Details about beam geometry like beam geometry type and divergence angle.",
"properties": {
"beamGeometryType": {
"description": "(Required) - The type of the beam geometry to be selected between 'collimated' and 'divergent'.",
"enum": [
"collimated",
"divergent"
],
"type": "string"
},
"divergenceAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Angle of divergence when the beam geometry is divergent. Typical unit - degree."
}
},
"type": "object"
},
"geometricMagnification": {
"description": "(Required) - Geometric magnification refers to the ratio of the size of an object's image to the size of the object itself. It is a measure of how much larger the image appears compared to the actual object. Geometric magnification (M) is calculated using the formula M = (SID + SOD) / SID, where SID is the source-to-image distance and SOD is the source-to-object distance.",
"type": "number"
},
"objectToDetectorDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the object and the detector. Typical unit - \u00b5m."
},
"opticalMagnification": {
"description": "(Required) - Optical magnification is calculated as the ratio of the focal length of the objective lens to the focal length of the eyepiece (if an eyepiece is present) in a traditional optical microscope.",
"type": "number"
},
"sourceToObjectDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the source and the object. Typical unit - \u00b5m."
}
},
"required": [
"sourceToObjectDistance",
"objectToDetectorDistance",
"beamGeometry",
"geometricMagnification",
"opticalMagnification"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"CTAquisition": {
"$ref": "#/$defs/CTAquisition",
"description": "(Optional) - Details regarding the acquisition."
},
"calibration": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the calibration and the scaling factor.",
"properties": {
"calibrationType": {
"description": "(Optional) - Type of calibration as a string.",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (YYYY-MM-DDThh:mm:ss.sss) in the ISO 8601 date-time format",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"systemScaling": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scaling factor.",
"properties": {
"adjustSystemScaling": {
"description": "(Required) - To be set to true if system scaling is adjusted, else false.",
"type": "boolean"
},
"measuredScalingFactor": {
"description": "(Optional) - Value of the measured scaling factor.",
"type": "number"
},
"referenceScalingFactor": {
"description": "(Optional) - Value of the reference scaling factor, determined ususally during the data processing.",
"type": "number"
}
},
"required": [
"adjustSystemScaling"
],
"type": "object"
}
},
"type": "object"
},
"detector": {
"$ref": "#/$defs/detector",
"description": "(Optional) - Details regarding the detector."
},
"focalSpotMode": {
"additionalProperties": false,
"description": "(Optional) - Option for setting the size of the focal spot. Some sources have the option to select the target spot size, or focal spot size absolutely by setting a value, while some others give the option of selecting 'small', 'medium' or 'large'. Smaller spot size = higher resolution. Note that the power/current will change with this value. In addition, the detector settings will usually be selected in conjunction. (different scintillator/lens/magnification).",
"properties": {
"selection": {
"description": "(Optional) - Selection of the setting of the size of the focal spot when the option for setting the size of the focal spot by selecting 'small', 'medium' or 'large' according to predefined values set by the manufacturer.",
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the target spot when the option for setting the size of the focal spot absolutely by setting a value is available."
}
},
"type": "object"
},
"geometry": {
"$ref": "#/$defs/geometry",
"description": "(Optional) - Details regarding the geometry."
},
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"optics": {
"$ref": "#/$defs/optics",
"description": "(Optional) - Details about the optics and individual motor positions."
},
"sampleStage": {
"$ref": "#/$defs/sampleStage",
"description": "(Optional) - Details regarding the sample stage."
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray target in an SEM based CT set-up.",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required) - Details of the pressure maintained in the chamber of the SEM."
},
"electronBeamShift": {
"additionalProperties": false,
"description": "(Required) - The distance by which the electron beam is shifted in the x and y directions.",
"properties": {
"xShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the x direction. Typical unit - \u00b5m."
},
"yShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xShift",
"yShift"
],
"type": "object"
},
"electronProbeCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required) - The electron current measured at the probe. Typical unit - \u00b5A."
},
"objectiveLensAperture": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). Typically the diameter of the aperture is set in \u00b5m."
},
"target": {
"additionalProperties": false,
"description": "(Required) - Details regarding the target in SEM based CT, which upon interaction with the e-beam produces the X-rays.",
"properties": {
"targetDriftCorrection": {
"description": "(Required) - If drift correction is activated for the target, this parameter has to be set to true.",
"type": "boolean"
},
"targetMaterial": {
"description": "(Required) - Material with which the target is made.",
"type": "string"
},
"targetShape": {
"description": "(Optional) - Description of the shape or geometry of the target. e.g. - bulk, foil, needle.",
"type": "string"
},
"targetThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Thickness of the target (dimension in Z direction). Default unit - \u00b5m."
},
"targetTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the target is tilted. Typical unit - degree."
}
},
"required": [
"targetMaterial",
"targetThickness",
"targetDriftCorrection",
"targetTiltAngle",
"targetCurrent"
],
"type": "object"
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. In SEM based CT, the beam is focussed on the target material which emits the X-rays upon interaction with the electrons. Default unit - \u00b5m."
}
},
"required": [
"chamberPressure",
"electronBeamShift",
"workingDistance",
"objectiveLensAperture",
"electronProbeCurrent",
"target"
],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
},
"targetCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current measured at the X-ray target, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"sourceDrift": {
"additionalProperties": false,
"description": "(Optional) - Distance by which the source is shifted during the measurement (i.e., end position - start position).",
"properties": {
"xDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the x direction. Typical unit - \u00b5m."
},
"yDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xDrift",
"yDrift"
],
"type": "object"
},
"sourcePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the source."
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray enrgy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source",
"focalSpotMode",
"CTAquisition",
"geometry",
"sampleStage",
"detector"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer.",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"bioReactor": {
"additionalProperties": false,
"description": "(Optional) - Details of an in situ bioreactor.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in sterile conditions.",
"type": "boolean"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is decreased. Typical unit - K/min."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is increased, typically in K/min."
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"anvil": {
"description": "(Optional) - The type of anvil used in the in situ load frame (stage) for applying a particular type of force on the sample. Option to be selected from a controlled list consisting of - Compression, Diamond indentation 90\u00b0 cone, Diamond indentation cube corner, Diamond indentation wedge, Tension, Other. If 'Other' is selected, specify the name of the anvil with a description in the field 'otherAnvil'.",
"enum": [
"Compression",
"Diamond indentation 90\u00b0 cone",
"Diamond indentation cube corner",
"Diamond indentation wedge",
"Tension",
"Other"
],
"type": "string"
},
"blindAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - ed by the load frame(stage). Example: for a CT normally scanned over 180\u00b0 (e.g. -90\u00b0/+90\u00b0), a blind angle of 40\u00b0 due to the in situ cell implies that only 180\u00b0-40\u00b0=140\u00b0 (e.g. -70\u00b0/70\u00b0) is visible. NOTE: for a CT normally scanned over 360\u00b0 (e.g. -180\u00b0/+180\u00b0), a blind angle of 40\u00b0 would require the subtraction of the blind angle twice, implying two scan ranges of 140\u00b0 each (e.g. -160\u00b0/-20\u00b0 and +20\u00b0/+160\u00b0). Typical unit - degree."
},
"displacement": {
"additionalProperties": false,
"description": "(Optional) - Specification on how displacement is applied on the sample. Either 'displacementRate' in \u00b5m/min or 'displacementIncrement' in \u00b5m/acquisition need to be selected.",
"properties": {
"displacementIncrement": {
"description": "(Optional) - The step at which displacement is changed per acquisition in \u00b5m/acquisition.",
"type": "number"
},
"displacementRate": {
"description": "(Optional) - The rate at which displacement is applied on the sample in \u00b5m/min.",
"type": "number"
}
},
"type": "object"
},
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame or anvil (e.g. - size of anvil) relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
},
"maximumDisplacement": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - The maximum displacement allowed in the selected configuration. Typical unit - \u00b5m."
},
"maximumForce": {
"description": "(Optional) - The maximum force that can be applied to the sample in N.",
"type": "number"
},
"otherAnvil": {
"description": "(Optional) - If 'anvil' was selected as 'Other' from the controlled list as it was not listed, please specify the name of the anvil with a description in this field.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the vacuum chamber relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the vacuum chamber relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the vacuum chamber."
},
"chamberName": {
"description": "(Optional) - Name of the vacuum chamber.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"motorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchical level and direction of a motor.",
"properties": {
"motorDirection": {
"description": "(Required) - The direction of movement (for X,Y,Z,M motors) or axis of rotation (for rotating motors) expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the X-stage and perpendicular to the Y-stage. then beam direction = [1 0 0], X-stage-direction = [1 0 0] (positive movement direction away from source towards detector) or can be (-1 0 0) (towards source) and Y-stage-direction = [0 1 0] or can be [0 -1 0] (analogous interpretation). The parameters need to be individually determined for each instrument. For rotating motors, the directional vector of axis of rotation should be given in Cartesian coordinates (counterclockwise, right-hand rule).",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"motorLevel": {
"description": "(Required) - Hierarchy of the motor expressed as an integer.",
"type": "number"
}
},
"type": "object"
},
"motorPositions": {
"additionalProperties": false,
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the motor.",
"properties": {
"angles": {
"$ref": "#/$defs/angleSet",
"description": "(Optional) - The three tilt angles alpha, beta and gamma of the motors controlling the position of the item."
},
"xyzPositions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - The xyz coordinates describing the motor positions of the item."
}
},
"type": "object"
},
"optics": {
"additionalProperties": false,
"description": "(Optional) - Details about the optics and individual motor positions.",
"properties": {
"collimator": {
"additionalProperties": false,
"description": "(Optional) - Details about the collimator and its individual motor positions.",
"properties": {
"collimatorDetails": {
"description": "(Optional) - Details about the collimator relevant for the measurement.",
"type": "string"
},
"collimatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the collimator."
}
},
"type": "object"
},
"condenser": {
"additionalProperties": false,
"description": "(Optional) - Details about the condenser lens and its individual motor positions, if used.",
"properties": {
"condenserDetails": {
"description": "(Optional) - Details about the condenser relevant for the measurement.",
"type": "string"
},
"condenserPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the condenser."
}
},
"type": "object"
},
"fresnelZonePlate": {
"additionalProperties": false,
"description": "(Optional) - Details about the fresnel zone plate and its individual motor positions, if used.",
"properties": {
"fresnelZonePlateDetails": {
"description": "(Optional) - Details about the fresnel zone plate relevant for the measurement.",
"type": "string"
},
"fresnelZonePlatePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the fresnel zone plate."
}
},
"type": "object"
},
"monochromator": {
"additionalProperties": false,
"description": "(Required) - Details about the monochromator and individual motor positions, if used.",
"properties": {
"monochromatorDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the monochromator type type, material, energy and notes.",
"properties": {
"energy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Energy set in the monochromator. Typical unit - eV"
},
"material": {
"description": "(Optional) - Material of the monochromator.",
"type": "string"
},
"monochromatorType": {
"description": "(Optional) - Type of the monochromator.",
"type": "string"
},
"notes": {
"description": "(Optional) - Additional information about the monochromator relevant for the measurement."
}
},
"type": "object"
},
"monochromatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the monochromator."
},
"monochromatorUsed": {
"description": "(Required) - To be set to true if monochromator is used, else false.",
"type": "boolean"
}
},
"required": [
"monochromatorUsed"
],
"type": "object"
},
"phaseRing": {
"additionalProperties": false,
"description": "(Required) - Details about the phase ring and its individual motor positions, if inserted.",
"properties": {
"phaseRingDetails": {
"description": "(Optional) - Details about the phase ring relevant for the measurement.",
"type": "string"
},
"phaseRingPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the phase ring."
}
},
"type": "object"
}
},
"required": [
"monochromator"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes a parameter which can be split into number of pixels in x and y directions like the resolution",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm or \u00b5m, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "nm",
"description": "(Required) - the unit of the size of a single pixel (typical value - nm, \u00b5m) of datatype string",
"enum": [
"nm",
"\u00b5m"
],
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min, default value - max) of datatype string.",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"default": "W",
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW, default value - W) of datatype string.",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative"
},
"unit": {
"default": "Pa",
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi, default value - Pa)",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"rampDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a rate at which temperature is increased or decreased.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K/min",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K/min, K/s)",
"enum": [
"K/min",
"K/s"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of temperature increase or decrease.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"reconstruction": {
"additionalProperties": false,
"description": "Data from one single reconstruction.",
"properties": {
"reconstructionDetails": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"additionalFilters": {
"beamHardeningCorrection": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"filterType": {
"description": "(Optional) - Type of the additional filter - Median or Gauss",
"enum": [
"Median",
"Gauss"
],
"type": "string"
},
"phaseRetrieval": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"ringFilter": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
}
},
"algorithm": {
"description": "(Required) - Algorithm used for reconstruction to be selected from FBP - Filtered Back Projection, ART - Algebraic Reconstruction Technique, 3dCT - 3D Computed Tomography and Gridrec.",
"enum": [
"FBP - Filtered Back Projection",
"ART - Algebraic Reconstruction Technique",
"3dCT - 3D Computed Tomography",
"Gridrec"
],
"type": "string"
},
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepthConversionMax": {
"description": "(Required) - Maximum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"bitDepthConversionMin": {
"description": "(Required) - Minimum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"hardwarePlatform": {
"description": "(Optional) - Hardware platform used for reconstruction to be selected between CPU and GPU.",
"enum": [
"CPU",
"GPU"
],
"type": "string"
},
"lastImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the last image for the reconstruction of the 3D Volume, typically an integer.",
"type": "string"
},
"projectionPadding": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the projection padding applied to the raw projection data to address certain issues in the reconstruction process.",
"properties": {
"paddingSize": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - Size of the projection padding used in pixels."
},
"paddingType": {
"description": "(Required) - Type of the projection padding used - Zero Padding, Linear Interpolation Padding, Sinc Interpolation Padding, Shepp-Logan Filtered Back Projection (SL-FBP), Gridding and Extended Field of View (FOV) Padding.",
"enum": [
"Zero Padding",
"Linear Interpolation Padding",
"Sinc Interpolation Padding",
"Shepp-Logan Filtered Back Projection (SL-FBP)",
"Gridding",
"Extended Field of View (FOV) Padding"
],
"type": "string"
}
},
"type": "object"
},
"reconstructionSoftware": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for reconstruction. It may be the same as the acquisition software or a different one."
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Scan angle at which the reconstruction of the 3D Volume starts. Typical unit - degree."
},
"startImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the start image for the reconstruction of the 3D Volume.",
"type": "string"
},
"tomographicProjectionFilter": {
"description": "(Optional) - Name of the tomographic projection filter used to be selected from Ram-Lak Filter, Butterworth Filter, Shepp-Logan Filter, Hann (Hanning) Filter, Gaussian Filter, Cosine Filter, Soft Filtration Method and Hard Filtration Method.",
"enum": [
"Ram-Lak Filter",
"Butterworth Filter",
"Shepp-Logan Filter",
"Hann (Hanning) Filter",
"Gaussian Filter",
"Cosine Filter",
"Soft Filtration Method",
"Hard Filtration Method"
],
"type": "string"
}
},
"required": [
"startImage",
"lastImage",
"startAngle",
"hardwarePlatform",
"algorithm",
"binning"
],
"type": "object"
},
"volumeStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each voxel in the 3D volume. The bit depth determines the number of possible intensity levels that can be assigned to each voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Required) - The dimension of the 3D volume in XYZ coordinates. If the length in Z dimension is not known and instead only the number of slices are known, they need to be separately entered in the field 'numberOfSlices'. Typical unit - \u00b5m."
},
"header": {
"additionalProperties": false,
"description": "(Optional) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Optional) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"name": {
"description": "(Required) - Name of the 3D volume structure (dataset).",
"type": "string"
},
"numberOfSlices": {
"description": "(Optional) - No. of slices which make up the 3D volume.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel/voxel, normally expressed in \u00b5m."
},
"volumeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry of the 3D reconstructed volume usually provided by the project or the laboratory."
}
},
"required": [
"name",
"dimensions",
"bitDepth",
"pixelSize"
],
"type": "object"
}
},
"required": [
"volumeStructure",
"reconstructionDetails"
],
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"sampleStage": {
"additionalProperties": false,
"description": "(Required) - Details about sample stage.",
"properties": {
"stageMotorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchy of the stage motors. This information is required to know how the motor movements affect the positions of the samples, particularly relevant for correlative characterization.",
"properties": {
"beamDirection": {
"description": "(Required) - The beam direction expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the Y-stage and perpendicular to the X-stage. then beam direction = [0 1 0].",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"mMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the M motor (stage) as a vector in cartesian coordiantes. The M motor is usually relevant only for SEM based CT. It is a special motor which counteracts the Z motor."
},
"rMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the R motor (stage) as a vector in cartesian coordiantes. R motor has rotation around z axis +1 (for anticlockwise)."
},
"tMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the T motor (stage) as a vector in cartesian coordiantes. The T motor is usually relevant only for SEM based CT."
},
"xMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the X motor (stage) as a vector in cartesian coordinates."
},
"yMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Y motor (stage) as a vector in cartesian coordinates."
},
"zMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Z motor (stage) as a vector in cartesian coordinates."
}
},
"required": [
"beamDirection",
"xMotor",
"yMotor",
"zMotor",
"rMotor"
],
"type": "object"
},
"stageMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the stage motors."
}
},
"required": [
"stageMotorHierarchy"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "K",
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"default": "\u00b5s",
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s default value - \u00b5s) of datatype string",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"user": {
"description": "Basic schema for user description. It can be extended.",
"properties": {
"ORCID": {
"description": "(Optional) - Open Researcher and Contributor ID expressed as a URI",
"pattern": "^https://orcid\\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[X0-9]{1}$",
"type": "string"
},
"affiliation": {
"description": "(Optional) - Details of the institution to which the user is affiliated",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"description": "(Optional) -Identifier of the institution to which the user is affiliated",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be chosen from a controlled list of values (*ROR *GRID *ISNI *URL *DOI *Handle)",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"email": {
"description": "(Optional) - Email of the user",
"format": "email",
"type": "string"
},
"familyName": {
"description": "(Optional) - Family name of the user",
"type": "string"
},
"givenName": {
"description": "(Optional) - Given name of the user",
"type": "string"
},
"role": {
"description": "(Required) - Role of the research user",
"enum": [
"Data Curator",
"Instrument Scientist",
"Team Leader",
"Team Member"
],
"type": "string"
},
"userName": {
"description": "(Required) - Full name of the user in the format (Family Name, Given Name)",
"type": "string"
}
},
"required": [
"userName",
"role"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string.",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"default": "kV",
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV default value - V) of datatype string.",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided. Contributors (in alphabetical order of last names): Alexey Boubnov, Rafaela Debastiani, Jonas Fell, Sarah Irvine, Reetu Elza Joseph.",
"properties": {
"consumables": {
"description": "(Optional) - Auxiliary entity used during Fabrication, Sample Preparation or Measurement which has a limited time capacity or is limited in its number of uses before it is disposed of, necessary to the process itself and normally bought from third party manufacturers. Examples are: gloves, syringes, wipes, etching solutions, glass slides, spatulas, weighing paper, two-sided tape.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"data": {
"$ref": "#/$defs/data",
"description": "(Optional)- Details concerning the data section of the measurement."
},
"definition": {
"description": "(Required) - Name of the schema to which this entry conforms. In this case, lab_CT should be written.",
"type": "string"
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry usually provided by the project or the laboratory."
},
"equipment": {
"description": "(Optional) - Any kind of physical or virtual item, device, machine or other tools used to perform one or more Fabrication(s), Sample Preparation(s), Model Preparation(s), Data Acquisition(s) and/or any of the processes included in the Data Analysis Lifecycle. Usually, the Equipment is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. Equipment is usually an investment. According to this definition, an Instrument is a particular type of Equipment.",
"type": "string"
},
"experimentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the measurement usually provided by the project or the laboratory."
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings. Instrument is a physical or virtual identifiable piece of Equipment used to perform a Data Acquisition and to generate Raw Data. The Instrument is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. A virtual Instrument may be any computational resource or HPC infrastructure (cloud infrastructure or supercomputer) needed to perform Calculations or Simulations."
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure."
},
"measurementDescription": {
"description": "(Optional) - Description about the measurement.",
"type": "string"
},
"measurementPurpose": {
"description": "(Required) - Measurement is experimental Data Acquisition, typically performed on a Sample using an experimental Technique. It may also be performed during Fabrication or Sample Preparation, e.g., to characterise the intermediate stages and/or the final resulting Precursor(s) or Sample(s), respectively. A Measurement may require the use of Consumables.",
"enum": [
"assessment (to given categories or values)",
"completeness check (presence or absence of given properties)",
"correlative characterization (dedicated sample treatment to emphasise given features)",
"exploratory (routine check of known properties)",
"feasibility (quick check, rough estimate)",
"high quality measurement (precise, careful treatment)",
"test specific hypothesis (focus only on given aspects)",
"other (please specify in the comment)"
],
"type": "string"
},
"parents": {
"description": "(Required) - Parents of this metadata like the metadata document of the sample with which the measurement was performed.",
"items": {
"if": {
"properties": {
"parentType": {
"not": {
"const": "not applicable"
}
}
}
},
"properties": {
"parentReference": {
"description": "If type is 'MetaStore URI' it is possible to easily fill this field in a later stage",
"format": "uri-reference",
"type": "string"
},
"parentReferenceType": {
"default": "MetaStore URI",
"enum": [
"plain text",
"external URL",
"MetaStore URI"
],
"type": "string"
},
"parentType": {
"default": "sample",
"enum": [
"not applicable",
"sample"
],
"type": "string"
}
},
"required": [
"parentType"
],
"then": {
"required": [
"parentReferenceType",
"parentReference"
]
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition."
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format."
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"technique": {
"description": "(Required) - Any experimental, theoretical or computational method used during Data Acquisition or during any of the processes included in the Data Analysis Lifecycle to acquire, process or analyse Research Data about a System or a set of them with an Instrument, whihc is used to generate this metadata.",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement.",
"type": "string"
},
"user": {
"$ref": "#/$defs/user",
"description": "(Required)- The contact information of the user responsible for the measurement."
}
},
"required": [
"title",
"technique",
"definition",
"parents",
"measurementPurpose",
"startTime",
"endTime",
"program",
"user",
"instrument",
"data"
],
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 3d952f38e4c5de74526ff427b7b9197bf1f2d9bb | 2024-03-05T17:34:52 | SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"angleDetails": {
"additionalProperties": false,
"description": "Describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"unit": {
"description": "(Optional) - the unit of the value to be selected from a controlled list (degree, radian).",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (pA, nA, \u00b5A, mA, A).",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the current.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m).",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi).",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"stage": {
"additionalProperties": false,
"description": "Describes the stage.",
"properties": {
"activeStage": {
"description": "(Required)- Describes the stage in use",
"type": "string"
},
"specTilt": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional)- Pretilt of the sample, usually due to pretilted holder."
},
"stageM": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional)- M coordinate of the position of the stage (additional translation axis available in Zeiss instruments)"
},
"stageR": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Angle by which the stage is rotated"
},
"stageTa": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Tilt angle alpha of the stage"
},
"stageTb": {
"$ref": "#/$defs/angleDetails",
"description": "(Required)- Tilt angle beta of the stage"
},
"stageX": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- X coordinate of the position of the stage"
},
"stageY": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Y coordinate of the position of the stage"
},
"stageZ": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Z coordinate of the position of the stage"
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. IRI: https://purls.helmholtz-metadaten.de/EMG/00000026"
}
},
"required": [
"workingDistance",
"stageX",
"stageY",
"stageZ",
"stageR",
"stageTa",
"stageTb",
"activeStage"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF).",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"vacuum": {
"additionalProperties": false,
"description": "Describes the vacuum maintained in the system.",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- The pressure maintained in the electron chamber"
},
"gas": {
"description": "(Required)- The gas used in the electron chamber",
"type": "string"
},
"humidity": {
"description": "(Required)- Describes the humidity in the chamber during the measurement",
"type": "string"
},
"userMode": {
"description": "(Required)- The type of vacuum slected by the user",
"enum": [
"High vacuum",
"Medium vacuum",
"Low vacuum"
],
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes an individual image acquired during the course of a SEM/FIB Tomography experiment. Each image is taken using a detector (SE, BSE, EDS, EBSD) at each slice cut using FIB. This Schema contains only the parameters which are specific to the individual image. The parameters which are common to the entire set are described by another schema which describes the dataset as a whole and is located at https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json.",
"properties": {
"creationTime": {
"description": "(Required)- Time of creation of the image",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z?)$",
"type": "string"
},
"definition": {
"description": "(Optional)- Name of the schema to which this entry conforms. In this case, acquisition_image should be written",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Identifier of the image produced by the machine"
},
"fileLink": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Link to the location of the image"
},
"fileName": {
"description": "(Optional)- File name of the image",
"type": "string"
},
"specimenCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional)- Current measured on the specimen during acquisition of the image"
},
"stage": {
"$ref": "#/$defs/stage",
"description": "(Required)- Details concerning stage settings used for aquisition"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional)- Temperature of the sample during acquisition"
},
"vacuum": {
"$ref": "#/$defs/vacuum",
"description": "(Required)- Details concerning the vacuum during aquisition"
}
},
"required": [
"creationTime",
"stage",
"vacuum"
],
"title": "acquisition_image",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | a6c14209fe71debfa246dbfba23a5c933fba6343 | 2024-01-12T12:31:45 | CT/lab_CT.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"CTAquisition": {
"additionalProperties": false,
"description": "(Required) - Details about the acquisition.",
"properties": {
"acquisitionScriptName": {
"description": "(Required) - Name of the script used for acquisition.",
"type": "string"
},
"acquisitionTimePerProjection": {
"$ref": "#/$defs/timeDetails",
"description": "(Required) - Time taken for acquisition of a single projection. Typical unit - s."
},
"angularStepSize": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Step size of the rotation of the sample during the CT. Typical unit - degree."
},
"contrastType": {
"description": "(Required) - The contrast type(mode) used - Absorption Contrast or Phase Contrast. If 'Phase Contrast' is selected, please indicate the used Phase Contrast Mode under the field phaseContrastMode.",
"enum": [
"Absorption Contrast",
"Phase Contrast"
],
"type": "string"
},
"endAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - End angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then endAngle is 180\u00b0. Typical unit - degree."
},
"largeFOV": {
"description": "(Required) - To be set to true if large field of view or wide field of view is used.",
"type": "boolean"
},
"numberOfProjections": {
"description": "(Required) - Number of projections acquired during the CT.",
"type": "number"
},
"phaseContrastMode": {
"description": "(Optional) - The phase contrast mode used during acquisition - Zernike phase contrast, propagation-based, grating-based(Hartmann), grating-based(Talbot).",
"enum": [
"Zernike phase contrast",
"Propagation-based",
"Grating-based(Hartmann)",
"Grating-based(Talbot)"
],
"type": "string"
},
"referenceImages": {
"additionalProperties": false,
"description": "(Optional) - Details on the reference images (if used) - number of flats/bright images and number of dark images.",
"properties": {
"numberOfBrightImages": {
"description": "(Optional) - Number of flats or bright images used as reference.",
"type": "number"
},
"numberOfDarkImages": {
"description": "(Optional) - Number of dark images used as reference.",
"type": "number"
}
},
"type": "object"
},
"scanningMode": {
"description": "(Optional) - The scanning mode used during acquisition - helical, raster scanning, fast CT.",
"enum": [
"Helical",
"Raster Scanning",
"Fast CT"
],
"type": "string"
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Start angle of the rotation of the sample during the CT. If the range is -180\u00b0/180\u00b0, then startAngle is -180\u00b0. Typical unit - degree."
},
"totalAcquisitionTime": {
"description": "(Required) - Time taken for acquisition for the entire scan. This is the total scan time, i.e. number of projections multipled by exposure time, but including read-out time. calculated as EndTime-StartTime. Format: hh:mm:ss.",
"format": "time",
"pattern": "^(\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?)$",
"type": "string"
},
"useBadPixelMap": {
"description": "(Optional) - To be set to true if bad pixel map is used. This parameter is relevant for SEM based CT.",
"type": "boolean"
}
},
"required": [
"acquisitionScriptName",
"startAngle",
"endAngle",
"angularStepSize",
"acquisitionTimePerProjection",
"totalAcquisitionTime",
"largeFOV",
"contrastType"
],
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (degree, radian) of datatype string.",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"angleSet": {
"additionalProperties": false,
"description": "(Optional) - Tilt angles alpha, beta and gamma decribing the three angular positions of an item.",
"properties": {
"alpha": {
"description": "(Optional) - Tilt angle alpha of the item.",
"type": "number"
},
"anglesUnit": {
"description": "(Optional) - unit of the angles (allowed units - degree or radian)",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"beta": {
"description": "(Optional) - Rotation angle beta of the item.",
"type": "number"
},
"gamma": {
"description": "(Optional) - Angle gamma of the item.",
"type": "number"
}
},
"type": "object"
},
"apertureSettingType": {
"additionalProperties": false,
"description": "The setting for controlling the aperture size, using either the aperture size directly or indirectly using the beam current. Therefore one of the two properties must be selected: size or current.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the beam current setting which would indirectly control the size of the aperture defined separately as currentDetails"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - the size of the aperture which can be directly controlled using the instrument settings defined separately as distanceDetails"
}
},
"type": "object"
},
"coordinateSet": {
"additionalProperties": false,
"description": "The set of xyz values describing a point of reference for correlative characterization.",
"properties": {
"coordinatesUnit": {
"description": "(Optional) - unit of the coordinates (allowed units - nm, \u00b5m, mm, cm, m)",
"enum": [
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"xUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - uncertainty in the x value defined separately as uncertaintyDetails"
},
"xValue": {
"description": "(Optional) - value of the x coordinate of datatype number",
"type": "number"
},
"yUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the y value defined separately as uncertaintyDetails"
},
"yValue": {
"description": "(Optional) - value of the y coordinate of datatype number",
"type": "number"
},
"zUncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) -uncertainty in the z value defined separately as uncertaintyDetails"
},
"zValue": {
"description": "(Optional) - value of the zcoordinate of datatype number",
"type": "number"
}
},
"required": [
"xValue",
"yValue",
"zValue",
"coordinatesUnit"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A).",
"enum": [
"pA",
"nA",
"\u00b5A",
"mA",
"A"
],
"type": "string"
},
"value": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"data": {
"additionalProperties": false,
"description": "(Required) - Details about the data section of the measurement.",
"properties": {
"projections": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"cropping": {
"additionalProperties": false,
"description": "(Optional) - Details about cropping or clipping to select a region of interest(ROI).",
"properties": {
"ROI": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The size of the region of interest (ROI) in integer values of xPixels and yPixels."
},
"offset": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The offset applied to the origin (i.e., centre of the image) to select the region of interest in x and y coordinates."
}
},
"required": [
"ROI",
"offset"
],
"type": "object"
},
"projectionImageDataStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the data structure of the image data of the projections.",
"properties": {
"IOValue": {
"description": "(Required) - The IO value obtained from the metadata.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - The dimension of the image as for integer values of xPixels and yPixels."
},
"fileLocation": {
"description": "(Required) - The location where the data file is stored. A URL is preferred if available.",
"type": "string"
},
"greyValueRepresentation": {
"description": "(Optional) - Description about the grey value representation.",
"type": "string"
},
"header": {
"additionalProperties": false,
"description": "(Required) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Required) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"imageCorrection": {
"additionalProperties": false,
"description": "(Optional) - Details about the image correction.",
"properties": {
"isImageCorrected": {
"description": "(Required) - To be set as true if image is corrected.",
"type": "boolean"
},
"linkToReferenceImages": {
"description": "(Required) - Link to the reference images (flats/darks).",
"format": "uri-reference",
"type": "string"
}
},
"required": [
"isImageCorrected",
"linkToReferenceImages"
],
"type": "object"
},
"imageFormats": {
"additionalProperties": false,
"description": "(Required) - The file formats of the images - tiff, png, jpeg. When more than one file formats are there, then the formats are to be entered as an array of strings.",
"properties": {
"fileFormats": {
"oneOf": [
{
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
{
"items": {
"enum": [
"tiff",
"jpeg",
"png"
],
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"fileFormats"
],
"type": "object"
},
"imageID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the Image Data."
},
"isPreFiltered": {
"description": "(Optional) - To be set as true if image is prefiltered.",
"type": "boolean"
},
"name": {
"description": "(Required) - Name of the Projection Image Data.",
"type": "string"
},
"numberOfImages": {
"description": "(Required) - Number of images in the data set. It is same as the number of projections.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical x,y length imaged by a single pixel, normally expressed in \u00b5m."
}
},
"required": [
"fileLocation",
"name",
"imageFormats",
"header"
],
"type": "object"
}
},
"required": [
"projectionImageDataStructure"
],
"type": "object"
},
"reconstructedData": {
"additionalProperties": false,
"description": "(Required) - Details about the reconstructed slices. When multiple reconstructions of the same raw data (projections) are present, the corresponding data can be combined as an array of reconstruction data sets, else as a single reconstruction data set.",
"properties": {
"reconstruction": {
"oneOf": [
{
"$ref": "#/$defs/reconstruction"
},
{
"items": {
"$ref": "#/$defs/reconstruction"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"reconstruction"
],
"type": "object"
}
},
"required": [
"projections",
"reconstructedData"
],
"type": "object"
},
"detector": {
"additionalProperties": false,
"description": "gives the settings of a detector or multiple detectors.",
"properties": {
"detectorSettings": {
"oneOf": [
{
"$ref": "#/$defs/detectorSettings"
},
{
"items": {
"$ref": "#/$defs/detectorSettings"
},
"minItems": 2,
"type": "array"
}
]
}
},
"required": [
"detectorSettings"
],
"type": "object"
},
"detectorSettings": {
"additionalProperties": false,
"description": "(Required) - Gives the settings of a single detector.",
"properties": {
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each pixel or voxel in an image. The bit depth determines the number of possible intensity levels that can be assigned to each pixel or voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"cameraGain": {
"description": "(Optional) - The amplification (gain) of the signal from an image sensor in a camera.",
"type": "number"
},
"detectorCoolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Cooling temperature of the detector, if it cooled. Relevant for SEM based CT. Typical unit - K."
},
"detectorDimensions": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Optional) - The dimensions of the detector in integer values of xPixels and yPixels."
},
"detectorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the detector."
},
"detectorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the detector (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"detectorMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - The motor positions of the detector in cartesian coordinates and tilt angles."
},
"detectorName": {
"description": "(Optional) - Name of the detector of datatype string.",
"type": "string"
},
"detectorPixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Optional) - Physical length in cartesian coordinates imaged by a single pixel of the detector. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"detectorType": {
"description": "(Optional) - The type of detector to be selected from a controlled list consisting of CCD, Panel, PCXD, CMOS, Time-Delay Integration (TDI) and Direct Conversion.",
"enum": [
"CCD",
"Panel",
"PCXD",
"CMOS",
"Time-Delay Integration (TDI)",
"Direct Conversion"
],
"type": "string"
},
"energyThreshold": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - A specific energy level used to filter the detected radiation."
},
"exposureTimePerFrame": {
"$ref": "#/$defs/timeDetails",
"description": "(Optional) - Time for which the sample is exposed per frame. Typical unit - s."
},
"frameSkip": {
"additionalProperties": false,
"description": "(Optional) - A numerical representation indicating the number of frames that are skipped or omitted during the acquisition or recording process. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3. If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped.",
"properties": {
"value": {
"oneOf": [
{
"description": "(Optional) - Number of frames skipped during acquisition. E.g. - If every other frame is skipped, the value is 2. If every third frame is skipped, the value is 3.",
"type": "number"
},
{
"description": "(Optional) - Pattern of frames skipped during acquisition. E.g. - If frames are skipped at irregular intervals, the value might be a list or pattern indicating the specific frames to be skipped like [1,3,5]",
"items": {
"type": "number"
},
"minItems": 1,
"type": "array"
}
]
}
},
"type": "object"
},
"framesPerSecond": {
"description": "(Optional) - The number of frames captured in a second.",
"type": "number"
},
"imagePixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical length in cartesian coordinates imaged by a single pixel of the image. It is the native pixel size divided by the total magnification. The y-pixel-size is to be given only if it is different from the x-pixel-size. Typical pixel size - \u00b5m."
},
"lens": {
"additionalProperties": false,
"description": "(Optional) - Details of a lens, if used with the detector.",
"properties": {
"hasLens": {
"description": "(Required) - To be set to true if the detector has a lens.",
"type": "boolean"
},
"lensFocalLength": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Focal length of the lens."
},
"lensID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the lens."
},
"lensMagnification": {
"description": "(Optional) - Magnification of the lens as a floating point number.",
"type": "number"
},
"lensManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the lens (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"lensName": {
"description": "(Optional) - Name of the lens of datatype string.",
"type": "string"
}
},
"required": [
"lensMagnification",
"lensFocalLength"
],
"type": "object"
},
"numberOfAveragedFramesPerProjection": {
"description": "(Optional) - The number of averaged frames per projection, if averaging is done.",
"type": "number"
},
"sensor": {
"additionalProperties": false,
"description": "(Optional) - Details about a sensor, if present.",
"properties": {
"hasSensor": {
"description": "(Required) - To be set to true if the detector has a sensor.",
"type": "boolean"
},
"sensorID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier for the sensor."
},
"sensorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Describes the details of the manufacturer of the sensor (manufacturerName, modelName and manufacturerID) as part of manufacturerDetails."
},
"sensorMaterial": {
"description": "(Optional) - Material of the sensor of datatype string.",
"type": "string"
},
"sensorName": {
"description": "(Optional) - Name of the sensor of datatype string.",
"type": "string"
},
"sensorThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the sensor."
},
"sensorType": {
"description": "(Optional) - The type of sensor as a string.",
"type": "string"
}
},
"required": [
"hasSensor"
],
"type": "object"
},
"temperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Temperature of the detector."
},
"totalCountsPerProjection": {
"description": "(Optional) - The sum of the intensity values recorded by the X-ray detector for a single projection during a scan.",
"type": "number"
}
},
"required": [
"detectorType",
"detectorManufacturer",
"binning",
"detectorMotorPositions",
"imagePixelSize"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (fm, pm, nm, \u00b5m, mm, cm, m).",
"enum": [
"fm",
"pm",
"nm",
"\u00b5m",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"energyDetails": {
"additionalProperties": false,
"description": "describes an energy.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails giving the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (meV, eV, keV, MeV, nJ, \u00b5J, mJ, J, kJ, MJ).",
"enum": [
"meV",
"eV",
"keV",
"MeV",
"nJ",
"mJ",
"\u00b5J",
"J",
"kJ",
"MJ"
],
"type": "string"
},
"value": {
"description": "(Required) - The energy expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"flowRateDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes the rate (volume/time) of a flow.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (mL/min, \u00b5L/min, cm3/min ( or cc/min). Typical unit - cm3/min).",
"enum": [
"cm3/min",
"mL/min",
"\u00b5L/min"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of flow (volume/unit time).",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"geometry": {
"additionalProperties": false,
"description": "Describes the geometry of the CT instrument",
"properties": {
"beamGeometry": {
"additionalProperties": false,
"description": "(Required) - Details about beam geometry like beam geometry type and divergence angle.",
"properties": {
"beamGeometryType": {
"description": "(Required) - The type of the beam geometry to be selected between 'collimated' and 'divergent'.",
"enum": [
"collimated",
"divergent"
],
"type": "string"
},
"divergenceAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - Angle of divergence when the beam geometry is divergent. Typical unit - degree."
}
},
"type": "object"
},
"geometricMagnification": {
"description": "(Required) - Geometric magnification refers to the ratio of the size of an object's image to the size of the object itself. It is a measure of how much larger the image appears compared to the actual object. Geometric magnification (M) is calculated using the formula M = (SID + SOD) / SID, where SID is the source-to-image distance and SOD is the source-to-object distance.",
"type": "number"
},
"objectToDetectorDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the object and the detector. Typical unit - \u00b5m."
},
"opticalMagnification": {
"description": "(Required) - Optical magnification is calculated as the ratio of the focal length of the objective lens to the focal length of the eyepiece (if an eyepiece is present) in a traditional optical microscope.",
"type": "number"
},
"sourceToObjectDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Distance between the source and the object. Typical unit - \u00b5m."
}
},
"required": [
"sourceToObjectDistance",
"objectToDetectorDistance",
"beamGeometry",
"geometricMagnification",
"opticalMagnification"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"instrumentDetails": {
"additionalProperties": false,
"description": "(Required) - Details giving the relevant components and settings of the instrument.",
"properties": {
"CTAquisition": {
"$ref": "#/$defs/CTAquisition",
"description": "(Optional) - Details regarding the acquisition."
},
"calibration": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the calibration and the scaling factor.",
"properties": {
"calibrationType": {
"description": "(Optional) - Type of calibration as a string.",
"type": "string"
},
"lastCalibration": {
"description": "(Optional) - date and time of last calibration (YYYY-MM-DDThh:mm:ss.sss) in the ISO 8601 date-time format",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"systemScaling": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the scaling factor.",
"properties": {
"adjustSystemScaling": {
"description": "(Required) - To be set to true if system scaling is adjusted, else false.",
"type": "boolean"
},
"measuredScalingFactor": {
"description": "(Optional) - Value of the measured scaling factor.",
"type": "number"
},
"referenceScalingFactor": {
"description": "(Optional) - Value of the reference scaling factor, determined ususally during the data processing.",
"type": "number"
}
},
"required": [
"adjustSystemScaling"
],
"type": "object"
}
},
"type": "object"
},
"detector": {
"$ref": "#/$defs/detector",
"description": "(Optional) - Details regarding the detector."
},
"focalSpotMode": {
"additionalProperties": false,
"description": "(Optional) - Option for setting the size of the focal spot. Some sources have the option to select the target spot size, or focal spot size absolutely by setting a value, while some others give the option of selecting 'small', 'medium' or 'large'. Smaller spot size = higher resolution. Note that the power/current will change with this value. In addition, the detector settings will usually be selected in conjunction. (different scintillator/lens/magnification).",
"properties": {
"selection": {
"description": "(Optional) - Selection of the setting of the size of the focal spot when the option for setting the size of the focal spot by selecting 'small', 'medium' or 'large' according to predefined values set by the manufacturer.",
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"size": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Size of the target spot when the option for setting the size of the focal spot absolutely by setting a value is available."
}
},
"type": "object"
},
"geometry": {
"$ref": "#/$defs/geometry",
"description": "(Optional) - Details regarding the geometry."
},
"instrumentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the instrument."
},
"instrumentManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Required) - Details about the manufacturer or vendor of the instrument"
},
"instrumentName": {
"description": "(Required) - Name of the instrument.",
"type": "string"
},
"instrumentType": {
"description": "(Required) - Type of the instrument used for CT - Regular Lab-CT or SEM based CT. Applications working with the schema can then enable selected fields based on this choice.",
"enum": [
"Regular Lab-CT",
"SEM based CT"
],
"type": "string"
},
"optics": {
"$ref": "#/$defs/optics",
"description": "(Optional) - Details about the optics and individual motor positions."
},
"sampleStage": {
"$ref": "#/$defs/sampleStage",
"description": "(Optional) - Details regarding the sample stage."
},
"source": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray source, separated in two groups - regular Lab CT and SEM based CT.",
"properties": {
"SEMBasedCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the E-Beam source and X-ray target in an SEM based CT set-up.",
"properties": {
"chamberPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required) - Details of the pressure maintained in the chamber of the SEM."
},
"electronBeamShift": {
"additionalProperties": false,
"description": "(Required) - The distance by which the electron beam is shifted in the x and y directions.",
"properties": {
"xShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the x direction. Typical unit - \u00b5m."
},
"yShift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Beam shift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xShift",
"yShift"
],
"type": "object"
},
"electronProbeCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Required) - The electron current measured at the probe. Typical unit - \u00b5A."
},
"objectiveLensAperture": {
"$ref": "#/$defs/apertureSettingType",
"description": "(Required) - The setting for controlling the aperture size, using either the aperture size (directly) or the beam current (indirectly). Typically the diameter of the aperture is set in \u00b5m."
},
"target": {
"additionalProperties": false,
"description": "(Required) - Details regarding the target in SEM based CT, which upon interaction with the e-beam produces the X-rays.",
"properties": {
"targetDriftCorrection": {
"description": "(Required) - If drift correction is activated for the target, this parameter has to be set to true.",
"type": "boolean"
},
"targetMaterial": {
"description": "(Required) - Material with which the target is made.",
"type": "string"
},
"targetShape": {
"description": "(Optional) - Description of the shape or geometry of the target. e.g. - bulk, foil, needle.",
"type": "string"
},
"targetThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Thickness of the target (dimension in Z direction). Default unit - \u00b5m."
},
"targetTiltAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - angle by which the target is tilted. Typical unit - degree."
}
},
"required": [
"targetMaterial",
"targetThickness",
"targetDriftCorrection",
"targetTiltAngle",
"targetCurrent"
],
"type": "object"
},
"workingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required)- Distance which is determined along the optical axis within the column from (1) the lower end of the final optical element between the source and the specimen stage; to (2) the point where the beam is focused. In SEM based CT, the beam is focussed on the target material which emits the X-rays upon interaction with the electrons. Default unit - \u00b5m."
}
},
"required": [
"chamberPressure",
"electronBeamShift",
"workingDistance",
"objectiveLensAperture",
"electronProbeCurrent",
"target"
],
"type": "object"
},
"regularLabCT": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the X-ray source in a lab scale CT instrument",
"properties": {
"PowerOrCurrentSetting": {
"additionalProperties": false,
"description": "(Required) - The power or current setiing set on the X-ray tube. Depending on the manufacturer either one of power or current can be set and one of these values is required.",
"properties": {
"current": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - Current set in the X-ray source (Tube Current). Default unit - \u00b5A."
},
"power": {
"$ref": "#/$defs/powerDetails",
"description": "(Optional) - Power set in the X-ray source. Default unit - W."
}
},
"type": "object"
},
"anode": {
"additionalProperties": false,
"description": "(Optional) - Details about the anode.",
"properties": {
"anodeMaterial": {
"description": "(Optional) - Material of the anode. e.g. - Cr.",
"type": "string"
},
"anodeType": {
"description": "(Optional) - Type of anode in the X-ray tube. e.g. - rotating anode, liquid jet anode, etc.",
"type": "string"
},
"targetCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "(Optional) - the current measured at the X-ray target, defined separately as currentDetails (includes the current value, optional uncertainty, optional qualifier like max or min, optional note of the type string, and a controlled list of units from which one can be chosen - pA, nA, uA, mA, A, kA)"
}
},
"type": "object"
},
"cathode": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the cathode of the X-ray tube",
"properties": {
"cathodeDetails": {
"description": "(Optional) - Additional details regarding the cathode relevant for the measurement.",
"type": "string"
},
"cathodeMaterial": {
"description": "(Optional) - Material with which the cathode is made. e.g. - tungsten (W)",
"type": "string"
}
},
"type": "object"
},
"sourceDrift": {
"additionalProperties": false,
"description": "(Optional) - Distance by which the source is shifted during the measurement (i.e., end position - start position).",
"properties": {
"xDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the x direction. Typical unit - \u00b5m."
},
"yDrift": {
"$ref": "#/$defs/distanceDetails",
"description": "(Required) - Drift in the y direction. Typical unit - \u00b5m."
}
},
"required": [
"xDrift",
"yDrift"
],
"type": "object"
},
"sourcePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the source."
},
"tubeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the X-ray tube."
},
"tubeManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details regarding the manufacturer of the X-ray tube."
},
"tubeName": {
"description": "(Optional) - Name of the X-ray tube.",
"type": "string"
},
"voltage": {
"$ref": "#/$defs/voltageDetails",
"description": "(Optional) - Voltage set in the X-ray source (Tube Voltage)Please specify in the notes if peak kilovoltage(kVp) is only known instead of tube voltage. Default unit - kV."
},
"xrayEnergySpectrum": {
"additionalProperties": false,
"description": "(Required) - Details regarding the X-ray enrgy spectrum like chromaticity, characteristic line, filters used, etc.",
"properties": {
"chromaticity": {
"default": "polychromatic",
"description": "(Required) - Describes if the x-rays are monochromatic or polychromatic. Default value is polychromatic.",
"enum": [
"monochromatic",
"polychromatic"
],
"type": "string"
},
"energyFilter": {
"additionalProperties": false,
"description": "(Required) - Description of the filter(s) used. If no energy filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"comments": {
"description": "(Optional) - Additional comments to include relevant information for the measurement. Sometimes energy filter specifications are confidential, in this case, this field can be used to give the link to the list of energy filters provided by the manufacturer.",
"type": "string"
},
"filter1": {
"description": "(Required) - Description of the primary energy filter. When no filter is used, the material of the primary energy filter is to be set as none/air.",
"properties": {
"filterMaterial": {
"default": "none/air",
"description": "(Required) - Material of the primary energy filter. default - none/air.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the primary energy filter."
}
},
"required": [
"filterMaterial"
],
"type": "object"
},
"filter2": {
"description": "(Optional) - Description of a second energy filter used in addition to the primary energy filter. ",
"properties": {
"filterMaterial": {
"description": "(Optional) - Material of the additional energy filter.",
"type": "string"
},
"filterThickness": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - Thickness of the additional energy filter."
}
},
"type": "object"
}
},
"required": [
"filter1"
],
"type": "object"
},
"xrayCharacteristicEnergy": {
"$ref": "#/$defs/energyDetails",
"description": "(Required) - Describes the characteristic energy of the X-ray spectrum. Default unit - keV."
},
"xrayCharacteristicLine": {
"description": "(Required) - Describes the characteristic line of the X-ray spectrum. e.g.- Cr K alpha, W K alpha.",
"type": "string"
}
},
"required": [
"chromaticity",
"xrayCharacteristicLine",
"xrayCharacteristicEnergy",
"energyFilter"
],
"type": "object"
}
},
"required": [
"PowerOrCurrentSetting",
"voltage",
"xrayEnergySpectrum"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"instrumentName",
"instrumentManufacturer",
"instrumentType",
"source",
"focalSpotMode",
"CTAquisition",
"geometry",
"sampleStage",
"detector"
],
"type": "object"
},
"manufacturerDetails": {
"additionalProperties": false,
"description": "(Optional) - Details about the manufacturer or vendor of the instrument. Properties: manufacturerName (Optional) - Name of the manufacturer, modelName (Optional) - Model of the instrument, manufacturerID (Optional) - Identifier of the manufacturer.",
"properties": {
"manufacturerID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the manufacturer"
},
"manufacturerName": {
"description": "(Optional) - Name of the manufacturer",
"type": "string"
},
"modelName": {
"description": "(Optional) - Model of the instrument",
"type": "string"
}
},
"type": "object"
},
"measurementConditions": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure.",
"properties": {
"ambientPressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Optional) - Details about the ambient pressure in the lab."
},
"roomHumidity": {
"description": "(Optional) - Details about the humidity in the lab expressed in percentage.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"roomTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Optional) - Details about the room temperature in the lab."
},
"sampleEnvironment": {
"description": "Details concerning the measurement conditions specific to the sample as opposed to the ambient conditions.",
"properties": {
"batchCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ batch cell.",
"properties": {
"batchCellType": {
"description": "(Required) - Type of the batch cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"cellDetails": {
"description": "(Optional) - Additional details about the batch cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the batch cell."
},
"cellName": {
"description": "(Optional) - Name of the batch cell",
"type": "string"
},
"medium": {
"description": "(Required) - Name of the liquid of gas used in the batch cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"medium",
"batchCellType"
],
"type": "object"
},
"bioReactor": {
"additionalProperties": false,
"description": "(Optional) - Details of an in situ bioreactor.",
"properties": {
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Required) - The pH value maintained in the in situ cell.",
"type": "number"
},
"sterileConditions": {
"description": "(Optional) - To be set to true if the sample has to be handled in sterile conditions.",
"type": "boolean"
}
},
"required": [
"pHValue"
],
"type": "object"
},
"coolingCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a cocooling cell used to cool the sample to a lower temperature.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the cooling cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the cooling cell."
},
"cellName": {
"description": "(Optional) - Name of the cooling cell.",
"type": "string"
},
"coolingTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the cooling furnace is to be maintained."
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is decreased. Typical unit - K/min."
}
},
"required": [
"coolingTemperature"
],
"type": "object"
},
"corrosionCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a corrosion cell used to expose the sample to a controlled corrosive environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the corrosion cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the corrosion cell."
},
"cellName": {
"description": "(Optional) - Name of the corrosion cell.",
"type": "string"
},
"corrosionCelltype": {
"description": "(Required) - Type of the corrosion cell based on the environment inside - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"corrosionCelltype"
],
"type": "object"
},
"degradationCell": {
"additionalProperties": false,
"description": "(Optional) - Details regarding a degradation cell relevant for the measurement.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the degradation cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the degradation cell."
},
"cellName": {
"description": "(Optional) - Name of the degradation cell.",
"type": "string"
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"type": "object"
},
"flowCell": {
"additionalProperties": false,
"description": "(Optional) - Details about an in situ flow cell.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the flow cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the flow cell."
},
"cellName": {
"description": "(Optional) - Name of the flow cell.",
"type": "string"
},
"flowCellType": {
"description": "(Required) - Type of the flow cell - liquid or gas.",
"enum": [
"liquid",
"gas"
],
"type": "string"
},
"flowComposition": {
"description": "(Required) - Composition of the gas or liquid in the flow cell.",
"type": "string"
},
"flowRate": {
"$ref": "#/$defs/flowRateDetails",
"description": "(Required) - Rate of flow of the liquid or gas in the flow cell."
},
"pHDetails": {
"description": "(Optional) - Additional details about the pH in the in situ cell.",
"type": "string"
},
"pHValue": {
"description": "(Optional) - The pH value maintained in the in situ cell.",
"type": "number"
}
},
"required": [
"flowRate",
"flowComposition",
"flowCellType"
],
"type": "object"
},
"furnace": {
"additionalProperties": false,
"description": "(Optional) - Details about a furnace used to heat the sample or to keep it at a particular temperature.",
"properties": {
"furnaceDetails": {
"description": "(Optional) - Additional details about the furnace relevant for the measurement.",
"type": "string"
},
"furnaceManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the furnace."
},
"furnaceName": {
"description": "(Optional) - Name of the furnace.",
"type": "string"
},
"ramp": {
"$ref": "#/$defs/rampDetails",
"description": "(Optional) - The rate at which temperature is increased, typically in K/min."
},
"setPointTemperature": {
"$ref": "#/$defs/temperatureDetails",
"description": "(Required) - Final Temperature or temperature at which the furnace is to be maintained."
}
},
"required": [
"setPointTemperature"
],
"type": "object"
},
"humidificationCell": {
"additionalProperties": false,
"description": "(Optional) - Details about a humidification cell used to keep the sample in a controlled humid environment.",
"properties": {
"cellDetails": {
"description": "(Optional) - Additional details about the humidification cell relevant for the measurement.",
"type": "string"
},
"cellManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the humidification cell."
},
"cellName": {
"description": "(Optional) - Name of the humidification cell.",
"type": "string"
}
},
"type": "object"
},
"inSituCellType": {
"description": "(Optional) - The type of the in situ cell used, which is to be selected from a controlled list (enum). Based on the selected in situ cell type, the corresponding cell details can be populated or identified by other applications using the schema.",
"enum": [
"load frame",
"furnace",
"humidification cell",
"corrosion cell",
"cooling cell",
"micro manipulator",
"batch cell",
"flow cell",
"bio reactor",
"degradation cell",
"vacuum chamber"
],
"type": "string"
},
"loadFrame": {
"additionalProperties": false,
"description": "(Optional) - Details about a load frame which is a high stiffness support structure used to apply different types of test forces on the sample.",
"properties": {
"anvil": {
"description": "(Optional) - The type of anvil used in the in situ load frame (stage) for applying a particular type of force on the sample. Option to be selected from a controlled list consisting of - Compression, Diamond indentation 90\u00b0 cone, Diamond indentation cube corner, Diamond indentation wedge, Tension, Other. If 'Other' is selected, specify the name of the anvil with a description in the field 'otherAnvil'.",
"enum": [
"Compression",
"Diamond indentation 90\u00b0 cone",
"Diamond indentation cube corner",
"Diamond indentation wedge",
"Tension",
"Other"
],
"type": "string"
},
"blindAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - ed by the load frame(stage). Example: for a CT normally scanned over 180\u00b0 (e.g. -90\u00b0/+90\u00b0), a blind angle of 40\u00b0 due to the in situ cell implies that only 180\u00b0-40\u00b0=140\u00b0 (e.g. -70\u00b0/70\u00b0) is visible. NOTE: for a CT normally scanned over 360\u00b0 (e.g. -180\u00b0/+180\u00b0), a blind angle of 40\u00b0 would require the subtraction of the blind angle twice, implying two scan ranges of 140\u00b0 each (e.g. -160\u00b0/-20\u00b0 and +20\u00b0/+160\u00b0). Typical unit - degree."
},
"displacement": {
"additionalProperties": false,
"description": "(Optional) - Specification on how displacement is applied on the sample. Either 'displacementRate' in \u00b5m/min or 'displacementIncrement' in \u00b5m/acquisition need to be selected.",
"properties": {
"displacementIncrement": {
"description": "(Optional) - The step at which displacement is changed per acquisition in \u00b5m/acquisition.",
"type": "number"
},
"displacementRate": {
"description": "(Optional) - The rate at which displacement is applied on the sample in \u00b5m/min.",
"type": "number"
}
},
"type": "object"
},
"loadFrameDetails": {
"description": "(Optional) - Additional details about the load frame or anvil (e.g. - size of anvil) relevant for the measurement.",
"type": "string"
},
"loadFrameManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the load frame."
},
"loadFrameName": {
"description": "(Optional) - Name of the load frame.",
"type": "string"
},
"maximumDisplacement": {
"$ref": "#/$defs/distanceDetails",
"description": "(Optional) - The maximum displacement allowed in the selected configuration. Typical unit - \u00b5m."
},
"maximumForce": {
"description": "(Optional) - The maximum force that can be applied to the sample in N.",
"type": "number"
},
"otherAnvil": {
"description": "(Optional) - If 'anvil' was selected as 'Other' from the controlled list as it was not listed, please specify the name of the anvil with a description in this field.",
"type": "string"
}
},
"type": "object"
},
"mediumSpecification": {
"description": "(Optional) - Specification or details of the medium of the in situ cell relevant for the measurement. ",
"type": "string"
},
"micromanipulator": {
"additionalProperties": false,
"description": "(Optional) - Details about a micromanipulator used to work with the sample during the measurement.",
"properties": {
"micromanipulatorDetails": {
"description": "(Required) - Details about the micromanipulator relevant for the measurement."
},
"micromanipulatorManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the micromanipulator."
},
"micromanipulatorName": {
"description": "(Optional) - Name of the micromanipulator.",
"type": "string"
}
},
"required": [
"micromanipulatorDetails"
],
"type": "object"
},
"vacuumChamber": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the vacuum chamber relevant for the measurement.",
"properties": {
"chamberDetails": {
"description": "(Optional) - Additional details about the vacuum chamber relevant for the measurement.",
"type": "string"
},
"chamberManufacturer": {
"$ref": "#/$defs/manufacturerDetails",
"description": "(Optional) - Details about the manufacturer or vendor of the vacuum chamber."
},
"chamberName": {
"description": "(Optional) - Name of the vacuum chamber.",
"type": "string"
},
"pressure": {
"$ref": "#/$defs/pressureDetails",
"description": "(Required)- Details of the pressure maintained in the vacuum chamber."
}
},
"required": [
"pressure"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"motorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchical level and direction of a motor.",
"properties": {
"motorDirection": {
"description": "(Required) - The direction of movement (for X,Y,Z,M motors) or axis of rotation (for rotating motors) expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the X-stage and perpendicular to the Y-stage. then beam direction = [1 0 0], X-stage-direction = [1 0 0] (positive movement direction away from source towards detector) or can be (-1 0 0) (towards source) and Y-stage-direction = [0 1 0] or can be [0 -1 0] (analogous interpretation). The parameters need to be individually determined for each instrument. For rotating motors, the directional vector of axis of rotation should be given in Cartesian coordinates (counterclockwise, right-hand rule).",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"motorLevel": {
"description": "(Required) - Hierarchy of the motor expressed as an integer.",
"type": "number"
}
},
"type": "object"
},
"motorPositions": {
"additionalProperties": false,
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the motor.",
"properties": {
"angles": {
"$ref": "#/$defs/angleSet",
"description": "(Optional) - The three tilt angles alpha, beta and gamma of the motors controlling the position of the item."
},
"xyzPositions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Optional) - The xyz coordinates describing the motor positions of the item."
}
},
"type": "object"
},
"optics": {
"additionalProperties": false,
"description": "(Optional) - Details about the optics and individual motor positions.",
"properties": {
"collimator": {
"additionalProperties": false,
"description": "(Optional) - Details about the collimator and its individual motor positions.",
"properties": {
"collimatorDetails": {
"description": "(Optional) - Details about the collimator relevant for the measurement.",
"type": "string"
},
"collimatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the collimator."
}
},
"type": "object"
},
"condenser": {
"additionalProperties": false,
"description": "(Optional) - Details about the condenser lens and its individual motor positions, if used.",
"properties": {
"condenserDetails": {
"description": "(Optional) - Details about the condenser relevant for the measurement.",
"type": "string"
},
"condenserPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the condenser."
}
},
"type": "object"
},
"fresnelZonePlate": {
"additionalProperties": false,
"description": "(Optional) - Details about the fresnel zone plate and its individual motor positions, if used.",
"properties": {
"fresnelZonePlateDetails": {
"description": "(Optional) - Details about the fresnel zone plate relevant for the measurement.",
"type": "string"
},
"fresnelZonePlatePositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the fresnel zone plate."
}
},
"type": "object"
},
"monochromator": {
"additionalProperties": false,
"description": "(Required) - Details about the monochromator and individual motor positions, if used.",
"properties": {
"monochromatorDetails": {
"additionalProperties": false,
"description": "(Optional) - Details of the monochromator type type, material, energy and notes.",
"properties": {
"energy": {
"$ref": "#/$defs/energyDetails",
"description": "(Optional) - Energy set in the monochromator. Typical unit - eV."
},
"material": {
"description": "(Optional) - Material of the monochromator.",
"type": "string"
},
"monochromatorType": {
"description": "(Optional) - Type of the monochromator.",
"type": "string"
},
"notes": {
"description": "(Optional) - Additional information about the monochromator relevant for the measurement."
}
},
"type": "object"
},
"monochromatorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the monochromator."
},
"monochromatorUsed": {
"description": "(Required) - To be set to true if monochromator is used, else false.",
"type": "boolean"
}
},
"required": [
"monochromatorUsed"
],
"type": "object"
},
"phaseRing": {
"additionalProperties": false,
"description": "(Required) - Details about the phase ring and its individual motor positions, if inserted.",
"properties": {
"phaseRingDetails": {
"description": "(Optional) - Details about the phase ring relevant for the measurement.",
"type": "string"
},
"phaseRingPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the phase ring."
}
},
"type": "object"
}
},
"required": [
"monochromator"
],
"type": "object"
},
"pixelNumberType": {
"additionalProperties": false,
"description": "describes a parameter which can be split into number of pixels in x and y directions like the resolution",
"properties": {
"xPixels": {
"description": "(Required) - no. of pixels in horizontal direction of datatype number",
"type": "number"
},
"yPixels": {
"description": "(Required) - no. of pixels in vertical direction of datatype number",
"type": "number"
}
},
"required": [
"xPixels",
"yPixels"
],
"type": "object"
},
"pixelSize3D": {
"additionalProperties": false,
"description": "the distance on the sample imaged by a single pixel, normally expressed in nm or \u00b5m, is expressed in 3D for the mapping along x,y and z directions.",
"properties": {
"xPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Required) - distance on the sample covered by a pixel in the x direction defined separately as pixelSizeDetails"
},
"yPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the y direction defined separately as pixelSizeDetails; The y-pixel-size is to be given only if it is different from the x-pixel-size"
},
"zPixelSize": {
"$ref": "#/$defs/pixelSizeDetails",
"description": "(Optional) - distance on the sample covered by a pixel in the z direction defined separately as pixelSizeDetails; The z-pixel-size can be ignored if it is greater than the voxel size"
}
},
"required": [
"xPixelSize"
],
"type": "object"
},
"pixelSizeDetails": {
"additionalProperties": false,
"description": "describes the size of a pixel.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the size of a single pixel (typical value - nm, \u00b5m) of datatype string",
"enum": [
"nm",
"\u00b5m"
],
"type": "string"
},
"value": {
"description": "(Required) - The pixel-size expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"powerDetails": {
"additionalProperties": false,
"description": "Describes a power",
"properties": {
"notes": {
"description": "(optional, NAE) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(optional, NAE) - A qualifier to describe the value (e.g., avg, max, min).",
"enum": [
"max",
"min",
"average"
],
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(optional, NAE) - Uncertainty in the value defined separately as uncertaintyDetails,(allows choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number)."
},
"unit": {
"description": "(required, NAE) - the unit of the value to be selected from a controlled list (mW, W, kW).",
"enum": [
"mW",
"W",
"kW"
],
"type": "string"
},
"value": {
"description": "(required, NAE) - The power expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"pressureDetails": {
"additionalProperties": false,
"description": "(Required) - Describes a pressure.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative."
},
"unit": {
"description": "(Required) - Unit of the value to be selected from a controlled list (Pa, hPa, kPa, MPa, GPa, mbar, bar, psi).",
"enum": [
"Pa",
"hPa",
"kPa",
"MPa",
"GPa",
"mbar",
"bar",
"psi"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the pressure",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
},
"rampDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a rate at which temperature is increased or decreased.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K/min, K/s).",
"enum": [
"K/min",
"K/s"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the rate of temperature increase or decrease.",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"reconstruction": {
"additionalProperties": false,
"description": "Data from one single reconstruction.",
"properties": {
"reconstructionDetails": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"additionalFilters": {
"beamHardeningCorrection": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"filterType": {
"description": "(Optional) - Type of the additional filter - Median or Gauss",
"enum": [
"Median",
"Gauss"
],
"type": "string"
},
"phaseRetrieval": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
},
"ringFilter": {
"description": "(Optional) - Relevant parameters as a string.",
"type": "string"
}
},
"algorithm": {
"description": "(Required) - Algorithm used for reconstruction to be selected from FBP - Filtered Back Projection, ART - Algebraic Reconstruction Technique, 3dCT - 3D Computed Tomography and Gridrec.",
"enum": [
"FBP - Filtered Back Projection",
"ART - Algebraic Reconstruction Technique",
"3dCT - 3D Computed Tomography",
"Gridrec"
],
"type": "string"
},
"binning": {
"additionalProperties": false,
"description": "(Required) - Details regarding the binning which is the process of grouping or combining adjacent pixels or voxels into larger units to reduce the amount of data and improve image quality or processing speed.",
"properties": {
"binningType": {
"description": "(Optional) - Type of the binning to be chosen between Summation and Averaging.",
"enum": [
"Summation",
"Averaging"
],
"type": "string"
},
"noOfBinnedPixels": {
"description": "(Required) - No. of adjacent pixels which are binned together.",
"type": "number"
}
},
"required": [
"noOfBinnedPixels"
],
"type": "object"
},
"bitDepthConversionMax": {
"description": "(Required) - Maximum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"bitDepthConversionMin": {
"description": "(Required) - Minimum cut-off value selected for bit-depth conversion during reconstruction.",
"type": "number"
},
"hardwarePlatform": {
"description": "(Optional) - Hardware platform used for reconstruction to be selected between CPU and GPU.",
"enum": [
"CPU",
"GPU"
],
"type": "string"
},
"lastImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the last image for the reconstruction of the 3D Volume, typically an integer.",
"type": "string"
},
"projectionPadding": {
"additionalProperties": false,
"description": "(Optional) - Details regarding the projection padding applied to the raw projection data to address certain issues in the reconstruction process.",
"properties": {
"paddingSize": {
"$ref": "#/$defs/pixelNumberType",
"description": "(Required) - Size of the projection padding used in pixels."
},
"paddingType": {
"description": "(Required) - Type of the projection padding used - Zero Padding, Linear Interpolation Padding, Sinc Interpolation Padding, Shepp-Logan Filtered Back Projection (SL-FBP), Gridding and Extended Field of View (FOV) Padding.",
"enum": [
"Zero Padding",
"Linear Interpolation Padding",
"Sinc Interpolation Padding",
"Shepp-Logan Filtered Back Projection (SL-FBP)",
"Gridding",
"Extended Field of View (FOV) Padding"
],
"type": "string"
}
},
"type": "object"
},
"reconstructionSoftware": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for reconstruction. It may be the same as the acquisition software or a different one."
},
"startAngle": {
"$ref": "#/$defs/angleDetails",
"description": "(Required) - Scan angle at which the reconstruction of the 3D Volume starts. Typical unit - degree."
},
"startImage": {
"description": "(Required) - Image-Number(of the projection) which is used as the start image for the reconstruction of the 3D Volume.",
"type": "string"
},
"tomographicProjectionFilter": {
"description": "(Optional) - Name of the tomographic projection filter used to be selected from Ram-Lak Filter, Butterworth Filter, Shepp-Logan Filter, Hann (Hanning) Filter, Gaussian Filter, Cosine Filter, Soft Filtration Method and Hard Filtration Method.",
"enum": [
"Ram-Lak Filter",
"Butterworth Filter",
"Shepp-Logan Filter",
"Hann (Hanning) Filter",
"Gaussian Filter",
"Cosine Filter",
"Soft Filtration Method",
"Hard Filtration Method"
],
"type": "string"
}
},
"required": [
"startImage",
"lastImage",
"startAngle",
"hardwarePlatform",
"algorithm",
"binning"
],
"type": "object"
},
"volumeStructure": {
"additionalProperties": false,
"description": "(Required) - Details about the projections.",
"properties": {
"bitDepth": {
"description": "(Required) - The number of bits used to represent the intensity values of each voxel in the 3D volume. The bit depth determines the number of possible intensity levels that can be assigned to each voxel. The formula to calculate the number of possible intensity levels is given by 2^n, where 'n' is the bit depth.",
"type": "number"
},
"dimensions": {
"$ref": "#/$defs/coordinateSet",
"description": "(Required) - The dimension of the 3D volume in XYZ coordinates. If the length in Z dimension is not known and instead only the number of slices are known, they need to be separately entered in the field 'numberOfSlices'. Typical unit - \u00b5m."
},
"header": {
"additionalProperties": false,
"description": "(Optional) - Details about the header of the data.",
"properties": {
"headerLocation": {
"description": "(Required) - Location of the header.",
"type": "string"
},
"headerName": {
"description": "(Required) - Name of the header.",
"type": "string"
},
"headerSize": {
"description": "(Optional) - Size of the header.",
"type": "number"
}
},
"required": [
"headerName",
"headerLocation"
],
"type": "object"
},
"name": {
"description": "(Required) - Name of the 3D volume structure (dataset).",
"type": "string"
},
"numberOfSlices": {
"description": "(Optional) - No. of slices which make up the 3D volume.",
"type": "number"
},
"pixelSize": {
"$ref": "#/$defs/pixelSize3D",
"description": "(Required) - Physical x,y,z length imaged by a single pixel/voxel, normally expressed in \u00b5m."
},
"volumeID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry of the 3D reconstructed volume usually provided by the project or the laboratory."
}
},
"required": [
"name",
"dimensions",
"bitDepth",
"pixelSize"
],
"type": "object"
}
},
"required": [
"volumeStructure",
"reconstructionDetails"
],
"type": "object"
},
"revision": {
"additionalProperties": false,
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format.",
"properties": {
"revisionComment": {
"description": "(Optional)- Any comments to the revision",
"type": "string"
},
"revisonID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the file"
}
},
"type": "object"
},
"sampleStage": {
"additionalProperties": false,
"description": "(Required) - Details about sample stage.",
"properties": {
"stageMotorHierarchy": {
"additionalProperties": false,
"description": "(Required) - Details about the hierarchy of the stage motors. This information is required to know how the motor movements affect the positions of the samples, particularly relevant for correlative characterization.",
"properties": {
"beamDirection": {
"description": "(Required) - The beam direction expressed as a vector in cartesian coordinates. e.g. - If the beam is parallel to the Y-stage and perpendicular to the X-stage. then beam direction = [0 1 0].",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"mMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the M motor (stage) as a vector in cartesian coordiantes. The M motor is usually relevant only for SEM based CT. It is a special motor which counteracts the Z motor."
},
"rMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the R motor (stage) as a vector in cartesian coordiantes. R motor has rotation around z axis +1 (for anticlockwise)."
},
"tMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Optional) - Hierarchical level and direction of the T motor (stage) as a vector in cartesian coordiantes. The T motor is usually relevant only for SEM based CT."
},
"xMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the X motor (stage) as a vector in cartesian coordinates."
},
"yMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Y motor (stage) as a vector in cartesian coordinates."
},
"zMotor": {
"$ref": "#/$defs/motorHierarchy",
"description": "(Required) - Hierarchical level and direction of the Z motor (stage) as a vector in cartesian coordinates."
}
},
"required": [
"beamDirection",
"xMotor",
"yMotor",
"zMotor",
"rMotor"
],
"type": "object"
},
"stageMotorPositions": {
"$ref": "#/$defs/motorPositions",
"description": "(Optional) - Positions in cartesian coordinates and tilt angles of the stage motors."
}
},
"required": [
"stageMotorHierarchy"
],
"type": "object"
},
"temperatureDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a temperature.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum).",
"type": "string"
},
"unit": {
"description": "(Optional) - Unit of the value to be selected from a controlled list (K, \u00baC, \u00baF)",
"enum": [
"K",
"\u00baC",
"\u00baF"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the temperature",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"timeDetails": {
"additionalProperties": false,
"description": "describes a time.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined as a complex type uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number"
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (ps, ns, \u00b5s, ms, s).",
"enum": [
"ps",
"ns",
"\u00b5s",
"ms",
"s"
],
"type": "string"
},
"value": {
"description": "(Required) - The time expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
},
"uncertaintyDetails": {
"additionalProperties": false,
"description": "(Optional) - Uncertainty of the value. Allows to specify whether the uncertainty is absolute or relative. Properties: type (Required) - Type of the uncertainty to be chosen between absolute or relative, value (Required) - value of the uncertainty",
"properties": {
"uncertaintyType": {
"description": "(Required) - Type of the uncertainty to be chosen between absolute or relative",
"enum": [
"absolute",
"relative"
],
"type": "string"
},
"value": {
"description": "(Required) - Value of the uncertainty",
"type": "number"
}
},
"required": [
"uncertaintyType",
"value"
],
"type": "object"
},
"user": {
"description": "Basic schema for user description. It can be extended.",
"properties": {
"ORCID": {
"description": "(Optional) - Open Researcher and Contributor ID expressed as a URI",
"pattern": "^https://orcid\\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[X0-9]{1}$",
"type": "string"
},
"affiliation": {
"description": "(Optional) - Details of the institution to which the user is affiliated",
"properties": {
"institutionAcronym": {
"description": "(Recommended) - Acronym of the institution",
"type": "string"
},
"institutionDepartment": {
"description": "(Optional) - Department within an institution",
"type": "string"
},
"institutionID": {
"description": "(Optional) -Identifier of the institution to which the user is affiliated",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be chosen from a controlled list of values (*ROR *GRID *ISNI *URL *DOI *Handle)",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"institutionName": {
"description": "(Optional) - Full name of the institution",
"type": "string"
}
},
"type": "object"
},
"email": {
"description": "(Optional) - Email of the user",
"format": "email",
"type": "string"
},
"familyName": {
"description": "(Optional) - Family name of the user",
"type": "string"
},
"givenName": {
"description": "(Optional) - Given name of the user",
"type": "string"
},
"role": {
"description": "(Required) - Role of the research user",
"enum": [
"Data Curator",
"Instrument Scientist",
"Team Leader",
"Team Member"
],
"type": "string"
},
"userName": {
"description": "(Required) - Full name of the user in the format (Family Name, Given Name)",
"type": "string"
}
},
"required": [
"userName",
"role"
],
"type": "object"
},
"voltageDetails": {
"additionalProperties": false,
"description": "describes a voltage.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string.",
"type": "string"
},
"qualifier": {
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min).",
"type": "string"
},
"uncertainty": {
"$ref": "#/$defs/uncertaintyDetails",
"description": "(Optional) - Uncertainty in the value defined separately as uncertaintyDetails, which gives the option of choosing between an absolute uncertainty or relative uncertainty and entering the value of uncertainty as a number."
},
"unit": {
"description": "(Required) - the unit of the value to be selected from a controlled list (\u00b5V, mV, V, kV, MV, GV).",
"enum": [
"\u00b5V",
"mV",
"V",
"kV",
"MV"
],
"type": "string"
},
"value": {
"description": "(Required) - The voltage expressed as an integer or floating point value.",
"type": "number"
}
},
"required": [
"unit",
"value"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/main/CT/lab_CT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "This JSON Schema describes a nano or micro - computed tomography (CT) measurement done using the instrumentation in a lab using an x-ray tube as a source. The same schema can also be used for an SEM based CT measurement where the x-rays emitted by a material upon interaction with the electron beam from the electron microscope, are used for generating CT images of a sample. For synchrotron based CT, use the synchrotron CT schema provided separately in the same folder as this schema. The cardinality (required or optional) of all metadata is defined and wherever possible a list of controlled vocabularies is provided. Contributors (in alphabetical order of last names): Alexey Boubnov, Rafaela Debastiani, Jonas Fell, Sarah Irvine, Reetu Elza Joseph.",
"properties": {
"consumables": {
"description": "(Optional) - Auxiliary entity used during Fabrication, Sample Preparation or Measurement which has a limited time capacity or is limited in its number of uses before it is disposed of, necessary to the process itself and normally bought from third party manufacturers. Examples are: gloves, syringes, wipes, etching solutions, glass slides, spatulas, weighing paper, two-sided tape.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"data": {
"$ref": "#/$defs/data",
"description": "(Required)- Details concerning the data section of the measurement."
},
"definition": {
"description": "(Required) - Name of the schema to which this entry conforms. In this case, lab_CT should be written.",
"type": "string"
},
"endTime": {
"description": "(Required) - End time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"entryID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the metadata entry usually provided by the project or the laboratory."
},
"equipment": {
"description": "(Optional) - Any kind of physical or virtual item, device, machine or other tools used to perform one or more Fabrication(s), Sample Preparation(s), Model Preparation(s), Data Acquisition(s) and/or any of the processes included in the Data Analysis Lifecycle. Usually, the Equipment is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. Equipment is usually an investment. According to this definition, an Instrument is a particular type of Equipment.",
"type": "string"
},
"experimentID": {
"$ref": "#/$defs/identifier",
"description": "(Optional) - Identifier of the measurement usually provided by the project or the laboratory."
},
"instrument": {
"$ref": "#/$defs/instrumentDetails",
"description": "(Required)- Details concerning the instrument settings. Instrument is a physical or virtual identifiable piece of Equipment used to perform a Data Acquisition and to generate Raw Data. The Instrument is located in a Laboratory hosted by an Institution and/or can be virtually or remotely accessed. A virtual Instrument may be any computational resource or HPC infrastructure (cloud infrastructure or supercomputer) needed to perform Calculations or Simulations."
},
"measurementConditions": {
"$ref": "#/$defs/measurementConditions",
"description": "(Optional)- Details concerning the measurement conditions like details of in situ cell, temperature and gas enviroment and pressure."
},
"measurementDescription": {
"description": "(Optional) - Description about the measurement.",
"type": "string"
},
"measurementPurpose": {
"description": "(Required) - Measurement is experimental Data Acquisition, typically performed on a Sample using an experimental Technique. It may also be performed during Fabrication or Sample Preparation, e.g., to characterise the intermediate stages and/or the final resulting Precursor(s) or Sample(s), respectively. A Measurement may require the use of Consumables.",
"enum": [
"assessment (to given categories or values)",
"completeness check (presence or absence of given properties)",
"correlative characterization (dedicated sample treatment to emphasise given features)",
"exploratory (routine check of known properties)",
"feasibility (quick check, rough estimate)",
"high quality measurement (precise, careful treatment)",
"test specific hypothesis (focus only on given aspects)",
"other (please specify in the comment)"
],
"type": "string"
},
"parents": {
"description": "(Required) - Parents of this metadata like the metadata document of the sample with which the measurement was performed.",
"items": {
"if": {
"properties": {
"parentType": {
"not": {
"const": "not applicable"
}
}
}
},
"properties": {
"parentReference": {
"description": "If type is 'MetaStore URI' it is possible to easily fill this field in a later stage",
"format": "uri-reference",
"type": "string"
},
"parentReferenceType": {
"default": "MetaStore URI",
"enum": [
"plain text",
"external URL",
"MetaStore URI"
],
"type": "string"
},
"parentType": {
"default": "sample",
"enum": [
"not applicable",
"sample"
],
"type": "string"
}
},
"required": [
"parentType"
],
"then": {
"required": [
"parentReferenceType",
"parentReference"
]
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Required) - Details concerning the program (or software) used for aquisition."
},
"revision": {
"$ref": "#/$defs/revision",
"description": "(Optional) - Details concerning any revision to the document due to e.g. re-calibration, reprocessing, new analysis, new instrument definition format."
},
"startTime": {
"description": "(Required) - Start time of the measurement in the ISO 8601 format CCYY-MM-DDThh:mm:ss.sss.",
"format": "date-time",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z)$",
"type": "string"
},
"technique": {
"description": "(Required) - Any experimental, theoretical or computational method used during Data Acquisition or during any of the processes included in the Data Analysis Lifecycle to acquire, process or analyse Research Data about a System or a set of them with an Instrument, which is used to generate this metadata.",
"type": "string"
},
"title": {
"description": "(Required) - Extended title of the measurement.",
"type": "string"
},
"user": {
"$ref": "#/$defs/user",
"description": "(Required)- The contact information of the user responsible for the measurement."
}
},
"required": [
"title",
"technique",
"definition",
"parents",
"measurementPurpose",
"startTime",
"endTime",
"program",
"user",
"instrument",
"data"
],
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | a09c6f31e2763fcff68fac51aa0cb333ed1b1d93 | 2023-11-24T15:14:55 | SEM-FIB_Tomography/SEM_FIB_Tomography_Acquisition_Main.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$defs": {
"acquisition": {
"additionalProperties": false,
"description": "The entry level is the root element of the schema. It contains all the metadata describing an acquisition as part of an SEM/FIB Tomography measurement which might include multiple detectors.",
"properties": {
"dataset": {
"description": "Array of all the dataset-metadata acquired using multiple detetors",
"items": {
"$ref": "https://github.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/blob/68fd9fa5de5dbe56bd7665b6320eb1ca47b4b1e5/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json"
},
"type": "array"
},
"genericMetadata": {
"additionalProperties": false,
"description": "Describes all the generic metadata common to the acquisition",
"properties": {
"ESEM": {
"description": "To be set to true if environmental SEM is used",
"type": "boolean"
},
"angleToEBeam": {
"$ref": "#/$defs/angleDetails",
"description": "(Optional) - angle between e-beam and i-beam defined separately as angleDetails (Allowed units: degree, radian). It is specified by the manufacturer and a property of the geometry of the instrument."
},
"applicationID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Details concerning the program (or software) used for aquisition"
},
"column": {
"description": "The name of the column used in the instrument",
"type": "string"
},
"eucentricWorkingDistance": {
"$ref": "#/$defs/distanceDetails",
"description": "The Working Distance when the smaple is at the eucentric height"
},
"fileVersion": {
"description": "The file version of the measurement data of the project",
"type": "string"
},
"millingCurrent": {
"$ref": "#/$defs/currentDetails",
"description": "The total height of the area which is cut into slices in the z dimension. IRI: https://purls.helmholtz-metadaten.de/EMG/00000003"
},
"millingLocationDepth": {
"$ref": "#/$defs/distanceDetails",
"description": "The total width of the area which is cut into slices in the y dimension"
},
"millingLocationHeight": {
"$ref": "#/$defs/distanceDetails",
"description": "The total height of the area which is cut into slices in the z dimension"
},
"millingLocationWidth": {
"$ref": "#/$defs/distanceDetails",
"description": "The total width of the area which is cut into slices in the x dimension"
},
"millingLocationX": {
"$ref": "#/$defs/distanceDetails",
"description": "X coordinate begin of the milling location from the origin."
},
"millingLocationY": {
"$ref": "#/$defs/distanceDetails",
"description": "Y coordinate of the begin of the milling location from the origin."
},
"millingMaterial": {
"description": "Material which is milled",
"type": "string"
},
"numberOfCuts": {
"description": "The number of slices into which the sample is cut during the course of the SEM/FIB Tomography",
"type": "number"
},
"program": {
"$ref": "#/$defs/program",
"description": "(Optional)- Details concerning the program (or software) used for aquisition"
},
"projectDescription": {
"description": "Description about the project containing the acquistion datasets",
"type": "string"
},
"projectID": {
"$ref": "#/$defs/identifier",
"description": "(Optional)- Details concerning the program (or software) used for aquisition"
},
"projectName": {
"description": "The name of the project containing the acquistion datasets",
"type": "string"
},
"pump": {
"description": "The name of the pump used in the instrument",
"type": "string"
},
"source": {
"description": "The type of the source used in the instrument. The source is a physical part of an electron or ion microscope from which the particles that form the beam are emitted. IRI: https://purls.helmholtz-metadaten.de/EMG/00000021",
"type": "string"
},
"stage": {
"description": "The dimensions of the stage used in the instrument",
"type": "string"
},
"systemType": {
"description": "Describes the system type used - the name of the instrument",
"type": "string"
},
"userDescription": {
"description": "Additional description provided by the user about the measurement or the sample",
"type": "string"
},
"zCutSpacing": {
"$ref": "#/$defs/distanceDetails",
"description": "The spacing between individual slices in z dimension"
}
},
"required": [
"angleToEBeam",
"zCutSpacing",
"projectName",
"applicationID",
"program"
],
"type": "object"
}
},
"type": "object"
},
"angleDetails": {
"additionalProperties": false,
"description": "describes an angle.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "degree",
"description": "(Optional) - the unit of the value to be selected from a controlled list (degree, radian; default value - degree) of datatype string",
"enum": [
"degree",
"radian"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - The angle expressed as an integer or floating point value of datatype number",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"currentDetails": {
"additionalProperties": false,
"description": "Describes a current.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value of datatype string",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - A qualifier to describe the value (e.g., avg, max, min; default value - max) of datatype string",
"type": "string"
},
"unit": {
"default": "pA",
"description": "(Optional) - the unit of the value to be selected from a controlled list (pA, nA, uA, mA, A default value - pA) of datatype string",
"enum": [
"pA",
"nA",
"uA",
"mA",
"A"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Optional) - Further notes about the value of datatype string",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"distanceDetails": {
"additionalProperties": false,
"description": "(Optional) - Describes a distance, size or length.",
"properties": {
"notes": {
"description": "(Optional) - Further notes about the value",
"type": "string"
},
"qualifier": {
"default": "max",
"description": "(Optional) - Qualifier to describe the value (e.g., average, maximum, minimum, default value - max)",
"type": "string"
},
"unit": {
"default": "mm",
"description": "(Optional) - Unit of the value to be selected from a controlled list (nm, \u00b5m, mm, cm, m, default value - mm)",
"enum": [
"nm",
"um",
"mm",
"cm",
"m"
],
"type": "string"
},
"value": {
"default": -9999,
"description": "(Required) - Value of the distance, size or length",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"identifier": {
"additionalProperties": false,
"description": "(Optional) - Details of an identifier element.",
"properties": {
"identifierType": {
"description": "(Optional) - Type of the identifier to be selected from: *ROR *GRID *ISNI *URL *DOI *Handle *String",
"enum": [
"ROR",
"GRID",
"ISNI",
"URL",
"DOI",
"Handle",
"String"
],
"type": "string"
},
"identifierValue": {
"description": "(Optional) - String containing the value of an identifier",
"type": "string"
}
},
"type": "object"
},
"program": {
"additionalProperties": false,
"description": "(Optional) - Details concerning the program (or software) used for aquisition.",
"properties": {
"programName": {
"description": "(Optional) - Name of the program (or software) used for acquisition",
"type": "string"
},
"programVersion": {
"description": "(Optional) - Program (or software) version number",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://github.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/blob/68fd9fa5de5dbe56bd7665b6320eb1ca47b4b1e5/SEM-FIB_Tomography/SEM_FIB_Tomography_Acquisition_Main.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes the entire acquisition process during an SEM_FIB_Tomography measurement. The acquisition comprises of multiple datasets which are described using the schema located at https://github.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/blob/68fd9fa5de5dbe56bd7665b6320eb1ca47b4b1e5/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Dataset_Schema.json. The images in each dataset is taken using a detector (SE, BSE, EDS, EBSD) using a specific configuration. Each image is described by the schema located at https://github.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/blob/68fd9fa5de5dbe56bd7665b6320eb1ca47b4b1e5/SEM-FIB_Tomography/SEM_FIB_Tomography_acquisition_Image_Schema.json. The units are by default to be considred as the SI units unless otherwise specified",
"properties": {
"acquisition": {
"$ref": "#/$defs/acquisition"
}
},
"required": [
"acquisition"
],
"title": "acquisition_main",
"type": "object"
} | CC0-1.0 | en |
kit-data-manager/Metadata-Schemas-for-Materials-Science | 27c90f0e91b08900482b6fb4567cf11c81823c7b | 2023-06-06T09:12:18 | Reference_Dataset_Zenodo/PP18_dataset_metadata_Schema.json | 6 | 2024-05-28T05:08:22.241592Z | {
"$id": "https://github.com/kit-data-manager/Metadata-Schemas-for-Materials-Science/blob/723a0408312be41e4499a3ad2861d799df65f78f/Reference_Dataset_Zenodo/PP18_dataset_metadata_Schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema describes the metadata of the reference dataset by BAM. It contains the metadata of the results of ASTM E139 -11 creep tests on a reference material of Nimonic 75 nickel-base alloy",
"properties": {
"access_right": {
"description": " (Required) - Type of access right. e.g. open",
"type": "string"
},
"access_right_category": {
"description": "(Optional) - to be given as success if the document is open-access",
"type": "string"
},
"communities": {
"description": "Details about a collaborative community to which the data belongs",
"items": {
"properties": {
"id": {
"description": "ID of the community as a string. eg. bam",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"creators": {
"items": {
"properties": {
"affiliation": {
"description": "(Required) - Details of the institution to which the creator is affiliated",
"type": "string"
},
"name": {
"description": " (Required) - Full name of the creator in the format (Family Name, Given Name)",
"type": "string"
},
"orcid": {
"description": "(Optional) - Open Researcher and Contributor ID",
"pattern": "^[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[X0-9]{1}$",
"type": "string"
}
},
"required": [
"name",
"affiliation"
],
"type": "object"
},
"type": "array"
},
"description": {
"description": "Elaborate Information on the data",
"type": "string"
},
"doi": {
"description": "(Required) - DOI of the document",
"type": "string"
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"language": {
"description": "(Required) - Language of the Document",
"type": "string"
},
"license": {
"description": "(Required) - Describes the License under which the documents are protected",
"properties": {
"id": {
"description": "(Required) - id of the license, eg. CC-BY-4.0",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"notes": {
"description": "(Optional) - Additional notes",
"type": "string"
},
"publication_date": {
"pattern": "(\\d{4}-\\d{2}-\\d{2})",
"type": "string"
},
"related_identifiers": {
"items": {
"properties": {
"identifier": {
"description": " (Required) - Value of the identifier",
"type": "string"
},
"relation": {
"description": " (Required) - Relation of the related resource, eg: isVersionOf",
"type": "string"
},
"scheme": {
"description": " (Required) - Type of the identifier, eg. DOI",
"type": "string"
}
},
"required": [
"scheme",
"identifier",
"relation"
],
"type": "object"
},
"type": "array"
},
"relations": {
"description": "(Required) - Describes the relations the document has to other documents and versions",
"properties": {
"version": {
"items": {
"properties": {
"count": {
"description": "(Required) - No. of versions at present",
"type": "number"
},
"index": {
"description": "(Required) - Index of the version",
"type": "number"
},
"is_last": {
"description": "(Required) - Is this version the latest one?",
"type": "boolean"
},
"last_child": {
"description": "(Optional) - Details of the ltest child version",
"properties": {
"pid_type": {
"description": "(Optional) - Type of the PID, eg. recid",
"type": "string"
},
"pid_value": {
"description": "(Optional) -Value of the PID",
"type": "string"
}
},
"type": "object"
},
"parent": {
"description": "(Optional) - Details about the parent version",
"properties": {
"pid_type": {
"description": "(Optional) - Type of the PID, eg. recid",
"type": "string"
},
"pid_value": {
"description": "(Optional) -Value of the PID",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"count",
"index",
"is_last"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"version"
],
"type": "object"
},
"resource_type": {
"properties": {
"title": {
"description": " (Required) - Title of the resource. eg. Dataset",
"type": "string"
},
"type": {
"description": " (Required) - Type of the resource. eg. dataset, image",
"type": "string"
}
},
"required": [
"type",
"title"
],
"type": "object"
},
"version": {
"type": "string"
}
},
"required": [
"version",
"creators",
"access_right",
"resource_type",
"publication_date",
"language",
"description",
"doi",
"license"
],
"title": "Metadata of BAM reference data: results of ASTM E139 -11 creep tests on a reference material of Nimonic 75 nickel-base alloy",
"type": "object"
} | CC0-1.0 | en |
CDCgov/prime-reportstream | f2bf66b4262139ead52ad2d2c19fbda3f39682aa | 2024-05-08T15:25:42 | prime-router/metadata/json_schema/organizations/organizations.json | 65 | 2024-05-28T06:07:48.137026Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"CustomerStatus": {
"enum": [
"active",
"inactive",
"testing"
],
"title": "CustomerStatus",
"type": "string"
},
"Filter": {
"additionalProperties": false,
"properties": {
"conditionFilter": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"jurisdictionalFilter": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"mappedConditionFilter": {
"anyOf": [
{
"items": {
"$ref": "#/definitions/MappedConditionFilter"
},
"type": "array"
},
{
"type": "null"
}
]
},
"processingModeFilter": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"qualityFilter": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"routingFilter": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"topic": {
"$ref": "#/definitions/Topic"
}
},
"required": [
"jurisdictionalFilter",
"topic"
],
"title": "Filter",
"type": "object"
},
"Jurisdiction": {
"enum": [
"FEDERAL",
"STATE",
"COUNTY"
],
"title": "Jurisdiction",
"type": "string"
},
"MappedConditionFilter": {
"additionalProperties": false,
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"type",
"value"
],
"title": "MappedConditionFilter",
"type": "object"
},
"Operation": {
"enum": [
"NONE",
"MERGE"
],
"title": "Operation",
"type": "string"
},
"Organization": {
"additionalProperties": false,
"properties": {
"countyName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"type": "string"
},
"featureFlags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"filters": {
"anyOf": [
{
"items": {
"$ref": "#/definitions/Filter"
},
"type": "array"
},
{
"type": "null"
}
]
},
"jurisdiction": {
"$ref": "#/definitions/Jurisdiction"
},
"keys": {
"anyOf": [
{
"items": {
"properties": {
"keys": {
"items": {
"properties": {
"alg": {
"type": "string"
},
"crv": {
"type": "string"
},
"d": {
"type": "string"
},
"dp": {
"type": "string"
},
"dq": {
"type": "string"
},
"e": {
"type": "string"
},
"k": {
"type": "string"
},
"keyOps": {
"type": "string"
},
"kid": {
"type": "string"
},
"kty": {
"type": "string"
},
"n": {
"type": "string"
},
"p": {
"type": "string"
},
"q": {
"type": "string"
},
"qi": {
"type": "string"
},
"use": {
"type": "string"
},
"x": {
"type": "string"
},
"x5c": {
"items": {
"type": "string"
},
"type": "array"
},
"x5t": {
"type": "string"
},
"x5u": {
"type": "string"
},
"y": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"scope": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"receivers": {
"items": {
"$ref": "#/definitions/Receiver"
},
"type": "array"
},
"senders": {
"items": {
"$ref": "#/definitions/Sender"
},
"type": "array"
},
"stateCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"description",
"jurisdiction"
],
"title": "Organization",
"type": "object"
},
"Receiver": {
"additionalProperties": false,
"properties": {
"conditionFilter": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"customerStatus": {
"$ref": "#/definitions/CustomerStatus"
},
"dateTimeFormat": {
"enum": [
"OFFSET",
"LOCAL",
"HIGH_PRECISION_OFFSET",
"DATE_ONLY"
],
"type": "string"
},
"deidentifiedValue": {
"type": "string"
},
"deidentify": {
"type": "boolean"
},
"description": {
"type": "string"
},
"enrichmentSchemaNames": {
"items": {
"type": "string"
},
"type": "array"
},
"externalName": {
"anyOf": [
{
"type": "null"
},
{
"type": "string"
}
]
},
"jurisdictionalFilter": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"mappedConditionFilter": {
"anyOf": [
{
"items": {
"$ref": "#/definitions/MappedConditionFilter"
},
"type": "array"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"organizationName": {
"type": "string"
},
"processingModeFilter": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"qualityFilter": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"reverseTheQualityFilter": {
"type": "boolean"
},
"routingFilter": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"timeZone": {
"anyOf": [
{
"$ref": "#/definitions/USTimeZone"
},
{
"type": "null"
}
]
},
"timing": {
"anyOf": [
{
"$ref": "#/definitions/Timing"
},
{
"type": "null"
}
]
},
"topic": {
"$ref": "#/definitions/Topic"
},
"translation": {
"$ref": "#/definitions/Translation"
},
"transport": {
"anyOf": [
{
"$ref": "#/definitions/Transport"
},
{
"type": "null"
}
]
}
},
"required": [
"customerStatus",
"jurisdictionalFilter",
"name",
"organizationName",
"topic",
"translation"
],
"title": "Receiver",
"type": "object"
},
"Sender": {
"additionalProperties": false,
"properties": {
"allowDuplicates": {
"type": "boolean"
},
"createdAt": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"createdBy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customerStatus": {
"$ref": "#/definitions/CustomerStatus"
},
"format": {
"enum": [
"CSV",
"HL7",
"FHIR",
"HL7_BATCH"
],
"type": "string"
},
"name": {
"type": "string"
},
"organizationName": {
"type": "string"
},
"primarySubmissionMethod": {
"anyOf": [
{
"enum": [
"automated",
"manual"
],
"type": "string"
},
{
"type": "null"
}
]
},
"processingType": {
"enum": [
"sync",
"async"
],
"type": "string"
},
"schemaName": {
"type": "string"
},
"senderType": {
"anyOf": [
{
"enum": [
"testManufacturer",
"dataAggregator",
"facility",
"hospitalSystem"
],
"type": "string"
},
{
"type": "null"
}
]
},
"topic": {
"$ref": "#/definitions/Topic"
},
"version": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
}
},
"required": [
"topic",
"name",
"organizationName",
"format"
],
"title": "Sender",
"type": "object"
},
"SenderFormat": {
"enum": [
"CSV",
"HL7",
"HL7_BATCH",
"FHIR"
],
"title": "SenderFormat",
"type": "string"
},
"Timing": {
"additionalProperties": false,
"properties": {
"initialTime": {
"pattern": "^\\d{2}:\\d{2}$",
"type": "string"
},
"maxReportCount": {
"type": "integer"
},
"numberPerDay": {
"type": "integer"
},
"operation": {
"enum": [
"NONE",
"MERGE"
],
"type": "string"
},
"timeZone": {
"$ref": "#/definitions/USTimeZone"
},
"whenEmpty": {
"properties": {
"action": {
"enum": [
"NONE",
"SEND"
],
"type": "string"
},
"onlyOncePerDay": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"initialTime",
"numberPerDay",
"operation"
],
"title": "Timing",
"type": "object"
},
"Topic": {
"enum": [
"covid-19",
"full-elr",
"etor-ti",
"elr-elims",
"monkeypox",
"test",
"mars-otc-elr"
],
"title": "Topic",
"type": "string"
},
"Translation": {
"additionalProperties": false,
"properties": {
"applyOTCDefault": {
"type": "boolean"
},
"cliaForOutOfStateTesting": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"cliaForSender": {
"type": "object"
},
"convertDateTimesToReceiverLocalTime": {
"type": "boolean"
},
"convertPositiveDateTimeOffsetToNegative": {
"type": "boolean"
},
"convertTimestampToDateTime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"defaultAoeToUnknown": {
"type": "boolean"
},
"defaults": {
"type": "object"
},
"dummy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"format": {
"$ref": "#/definitions/TranslationFormat"
},
"messageProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nameFormat": {
"type": "string"
},
"phoneNumberFormatting": {
"anyOf": [
{
"enum": [
"STANDARD",
"ONLY_DIGITS_IN_COMPONENT_ONE",
"AREA_LOCAL_IN_COMPONENT_ONE"
],
"type": "string"
},
{
"type": "null"
}
]
},
"processingModeCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"receivingApplicationName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"receivingApplicationOID": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"receivingFacilityName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"receivingFacilityOID": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"receivingOrganization": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"replaceDiiWithOid": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"replaceUnicodeWithAscii": {
"type": "boolean"
},
"replaceValue": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
]
},
"replaceValueAwithB": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
]
},
"reportingFacilityId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"reportingFacilityIdType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"reportingFacilityName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"schemaName": {
"type": "string"
},
"stripInvalidCharsRegex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"suppressAoe": {
"type": "boolean"
},
"suppressHl7Fields": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"suppressNonNPI": {
"type": "boolean"
},
"suppressQstForAoe": {
"type": "boolean"
},
"truncateHDNamespaceIds": {
"type": "boolean"
},
"truncateHl7Fields": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"truncationConfig": {
"additionalProperties": false,
"properties": {
"customLengthHl7Fields": {
"type": "object"
},
"truncateHDNamespaceIds": {
"type": "boolean"
},
"truncateHl7Fields": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": {
"$ref": "#/definitions/TranslationType"
},
"useBatchHeaders": {
"type": "boolean"
},
"useBatching": {
"type": "boolean"
},
"useBlankInsteadOfUnknown": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"useHighPrecisionHeaderDateTimeFormat": {
"type": "boolean"
},
"useOrderingFacilityName": {
"enum": [
"STANDARD",
"NCES",
"ORGANIZATION_NAME"
],
"type": "string"
},
"usePid14ForPatientEmail": {
"type": "boolean"
},
"useTestProcessingMode": {
"type": "boolean"
},
"valueSetOverrides": {
"type": "object"
}
},
"required": [
"type"
],
"title": "Translation",
"type": "object"
},
"TranslationFormat": {
"enum": [
"INTERNAL",
"CSV",
"CSV_SINGLE",
"HL7",
"HL7_BATCH",
"FHIR"
],
"title": "TranslationFormat",
"type": "string"
},
"TranslationType": {
"enum": [
"CUSTOM",
"HL7",
"FHIR",
"GAEN"
],
"title": "TranslationType",
"type": "string"
},
"Transport": {
"additionalProperties": false,
"properties": {
"apiUrl": {
"type": "string"
},
"authHeaders": {
"type": "object"
},
"authTokenUrl": {
"format": "uri",
"type": "string"
},
"authType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"containerName": {
"type": "string"
},
"credentialName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"dummy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"endpoint": {
"format": "uri",
"type": "string"
},
"filePath": {
"type": "string"
},
"headers": {
"type": "object"
},
"host": {
"type": "string"
},
"namespaces": {
"type": "object"
},
"parameters": {
"type": "object"
},
"port": {
"anyOf": [
{
"minimum": 0,
"type": "number"
},
{
"type": "string"
}
]
},
"reportUrl": {
"format": "uri",
"type": "string"
},
"soapAction": {
"type": "string"
},
"soapVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"storageName": {
"type": "string"
},
"tlsKeystore": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/definitions/TransportType"
},
"uuidFormat": {
"type": "string"
},
"uuidIV": {
"type": "integer"
}
},
"required": [
"type"
],
"title": "Transport",
"type": "object"
},
"TransportType": {
"enum": [
"SFTP",
"EMAIL",
"BLOBSTORE",
"NULL",
"AS2",
"SOAP",
"GAEN",
"REST"
],
"title": "TransportType",
"type": "string"
},
"USTimeZone": {
"enum": [
"PACIFIC",
"MOUNTAIN",
"ARIZONA",
"CENTRAL",
"EASTERN",
"SAMOA",
"HAWAII",
"EAST_INDIANA",
"INDIANA_STARKE",
"MICHIGAN",
"CHAMORRO",
"UTC"
],
"type": "string"
}
},
"items": {
"$ref": "#/definitions/Organization"
},
"type": "array"
} | CC0-1.0 | en |
aws-samples/personalization-apis | 991d6f3a8d745432a182253d964ac7281a1e316f | 2022-05-26T00:51:07 | src/config_validator_function/personalization_apis_config_schema.json | 39 | 2024-05-27T05:38:26.523475Z | {
"$defs": {
"autoContext": {
"additionalProperties": false,
"description": "Automatic context fields and rules keyed by Amazon Personalize field name in camel case format (i.e. 'deviceType' rather than 'DEVICE_TYPE').",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Default value to use when no rules are matched for the field.",
"type": [
"string",
"number"
]
},
"description": {
"description": "Informative description of auto context field and rules.",
"type": "string"
},
"evaluateAll": {
"default": false,
"description": "Whether to evaluate all rules, potentially resolving to multiple values, or stop at the first matched rule",
"type": "boolean"
},
"rules": {
"description": "Rules for evaluating automatic context values for the field",
"items": {
"$ref": "#/$defs/autoContextOrFilterRule"
},
"type": "array"
},
"type": {
"description": "Data type for the context field.",
"enum": [
"string",
"integer",
"long",
"float"
],
"type": "string"
}
},
"required": [
"type",
"rules"
],
"type": "object"
}
},
"type": "object"
},
"autoContextOrFilterRule": {
"anyOf": [
{
"additionalProperties": false,
"description": "Rule that matches a header value based on an operator and value and, if true, optionally maps to a final resolved value.",
"properties": {
"header": {
"description": "HTTP request header name",
"type": "string"
},
"type": {
"description": "Rule type based on an HTTP request header value",
"enum": [
"header-value"
],
"type": "string"
},
"valueMappings": {
"description": "Optional value mapping expressions to resolve to final value",
"items": {
"$ref": "#/$defs/ruleValueMapping",
"type": "array"
},
"type": "array"
}
},
"required": [
"type",
"header"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Rules based on temporal/seasonal aspects of the current time in the user's time zone and hemisphere",
"properties": {
"type": {
"description": "Temporal/seasonal aspect",
"enum": [
"hour-of-day",
"day-of-week",
"season-of-year"
],
"type": "string"
},
"valueMappings": {
"description": "Optional value mapping expressions to resolve to final value",
"items": {
"$ref": "#/$defs/ruleValueMapping",
"type": "array"
},
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"autoDynamicFilterValues": {
"additionalProperties": false,
"description": "Automatic filter parameter value rules keyed by filter parameter name.",
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Default value to use when no rules are matched",
"type": [
"string",
"number"
]
},
"description": {
"description": "Informative description of auto filter field and rules.",
"type": "string"
},
"evaluateAll": {
"default": false,
"description": "Whether to evaluate all rules, potentially resolving to multiple values, or stop at the first matched rule",
"type": "boolean"
},
"rules": {
"description": "Rules for evaluating automatic filter values for the filter parameter",
"items": {
"$ref": "#/$defs/autoContextOrFilterRule"
},
"type": "array"
},
"type": {
"description": "Data type for the parameter value",
"enum": [
"string",
"integer",
"long",
"float"
],
"type": "string"
}
},
"required": [
"type",
"rules"
],
"type": "object"
}
},
"type": "object"
},
"cacheControl": {
"additionalProperties": false,
"properties": {
"autoProvision": {
"description": "Indicates whether the personalization API application should automatically update the CloudFront cache and origin request policies",
"type": "boolean"
},
"noUserSpecified": {
"$ref": "#/$defs/cacheControlType",
"description": "Cache control settings to use when a user is NOT specified in the request"
},
"syntheticUserSpecified": {
"$ref": "#/$defs/cacheControlType",
"description": "Cache control settings to use when a synthetic user is specified in the request"
},
"userSpecified": {
"$ref": "#/$defs/cacheControlType",
"description": "Cache control settings to use when a user is specified in the request"
}
},
"required": [
"userSpecified",
"syntheticUserSpecified",
"noUserSpecified"
],
"type": "object"
},
"cacheControlType": {
"additionalProperties": false,
"properties": {
"directives": {
"description": "Additional directives, as comma delimited list, to include in the Cache-Control response header. For example, 'public' indicates that responses may be cached in shared caches like CloudFront and 'private' indicates that responses may only be cached in browsers.",
"type": "string"
},
"maxAge": {
"description": "The maximum amount of time (in seconds) that responses may be cached. A 'max-age' directive with this value will be included in the Cache-Control response header.",
"minimum": 0,
"type": "integer"
}
},
"required": [
"maxAge",
"directives"
],
"type": "object"
},
"experiment": {
"additionalProperties": false,
"properties": {
"description": {
"description": "Informative description of experiment.",
"type": "string"
},
"method": {
"enum": [
"evidently"
],
"type": "string"
},
"metrics": {
"additionalProperties": false,
"description": "Metrics supported by the experiment keyed by the metric name as defined for the Evidently experiment.",
"patternProperties": {
"^[\\S]+$": {
"properties": {
"entityIdKey": {
"description": "Entity ID Key for the Evidently metric to track exposures and conversions (e.g., 'userDetails.userId').",
"type": "string"
},
"trackExposures": {
"description": "Indicates whether exposures should be tracked with a custom event.",
"type": "boolean"
},
"valueKey": {
"description": "Value Key for the Evidently metric to track exposures and conversions (e.g., 'details.productClicked').",
"type": "string"
}
},
"required": [
"entityIdKey",
"valueKey"
],
"type": "object"
}
},
"type": "object"
},
"project": {
"type": "string"
}
},
"required": [
"method",
"project",
"metrics"
],
"type": "object"
},
"experimentFeature": {
"additionalProperties": false,
"description": "Evidently experiments for the recommender keyed by the feature name specified in the Evidently feature and in API requests. If only one experiment is defined in the configuration, it will be used as the default if a feature is not specified on the request.",
"patternProperties": {
"^[-a-zA-Z0-9._]*$": {
"$ref": "#/$defs/experiment"
}
},
"type": "object"
},
"inferenceItemMetadata": {
"description": "Inference item metadata datastore configuration. Defines how the Personalization APIs store and cache item metadata used to decorate responses.",
"oneOf": [
{
"additionalProperties": false,
"description": "Local DBM database that is built and downloaded to the local Lambda volume from the S3 staging bucket for each API function instance.",
"properties": {
"syncInterval": {
"description": "Number of seconds to wait before checking the S3 staging bucket for updated DBM files.",
"maximum": 3600,
"minimum": 5,
"type": "integer"
},
"type": {
"enum": [
"localdb"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "DynamoDB table that is populated with item metadata from S3 staging bucket and queried to decorate API responses.",
"properties": {
"autoProvision": {
"description": "Indicates whether the personalization API application should automatically create and update DynamoDB tables according to the configuration",
"type": "boolean"
},
"billingMode": {
"description": "DynamoDB billing mode to use when auto provisioning is enabled.",
"enum": [
"PROVISIONED",
"PAY_PER_REQUEST"
],
"type": "string"
},
"provisionedThroughput": {
"description": "DynamoDB provisioned throughput read and write capacity units to use when auto provisioning is enabled.",
"properties": {
"readCapacityUnits": {
"minimum": 0,
"type": "integer"
},
"writeCapacityUnits": {
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"type": {
"enum": [
"dynamodb"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"namespaces": {
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9_-]*$": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"recommenders"
]
},
{
"required": [
"eventTargets"
]
}
],
"description": "Namespace configuration that contains one or more recommenders.",
"properties": {
"autoContext": {
"$ref": "#/$defs/autoContext",
"description": "Automatic context rules that apply to all Personalize recommenders for this namespace unless overridden at the recommender or variation level (overrides config at root)."
},
"cacheControl": {
"$ref": "#/$defs/cacheControl",
"description": "Cache control settings that apply to all recommenders for this namespace unless overridden at the recommender or variation level (overrides config at root)."
},
"description": {
"description": "Description for this namespace. Informative only.",
"type": "string"
},
"eventTargets": {
"description": "Destinations to send events to via the events API endpoint for a namespace",
"items": {
"anyOf": [
{
"additionalProperties": false,
"description": "Amazon Personalize event tracker",
"properties": {
"trackingId": {
"description": "Personalize event tracker tracking ID.",
"pattern": "[a-zA-Z0-9\\-]+",
"type": "string"
},
"type": {
"description": "",
"enum": [
"personalize-event-tracker"
],
"type": "string"
}
},
"required": [
"type",
"trackingId"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Amazon Kinesis data stream or firehose.",
"properties": {
"streamName": {
"description": "Kinesis stream or firehose name",
"pattern": "[a-zA-Z0-9_.-]+",
"type": "string"
},
"type": {
"description": "Identifies this variation as a Lambda function.",
"enum": [
"kinesis-stream",
"kinesis-firehose"
],
"type": "string"
}
},
"required": [
"type",
"streamName"
],
"type": "object"
}
]
},
"type": "array"
},
"inferenceItemMetadata": {
"$ref": "#/$defs/inferenceItemMetadata",
"description": ""
},
"name": {
"description": "Name for this namespace. Informative only.",
"type": "string"
},
"recommenders": {
"description": "Recommenders for the namespace keyed by the recommender action type. Action must be 'recommend-items', 'related-items', or 'rerank-items'.",
"items": {
"$ref": "#/$defs/recommenderAction"
}
}
},
"type": "object"
}
},
"type": "object"
},
"recommender": {
"additionalProperties": false,
"description": "Recommender path that uniquely identifies the recommender within a namespace and API action. The recommender path is used to map an API request to a recommender.",
"patternProperties": {
"^[a-zA-Z0-9_-]*$": {
"additionalProperties": false,
"properties": {
"cacheControl": {
"$ref": "#/$defs/cacheControl",
"description": "Cache control settings that apply to all variations for this recommender (overrides configs at root and namespace)."
},
"description": {
"description": "Description for this recommender. Informative only.",
"type": "string"
},
"experiments": {
"$ref": "#/$defs/experimentFeature",
"description": "Controls how the variation is selected for each request for the recommender keyed by a feature name."
},
"name": {
"description": "Name for this recommender. Informative only.",
"type": "string"
},
"responsePostProcessor": {
"$ref": "#/$defs/responsePostProcessor",
"description": "Post process the response before returning it to the client"
},
"variations": {
"$ref": "#/$defs/variations",
"description": "Variations for the recommender."
}
},
"required": [
"variations"
],
"type": "object"
}
},
"type": "object"
},
"recommenderAction": {
"additionalProperties": false,
"description": "Defines the recommender action and its configuration.",
"patternProperties": {
"^(?:recommend-items|related-items|rerank-items)$": {
"$ref": "#/$defs/recommender"
}
},
"type": "object"
},
"responsePostProcessor": {
"description": "Post process the response before returning it to the client",
"oneOf": [
{
"additionalProperties": false,
"description": "AWS Lambda response post-processor",
"properties": {
"arn": {
"description": "AWS Lambda function ARN",
"pattern": "^arn:[\\w-]+:lambda:[a-z]{2}-((?:gov|iso|isob)-)?[a-z]+-\\d{1}?:\\d{12}?:function/.*$",
"type": "string"
},
"lookAheadMaximumValue": {
"description": "Used with 'lookAheadMultiplier' to set a cap on how many items are requested from the origin recommender. The look ahead value will therefore be min(numResults * lookAheadMultiplier, lookAheadMaximumValue)",
"minimum": 1,
"type": "number"
},
"lookAheadMultiplier": {
"description": "Multiplier to apply to the 'numResults' query string parameter before making the inference call to the origin recommender. This is useful in situations where the post-processor logic may remove items from the intermediate inference response and therefore increases the liklihood of returning the caller's desired 'numResults' in the post-processed result.",
"minimum": 1,
"type": "number"
},
"type": {
"enum": [
"lambda"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"type": "object"
}
],
"type": "object"
},
"ruleValueMapping": {
"description": "Maps a rule's value to a final resolved value",
"properties": {
"additionalProperties": false,
"mapTo": {
"description": "Final resolved value to use if the rule's value applied to operator and value is true",
"type": [
"string",
"number"
]
},
"operator": {
"description": "Operator to apply to rule value",
"enum": [
"equals",
"less-than",
"greater-than",
"contains",
"starts-with",
"ends-with"
],
"type": "string"
},
"value": {
"description": "Value to compare rule value to using the operator",
"type": [
"string",
"number"
]
}
},
"required": [
"operator",
"value",
"mapTo"
],
"type": "object"
},
"variations": {
"additionalProperties": false,
"description": "Variations for a recommender that are keyed by a unique variation name. The variation name must match an Evidently feature name if an experiment is also defined for the recommender. Otherwise, the first variation is used.",
"patternProperties": {
"^[a-zA-Z0-9_-]*$": {
"anyOf": [
{
"additionalProperties": false,
"description": "Amazon Personalize campaign or recommender",
"properties": {
"arn": {
"description": "ARN of the Personalize campaign or recommender.",
"pattern": "^arn:[\\w-]+:personalize:[a-z]{2}-((?:gov|iso|isob)-)?[a-z]+-\\d{1}?:\\d{12}?:(?:campaign|recommender)/.*$",
"type": "string"
},
"filters": {
"description": "Filters to choose from when determining which one to apply to a request. The first filter that matches the condition of the request is used.",
"items": {
"additionalProperties": false,
"description": "Personalize filter to use with this recommender when retrieving recommendations.",
"properties": {
"arn": {
"description": "ARN of the Personalize Filter.",
"pattern": "^arn:[\\w-]+:personalize:[a-z]{2}-((?:gov|iso|isob)-)?[a-z]+-\\d{1}?:\\d{12}?:filter/.*$",
"type": "string"
},
"autoDynamicFilterValues": {
"$ref": "#/$defs/autoDynamicFilterValues",
"description": "Automatic dynamic filter value rules."
},
"condition": {
"description": "Indicates if a user is required to evaluate the expression for this filter. This is useful when a filter is specified for a related items recommender but should be conditionally applied depending on whether a user is specified in the request.",
"enum": [
"user-required"
],
"type": "string"
}
},
"required": [
"arn"
],
"type": "object"
},
"type": "array"
},
"type": {
"description": "",
"enum": [
"personalize-campaign",
"personalize-recommender"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "AWS Lambda function to invoke to retrieve recommendations for this recommender.",
"properties": {
"arn": {
"description": "AWS Lambda function ARN",
"pattern": "^arn:[\\w-]+:lambda:[a-z]{2}-((?:gov|iso|isob)-)?[a-z]+-\\d{1}?:\\d{12}?:function/.*$",
"type": "string"
},
"type": {
"description": "Identifies this variation as a Lambda function.",
"enum": [
"function"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Amazon SageMaker inference endpoint to invoke to retrieve recommendations for this recommender.",
"properties": {
"endpointName": {
"description": "Amazon SageMaker endpoint name",
"type": "string"
},
"type": {
"description": "Identifies this variation as a SageMaker inference endpoint.",
"enum": [
"sagemaker"
],
"type": "string"
}
},
"required": [
"type",
"endpointName"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "HTTP endpoint to call to retrieve recommendations",
"properties": {
"type": {
"description": "",
"enum": [
"http"
],
"type": "string"
},
"url": {
"description": "",
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
]
}
},
"type": "object"
}
},
"$id": "/schemas/personalization_apis_config_schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"description": "",
"properties": {
"autoContext": {
"$ref": "#/$defs/autoContext",
"description": "Automatic context rules that apply to all Personalize recommenders unless overridden at the namespace, recommender, or variation level."
},
"cacheControl": {
"$ref": "#/$defs/cacheControl",
"description": "Cache control settings that apply to all recommenders unless overridden at the namespace, recommender, or variation level."
},
"description": {
"description": "Description of this configuration. Informative only.",
"type": "string"
},
"namespaces": {
"$ref": "#/$defs/namespaces",
"description": "Namespaces keyed by the namespace path which is used to map API requests to a namespace. Analagous to an applications and/or Personalize dataset groups."
},
"version": {
"description": "Indicates the version of the configuration. Will be emitted as the value of the 'X-Personalization-Config-Version' response header.",
"type": "string"
}
},
"required": [
"namespaces"
],
"title": "Personalization APIs Configuration",
"type": "object"
} | MIT-0 | en |
aws-samples/personalization-apis | 3f1aa7a772d4fe5faf0d7647d99322f0e33431ad | 2024-04-05T16:43:54 | src/config_validator_function/personalization_apis_config_schema.json | 39 | 2024-05-27T05:38:26.523475Z | {
"$defs": {
"autoContext": {
"additionalProperties": false,
"description": "Automatic context fields and rules keyed by Amazon Personalize field name in camel case format (i.e. 'deviceType' rather than 'DEVICE_TYPE').",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Default value to use when no rules are matched for the field.",
"type": [
"string",
"number"
]
},
"description": {
"description": "Informative description of auto context field and rules.",
"type": "string"
},
"evaluateAll": {
"default": false,
"description": "Whether to evaluate all rules, potentially resolving to multiple values, or stop at the first matched rule",
"type": "boolean"
},
"rules": {
"description": "Rules for evaluating automatic context values for the field",
"items": {
"$ref": "#/$defs/autoContextOrFilterRule"
},
"type": "array"
},
"type": {
"description": "Data type for the context field.",
"enum": [
"string",
"integer",
"long",
"float"
],
"type": "string"
}
},
"required": [
"type",
"rules"
],
"type": "object"
}
},
"type": "object"
},
"autoContextOrFilterRule": {
"anyOf": [
{
"additionalProperties": false,
"description": "Rule that matches a header value based on an operator and value and, if true, optionally maps to a final resolved value.",
"properties": {
"header": {
"description": "HTTP request header name",
"type": "string"
},
"type": {
"description": "Rule type based on an HTTP request header value",
"enum": [
"header-value"
],
"type": "string"
},
"valueMappings": {
"description": "Optional value mapping expressions to resolve to final value",
"items": {
"$ref": "#/$defs/ruleValueMapping",
"type": "array"
},
"type": "array"
}
},
"required": [
"type",
"header"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Rules based on temporal/seasonal aspects of the current time in the user's time zone and hemisphere",
"properties": {
"type": {
"description": "Temporal/seasonal aspect",
"enum": [
"hour-of-day",
"day-of-week",
"season-of-year"
],
"type": "string"
},
"valueMappings": {
"description": "Optional value mapping expressions to resolve to final value",
"items": {
"$ref": "#/$defs/ruleValueMapping",
"type": "array"
},
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"autoDynamicFilterValues": {
"additionalProperties": false,
"description": "Automatic filter parameter value rules keyed by filter parameter name.",
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Default value to use when no rules are matched",
"type": [
"string",
"number"
]
},
"description": {
"description": "Informative description of auto filter field and rules.",
"type": "string"
},
"evaluateAll": {
"default": false,
"description": "Whether to evaluate all rules, potentially resolving to multiple values, or stop at the first matched rule",
"type": "boolean"
},
"rules": {
"description": "Rules for evaluating automatic filter values for the filter parameter",
"items": {
"$ref": "#/$defs/autoContextOrFilterRule"
},
"type": "array"
},
"type": {
"description": "Data type for the parameter value",
"enum": [
"string",
"integer",
"long",
"float"
],
"type": "string"
}
},
"required": [
"type",
"rules"
],
"type": "object"
}
},
"type": "object"
},
"cacheControl": {
"additionalProperties": false,
"properties": {
"autoProvision": {
"description": "Indicates whether the personalization API application should automatically update the CloudFront cache and origin request policies",
"type": "boolean"
},
"noUserSpecified": {
"$ref": "#/$defs/cacheControlType",
"description": "Cache control settings to use when a user is NOT specified in the request"
},
"syntheticUserSpecified": {
"$ref": "#/$defs/cacheControlType",
"description": "Cache control settings to use when a synthetic user is specified in the request"
},
"userSpecified": {
"$ref": "#/$defs/cacheControlType",
"description": "Cache control settings to use when a user is specified in the request"
}
},
"required": [
"userSpecified",
"syntheticUserSpecified",
"noUserSpecified"
],
"type": "object"
},
"cacheControlType": {
"additionalProperties": false,
"properties": {
"directives": {
"description": "Additional directives, as comma delimited list, to include in the Cache-Control response header. For example, 'public' indicates that responses may be cached in shared caches like CloudFront and 'private' indicates that responses may only be cached in browsers.",
"type": "string"
},
"maxAge": {
"description": "The maximum amount of time (in seconds) that responses may be cached. A 'max-age' directive with this value will be included in the Cache-Control response header.",
"minimum": 0,
"type": "integer"
}
},
"required": [
"maxAge",
"directives"
],
"type": "object"
},
"experiment": {
"additionalProperties": false,
"properties": {
"description": {
"description": "Informative description of experiment.",
"type": "string"
},
"method": {
"enum": [
"evidently"
],
"type": "string"
},
"metrics": {
"additionalProperties": false,
"description": "Metrics supported by the experiment keyed by the metric name as defined for the Evidently experiment.",
"patternProperties": {
"^[\\S]+$": {
"properties": {
"entityIdKey": {
"description": "Entity ID Key for the Evidently metric to track exposures and conversions (e.g., 'userDetails.userId').",
"type": "string"
},
"trackExposures": {
"description": "Indicates whether exposures should be tracked with a custom event.",
"type": "boolean"
},
"valueKey": {
"description": "Value Key for the Evidently metric to track exposures and conversions (e.g., 'details.productClicked').",
"type": "string"
}
},
"required": [
"entityIdKey",
"valueKey"
],
"type": "object"
}
},
"type": "object"
},
"project": {
"type": "string"
}
},
"required": [
"method",
"project",
"metrics"
],
"type": "object"
},
"experimentFeature": {
"additionalProperties": false,
"description": "Evidently experiments for the recommender keyed by the feature name specified in the Evidently feature and in API requests. If only one experiment is defined in the configuration, it will be used as the default if a feature is not specified on the request.",
"patternProperties": {
"^[-a-zA-Z0-9._]*$": {
"$ref": "#/$defs/experiment"
}
},
"type": "object"
},
"inferenceItemMetadata": {
"description": "Inference item metadata datastore configuration. Defines how the Personalization APIs store and cache item metadata used to decorate responses.",
"oneOf": [
{
"additionalProperties": false,
"description": "Personalize-provided item metadata in the Personalize response. IMPORTANT: the Personalize campaign/recommender must have item metadata return enabled for this to work (see enableMetadataWithRecommendations parameter).",
"properties": {
"itemColumns": {
"description": "List of column names to request from Personalize campaign/recommender to return in its responses.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"personalize"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Local DBM database that is built and downloaded to the local Lambda volume from the S3 staging bucket for each API function instance.",
"properties": {
"syncInterval": {
"description": "Number of seconds to wait before checking the S3 staging bucket for updated DBM files.",
"maximum": 3600,
"minimum": 5,
"type": "integer"
},
"type": {
"enum": [
"localdb"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "DynamoDB table that is populated with item metadata from S3 staging bucket and queried to decorate API responses.",
"properties": {
"autoProvision": {
"description": "Indicates whether the personalization API application should automatically create and update DynamoDB tables according to the configuration",
"type": "boolean"
},
"billingMode": {
"description": "DynamoDB billing mode to use when auto provisioning is enabled.",
"enum": [
"PROVISIONED",
"PAY_PER_REQUEST"
],
"type": "string"
},
"provisionedThroughput": {
"description": "DynamoDB provisioned throughput read and write capacity units to use when auto provisioning is enabled.",
"properties": {
"readCapacityUnits": {
"minimum": 0,
"type": "integer"
},
"writeCapacityUnits": {
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"type": {
"enum": [
"dynamodb"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"namespaces": {
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9_-]*$": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"recommenders"
]
},
{
"required": [
"eventTargets"
]
}
],
"description": "Namespace configuration that contains one or more recommenders.",
"properties": {
"autoContext": {
"$ref": "#/$defs/autoContext",
"description": "Automatic context rules that apply to all Personalize recommenders for this namespace unless overridden at the recommender or variation level (overrides config at root)."
},
"cacheControl": {
"$ref": "#/$defs/cacheControl",
"description": "Cache control settings that apply to all recommenders for this namespace unless overridden at the recommender or variation level (overrides config at root)."
},
"description": {
"description": "Description for this namespace. Informative only.",
"type": "string"
},
"eventTargets": {
"description": "Destinations to send events to via the events API endpoint for a namespace",
"items": {
"anyOf": [
{
"additionalProperties": false,
"description": "Amazon Personalize event tracker",
"properties": {
"trackingId": {
"description": "Personalize event tracker tracking ID.",
"pattern": "[a-zA-Z0-9\\-]+",
"type": "string"
},
"type": {
"description": "",
"enum": [
"personalize-event-tracker"
],
"type": "string"
}
},
"required": [
"type",
"trackingId"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Amazon Kinesis data stream or firehose.",
"properties": {
"streamName": {
"description": "Kinesis stream or firehose name",
"pattern": "[a-zA-Z0-9_.-]+",
"type": "string"
},
"type": {
"description": "Identifies this variation as a Lambda function.",
"enum": [
"kinesis-stream",
"kinesis-firehose"
],
"type": "string"
}
},
"required": [
"type",
"streamName"
],
"type": "object"
}
]
},
"type": "array"
},
"inferenceItemMetadata": {
"$ref": "#/$defs/inferenceItemMetadata",
"description": ""
},
"name": {
"description": "Name for this namespace. Informative only.",
"type": "string"
},
"recommenders": {
"description": "Recommenders for the namespace keyed by the recommender action type. Action must be 'recommend-items', 'related-items', or 'rerank-items'.",
"items": {
"$ref": "#/$defs/recommenderAction"
}
}
},
"type": "object"
}
},
"type": "object"
},
"recommender": {
"additionalProperties": false,
"description": "Recommender path that uniquely identifies the recommender within a namespace and API action. The recommender path is used to map an API request to a recommender.",
"patternProperties": {
"^[a-zA-Z0-9_-]*$": {
"additionalProperties": false,
"properties": {
"cacheControl": {
"$ref": "#/$defs/cacheControl",
"description": "Cache control settings that apply to all variations for this recommender (overrides configs at root and namespace)."
},
"description": {
"description": "Description for this recommender. Informative only.",
"type": "string"
},
"experiments": {
"$ref": "#/$defs/experimentFeature",
"description": "Controls how the variation is selected for each request for the recommender keyed by a feature name."
},
"name": {
"description": "Name for this recommender. Informative only.",
"type": "string"
},
"responsePostProcessor": {
"$ref": "#/$defs/responsePostProcessor",
"description": "Post process the response before returning it to the client"
},
"variations": {
"$ref": "#/$defs/variations",
"description": "Variations for the recommender."
}
},
"required": [
"variations"
],
"type": "object"
}
},
"type": "object"
},
"recommenderAction": {
"additionalProperties": false,
"description": "Defines the recommender action and its configuration.",
"patternProperties": {
"^(?:recommend-items|related-items|rerank-items)$": {
"$ref": "#/$defs/recommender"
}
},
"type": "object"
},
"responsePostProcessor": {
"description": "Post process the response before returning it to the client",
"oneOf": [
{
"additionalProperties": false,
"description": "AWS Lambda response post-processor",
"properties": {
"arn": {
"description": "AWS Lambda function ARN",
"pattern": "^arn:[\\w-]+:lambda:[a-z]{2}-((?:gov|iso|isob)-)?[a-z]+-\\d{1}?:\\d{12}?:function/.*$",
"type": "string"
},
"lookAheadMaximumValue": {
"description": "Used with 'lookAheadMultiplier' to set a cap on how many items are requested from the origin recommender. The look ahead value will therefore be min(numResults * lookAheadMultiplier, lookAheadMaximumValue)",
"minimum": 1,
"type": "number"
},
"lookAheadMultiplier": {
"description": "Multiplier to apply to the 'numResults' query string parameter before making the inference call to the origin recommender. This is useful in situations where the post-processor logic may remove items from the intermediate inference response and therefore increases the liklihood of returning the caller's desired 'numResults' in the post-processed result.",
"minimum": 1,
"type": "number"
},
"type": {
"enum": [
"lambda"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"type": "object"
}
],
"type": "object"
},
"ruleValueMapping": {
"description": "Maps a rule's value to a final resolved value",
"properties": {
"additionalProperties": false,
"mapTo": {
"description": "Final resolved value to use if the rule's value applied to operator and value is true",
"type": [
"string",
"number"
]
},
"operator": {
"description": "Operator to apply to rule value",
"enum": [
"equals",
"less-than",
"greater-than",
"contains",
"starts-with",
"ends-with"
],
"type": "string"
},
"value": {
"description": "Value to compare rule value to using the operator",
"type": [
"string",
"number"
]
}
},
"required": [
"operator",
"value",
"mapTo"
],
"type": "object"
},
"variations": {
"additionalProperties": false,
"description": "Variations for a recommender that are keyed by a unique variation name. The variation name must match an Evidently feature name if an experiment is also defined for the recommender. Otherwise, the first variation is used.",
"patternProperties": {
"^[a-zA-Z0-9_-]*$": {
"anyOf": [
{
"additionalProperties": false,
"description": "Amazon Personalize campaign or recommender",
"properties": {
"arn": {
"description": "ARN of the Personalize campaign or recommender.",
"pattern": "^arn:[\\w-]+:personalize:[a-z]{2}-((?:gov|iso|isob)-)?[a-z]+-\\d{1}?:\\d{12}?:(?:campaign|recommender)/.*$",
"type": "string"
},
"filters": {
"description": "Filters to choose from when determining which one to apply to a request. The first filter that matches the condition of the request is used.",
"items": {
"additionalProperties": false,
"description": "Personalize filter to use with this recommender when retrieving recommendations.",
"properties": {
"arn": {
"description": "ARN of the Personalize Filter.",
"pattern": "^arn:[\\w-]+:personalize:[a-z]{2}-((?:gov|iso|isob)-)?[a-z]+-\\d{1}?:\\d{12}?:filter/.*$",
"type": "string"
},
"autoDynamicFilterValues": {
"$ref": "#/$defs/autoDynamicFilterValues",
"description": "Automatic dynamic filter value rules."
},
"condition": {
"description": "Indicates if a user is required to evaluate the expression for this filter. This is useful when a filter is specified for a related items recommender but should be conditionally applied depending on whether a user is specified in the request.",
"enum": [
"user-required"
],
"type": "string"
}
},
"required": [
"arn"
],
"type": "object"
},
"type": "array"
},
"type": {
"description": "Recommender type: campaign or domain recommender",
"enum": [
"personalize-campaign",
"personalize-recommender"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "AWS Lambda function to invoke to retrieve recommendations for this recommender.",
"properties": {
"arn": {
"description": "AWS Lambda function ARN",
"pattern": "^arn:[\\w-]+:lambda:[a-z]{2}-((?:gov|iso|isob)-)?[a-z]+-\\d{1}?:\\d{12}?:function/.*$",
"type": "string"
},
"type": {
"description": "Identifies this variation as a Lambda function.",
"enum": [
"function"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Amazon SageMaker inference endpoint to invoke to retrieve recommendations for this recommender.",
"properties": {
"endpointName": {
"description": "Amazon SageMaker endpoint name",
"type": "string"
},
"type": {
"description": "Identifies this variation as a SageMaker inference endpoint.",
"enum": [
"sagemaker"
],
"type": "string"
}
},
"required": [
"type",
"endpointName"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "HTTP endpoint to call to retrieve recommendations",
"properties": {
"type": {
"description": "",
"enum": [
"http"
],
"type": "string"
},
"url": {
"description": "",
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
]
}
},
"type": "object"
}
},
"$id": "/schemas/personalization_apis_config_schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"description": "",
"properties": {
"autoContext": {
"$ref": "#/$defs/autoContext",
"description": "Automatic context rules that apply to all Personalize recommenders unless overridden at the namespace, recommender, or variation level."
},
"cacheControl": {
"$ref": "#/$defs/cacheControl",
"description": "Cache control settings that apply to all recommenders unless overridden at the namespace, recommender, or variation level."
},
"description": {
"description": "Description of this configuration. Informative only.",
"type": "string"
},
"namespaces": {
"$ref": "#/$defs/namespaces",
"description": "Namespaces keyed by the namespace path which is used to map API requests to a namespace. Analagous to an applications and/or Personalize dataset groups."
},
"version": {
"description": "Indicates the version of the configuration. Will be emitted as the value of the 'X-Personalization-Config-Version' response header.",
"type": "string"
}
},
"required": [
"namespaces"
],
"title": "Personalization APIs Configuration",
"type": "object"
} | MIT-0 | en |
aws-samples/personalization-apis | 57a4e0109bc20b831c59cb88d3292421e7141c13 | 2022-02-05T02:25:40 | src/config_validator_function/personalization_apis_config_schema.json | 39 | 2024-05-27T05:38:26.523475Z | {
"$defs": {
"autoContext": {
"additionalProperties": false,
"description": "Automatic context fields and rules keyed by Amazon Personalize field name in camel case format (i.e. 'deviceType' rather than 'DEVICE_TYPE').",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Default value to use when no rules are matched for the field.",
"type": [
"string",
"number"
]
},
"description": {
"description": "Informative description of auto context field and rules.",
"type": "string"
},
"evaluateAll": {
"default": false,
"description": "Whether to evaluate all rules, potentially resolving to multiple values, or stop at the first matched rule",
"type": "boolean"
},
"rules": {
"description": "Rules for evaluating automatic context values for the field",
"items": {
"$ref": "#/$defs/autoContextOrFilterRule"
},
"type": "array"
},
"type": {
"description": "Data type for the context field.",
"enum": [
"string",
"integer",
"long",
"float"
],
"type": "string"
}
},
"required": [
"type",
"rules"
],
"type": "object"
}
},
"type": "object"
},
"autoContextOrFilterRule": {
"anyOf": [
{
"additionalProperties": false,
"description": "Rule that matches a header value based on an operator and value and, if true, optionally maps to a final resolved value.",
"properties": {
"header": {
"description": "HTTP request header name",
"type": "string"
},
"type": {
"description": "Rule type based on an HTTP request header value",
"enum": [
"header-value"
],
"type": "string"
},
"valueMappings": {
"description": "Optional value mapping expressions to resolve to final value",
"items": {
"$ref": "#/$defs/ruleValueMapping",
"type": "array"
},
"type": "array"
}
},
"required": [
"type",
"header"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Rules based on temporal/seasonal aspects of the current time in the user's time zone and hemisphere",
"properties": {
"type": {
"description": "Temporal/seasonal aspect",
"enum": [
"hour-of-day",
"day-of-week",
"season-of-year"
],
"type": "string"
},
"valueMappings": {
"description": "Optional value mapping expressions to resolve to final value",
"items": {
"$ref": "#/$defs/ruleValueMapping",
"type": "array"
},
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"autoDynamicFilterValues": {
"additionalProperties": false,
"description": "Automatic filter parameter value rules keyed by filter parameter name.",
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Default value to use when no rules are matched",
"type": [
"string",
"number"
]
},
"description": {
"description": "Informative description of auto filter field and rules.",
"type": "string"
},
"evaluateAll": {
"default": false,
"description": "Whether to evaluate all rules, potentially resolving to multiple values, or stop at the first matched rule",
"type": "boolean"
},
"rules": {
"description": "Rules for evaluating automatic filter values for the filter parameter",
"items": {
"$ref": "#/$defs/autoContextOrFilterRule"
},
"type": "array"
},
"type": {
"description": "Data type for the parameter value",
"enum": [
"string",
"integer",
"long",
"float"
],
"type": "string"
}
},
"required": [
"type",
"rules"
],
"type": "object"
}
},
"type": "object"
},
"cacheControl": {
"additionalProperties": false,
"properties": {
"autoProvision": {
"description": "Indicates whether the personalization API application should automatically update the CloudFront cache and origin request policies",
"type": "boolean"
},
"noUserSpecified": {
"$ref": "#/$defs/cacheControlType",
"description": "Cache control settings to use when a user is NOT specified in the request"
},
"syntheticUserSpecified": {
"$ref": "#/$defs/cacheControlType",
"description": "Cache control settings to use when a synthetic user is specified in the request"
},
"userSpecified": {
"$ref": "#/$defs/cacheControlType",
"description": "Cache control settings to use when a user is specified in the request"
}
},
"required": [
"userSpecified",
"syntheticUserSpecified",
"noUserSpecified"
],
"type": "object"
},
"cacheControlType": {
"additionalProperties": false,
"properties": {
"directives": {
"description": "Additional directives, as comma delimited list, to include in the Cache-Control response header. For example, 'public' indicates that responses may be cached in shared caches like CloudFront and 'private' indicates that responses may only be cached in browsers.",
"type": "string"
},
"maxAge": {
"description": "The maximum amount of time (in seconds) that responses may be cached. A 'max-age' directive with this value will be included in the Cache-Control response header.",
"minimum": 0,
"type": "integer"
}
},
"required": [
"maxAge",
"directives"
],
"type": "object"
},
"experiment": {
"additionalProperties": false,
"properties": {
"description": {
"description": "Informative description of experiment.",
"type": "string"
},
"method": {
"enum": [
"evidently"
],
"type": "string"
},
"metrics": {
"additionalProperties": false,
"description": "Metrics supported by the experiment keyed by the metric name as defined for the Evidently experiment.",
"patternProperties": {
"^[\\S]+$": {
"properties": {
"entityIdKey": {
"description": "Entity ID Key for the Evidently metric to track exposures and conversions (e.g., 'userDetails.userId').",
"type": "string"
},
"valueKey": {
"description": "Value Key for the Evidently metric to track exposures and conversions (e.g., 'details.productClicked').",
"type": "string"
}
},
"required": [
"entityIdKey",
"valueKey"
],
"type": "object"
}
},
"type": "object"
},
"project": {
"type": "string"
}
},
"required": [
"method",
"project",
"metrics"
],
"type": "object"
},
"experimentFeature": {
"additionalProperties": false,
"description": "Evidently experiments for the recommender keyed by the feature name specified in the Evidently feature and in API requests. If only one experiment is defined in the configuration, it will be used as the default if a feature is not specified on the request.",
"patternProperties": {
"^[-a-zA-Z0-9._]*$": {
"$ref": "#/$defs/experiment"
}
},
"type": "object"
},
"inferenceItemMetadata": {
"description": "Inference item metadata datastore configuration. Defines how the Personalization APIs store and cache item metadata used to decorate responses.",
"oneOf": [
{
"additionalProperties": false,
"description": "Local DBM database that is built and downloaded to the local Lambda volume from the S3 staging bucket for each API function instance.",
"properties": {
"type": {
"enum": [
"localdb"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "DynamoDB table that is populated with item metadata from S3 staging bucket and queried to decorate API responses.",
"properties": {
"autoProvision": {
"description": "Indicates whether the personalization API application should automatically create and update DynamoDB tables according to the configuration",
"type": "boolean"
},
"billingMode": {
"description": "DynamoDB billing mode to use when auto provisioning is enabled.",
"enum": [
"PROVISIONED",
"PAY_PER_REQUEST"
],
"type": "string"
},
"provisionedThroughput": {
"description": "DynamoDB provisioned throughput read and write capacity units to use when auto provisioning is enabled.",
"properties": {
"readCapacityUnits": {
"minimum": 0,
"type": "integer"
},
"writeCapacityUnits": {
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"type": {
"enum": [
"dynamodb"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"namespaces": {
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9_-]*$": {
"additionalProperties": false,
"description": "Namespace configuration that contains one or more recommenders.",
"properties": {
"autoContext": {
"$ref": "#/$defs/autoContext",
"description": "Automatic context rules that apply to all Personalize recommenders for this namespace unless overridden at the recommender or variation level (overrides config at root)."
},
"cacheControl": {
"$ref": "#/$defs/cacheControl",
"description": "Cache control settings that apply to all recommenders for this namespace unless overridden at the recommender or variation level (overrides config at root)."
},
"description": {
"description": "Description for this namespace. Informative only.",
"type": "string"
},
"eventTargets": {
"description": "Destinations to send events to via the events API endpoint for a namespace",
"items": {
"anyOf": [
{
"additionalProperties": false,
"description": "Amazon Personalize event tracker",
"properties": {
"trackingId": {
"description": "Personalize event tracker tracking ID.",
"pattern": "[a-zA-Z0-9\\-]+",
"type": "string"
},
"type": {
"description": "",
"enum": [
"personalize-event-tracker"
],
"type": "string"
}
},
"required": [
"type",
"trackingId"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Amazon Kinesis data stream or firehose.",
"properties": {
"streamName": {
"description": "Kinesis stream or firehose name",
"pattern": "[a-zA-Z0-9_.-]+",
"type": "string"
},
"type": {
"description": "Identifies this variation as a Lambda function.",
"enum": [
"kinesis-stream",
"kinesis-firehose"
],
"type": "string"
}
},
"required": [
"type",
"streamName"
],
"type": "object"
}
]
},
"type": "array"
},
"inferenceItemMetadata": {
"$ref": "#/$defs/inferenceItemMetadata",
"description": ""
},
"name": {
"description": "Name for this namespace. Informative only.",
"type": "string"
},
"recommenders": {
"description": "Recommenders for the namespace keyed by the recommender action type. Action must be 'recommend-items', 'related-items', or 'rerank-items'.",
"items": {
"$ref": "#/$defs/recommenderAction"
}
}
},
"required": [
"recommenders"
],
"type": "object"
}
},
"type": "object"
},
"recommender": {
"additionalProperties": false,
"description": "Recommender path that uniquely identifies the recommender within a namespace and API action. The recommender path is used to map an API request to a recommender.",
"patternProperties": {
"^[a-zA-Z0-9_-]*$": {
"additionalProperties": false,
"properties": {
"cacheControl": {
"$ref": "#/$defs/cacheControl",
"description": "Cache control settings that apply to all variations for this recommender (overrides configs at root and namespace)."
},
"description": {
"description": "Description for this recommender. Informative only.",
"type": "string"
},
"experiments": {
"$ref": "#/$defs/experimentFeature",
"description": "Controls how the variation is selected for each request for the recommender keyed by a feature name."
},
"name": {
"description": "Name for this recommender. Informative only.",
"type": "string"
},
"responsePostProcessor": {
"$ref": "#/$defs/responsePostProcessor",
"description": "Post process the response before returning it to the client"
},
"variations": {
"$ref": "#/$defs/variations",
"description": "Variations for the recommender."
}
},
"required": [
"variations"
],
"type": "object"
}
},
"type": "object"
},
"recommenderAction": {
"additionalProperties": false,
"description": "Defines the recommender action and its configuration.",
"patternProperties": {
"^(?:recommend-items|related-items|rerank-items)$": {
"$ref": "#/$defs/recommender"
}
},
"type": "object"
},
"responsePostProcessor": {
"description": "Post process the response before returning it to the client",
"oneOf": [
{
"additionalProperties": false,
"description": "AWS Lambda response post-processor",
"properties": {
"arn": {
"description": "AWS Lambda function ARN",
"pattern": "^arn:[\\w-]+:lambda:[a-z]{2}-((?:gov|iso|isob)-)?[a-z]+-\\d{1}?:\\d{12}?:function/.*$",
"type": "string"
},
"lookAheadMaximumValue": {
"description": "Used with 'lookAheadMultiplier' to set a cap on how many items are requested from the origin recommender. The look ahead value will therefore be min(numResults * lookAheadMultiplier, lookAheadMaximumValue)",
"minimum": 1,
"type": "number"
},
"lookAheadMultiplier": {
"description": "Multiplier to apply to the 'numResults' query string parameter before making the inference call to the origin recommender. This is useful in situations where the post-processor logic may remove items from the intermediate inference response and therefore increases the liklihood of returning the caller's desired 'numResults' in the post-processed result.",
"minimum": 1,
"type": "number"
},
"type": {
"enum": [
"lambda"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"type": "object"
}
],
"type": "object"
},
"ruleValueMapping": {
"description": "Maps a rule's value to a final resolved value",
"properties": {
"additionalProperties": false,
"mapTo": {
"description": "Final resolved value to use if the rule's value applied to operator and value is true",
"type": [
"string",
"number"
]
},
"operator": {
"description": "Operator to apply to rule value",
"enum": [
"equals",
"less-than",
"greater-than",
"contains",
"starts-with",
"ends-with"
],
"type": "string"
},
"value": {
"description": "Value to compare rule value to using the operator",
"type": [
"string",
"number"
]
}
},
"required": [
"operator",
"value",
"mapTo"
],
"type": "object"
},
"variations": {
"additionalProperties": false,
"description": "Variations for a recommender that are keyed by a unique variation name. The variation name must match an Evidently feature name if an experiment is also defined for the recommender. Otherwise, the first variation is used.",
"patternProperties": {
"^[a-zA-Z0-9_-]*$": {
"anyOf": [
{
"additionalProperties": false,
"description": "Amazon Personalize campaign or recommender",
"properties": {
"arn": {
"description": "ARN of the Personalize campaign or recommender.",
"pattern": "^arn:[\\w-]+:personalize:[a-z]{2}-((?:gov|iso|isob)-)?[a-z]+-\\d{1}?:\\d{12}?:(?:campaign|recommender)/.*$",
"type": "string"
},
"filters": {
"description": "Filters to choose from when determining which one to apply to a request. The first filter that matches the condition of the request is used.",
"items": {
"additionalProperties": false,
"description": "Personalize filter to use with this recommender when retrieving recommendations.",
"properties": {
"arn": {
"description": "ARN of the Personalize Filter.",
"pattern": "^arn:[\\w-]+:personalize:[a-z]{2}-((?:gov|iso|isob)-)?[a-z]+-\\d{1}?:\\d{12}?:filter/.*$",
"type": "string"
},
"autoDynamicFilterValues": {
"$ref": "#/$defs/autoDynamicFilterValues",
"description": "Automatic dynamic filter value rules."
},
"condition": {
"description": "Indicates if a user is required to evaluate the expression for this filter. This is useful when a filter is specified for a related items recommender but should be conditionally applied depending on whether a user is specified in the request.",
"enum": [
"user-required"
],
"type": "string"
}
},
"required": [
"arn"
],
"type": "object"
},
"type": "array"
},
"type": {
"description": "",
"enum": [
"personalize-campaign",
"personalize-recommender"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "AWS Lambda function to invoke to retrieve recommendations for this recommender.",
"properties": {
"arn": {
"description": "AWS Lambda function ARN",
"pattern": "^arn:[\\w-]+:lambda:[a-z]{2}-((?:gov|iso|isob)-)?[a-z]+-\\d{1}?:\\d{12}?:function/.*$",
"type": "string"
},
"type": {
"description": "Identifies this variation as a Lambda function.",
"enum": [
"function"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Amazon SageMaker inference endpoint to invoke to retrieve recommendations for this recommender.",
"properties": {
"endpointName": {
"description": "Amazon SageMaker endpoint name",
"type": "string"
},
"type": {
"description": "Identifies this variation as a SageMaker inference endpoint.",
"enum": [
"sagemaker"
],
"type": "string"
}
},
"required": [
"type",
"endpointName"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "HTTP endpoint to call to retrieve recommendations",
"properties": {
"type": {
"description": "",
"enum": [
"http"
],
"type": "string"
},
"url": {
"description": "",
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
]
}
},
"type": "object"
}
},
"$id": "/schemas/personalization_apis_config_schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"description": "",
"properties": {
"autoContext": {
"$ref": "#/$defs/autoContext",
"description": "Automatic context rules that apply to all Personalize recommenders unless overridden at the namespace, recommender, or variation level."
},
"cacheControl": {
"$ref": "#/$defs/cacheControl",
"description": "Cache control settings that apply to all recommenders unless overridden at the namespace, recommender, or variation level."
},
"description": {
"description": "Description of this configuration. Informative only.",
"type": "string"
},
"namespaces": {
"$ref": "#/$defs/namespaces",
"description": "Namespaces keyed by the namespace path which is used to map API requests to a namespace. Analagous to an applications and/or Personalize dataset groups."
},
"version": {
"description": "Indicates the version of the configuration. Will be emitted as the value of the 'X-Personalization-Config-Version' response header.",
"type": "string"
}
},
"required": [
"namespaces"
],
"title": "Personalization APIs Configuration",
"type": "object"
} | MIT-0 | en |
aws-samples/personalization-apis | 234fa50f25f16020c3fdef0824b99d2a4aadeb41 | 2022-05-03T18:02:29 | src/config_validator_function/personalization_apis_config_schema.json | 39 | 2024-05-27T05:38:26.523475Z | {
"$defs": {
"autoContext": {
"additionalProperties": false,
"description": "Automatic context fields and rules keyed by Amazon Personalize field name in camel case format (i.e. 'deviceType' rather than 'DEVICE_TYPE').",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Default value to use when no rules are matched for the field.",
"type": [
"string",
"number"
]
},
"description": {
"description": "Informative description of auto context field and rules.",
"type": "string"
},
"evaluateAll": {
"default": false,
"description": "Whether to evaluate all rules, potentially resolving to multiple values, or stop at the first matched rule",
"type": "boolean"
},
"rules": {
"description": "Rules for evaluating automatic context values for the field",
"items": {
"$ref": "#/$defs/autoContextOrFilterRule"
},
"type": "array"
},
"type": {
"description": "Data type for the context field.",
"enum": [
"string",
"integer",
"long",
"float"
],
"type": "string"
}
},
"required": [
"type",
"rules"
],
"type": "object"
}
},
"type": "object"
},
"autoContextOrFilterRule": {
"anyOf": [
{
"additionalProperties": false,
"description": "Rule that matches a header value based on an operator and value and, if true, optionally maps to a final resolved value.",
"properties": {
"header": {
"description": "HTTP request header name",
"type": "string"
},
"type": {
"description": "Rule type based on an HTTP request header value",
"enum": [
"header-value"
],
"type": "string"
},
"valueMappings": {
"description": "Optional value mapping expressions to resolve to final value",
"items": {
"$ref": "#/$defs/ruleValueMapping",
"type": "array"
},
"type": "array"
}
},
"required": [
"type",
"header"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Rules based on temporal/seasonal aspects of the current time in the user's time zone and hemisphere",
"properties": {
"type": {
"description": "Temporal/seasonal aspect",
"enum": [
"hour-of-day",
"day-of-week",
"season-of-year"
],
"type": "string"
},
"valueMappings": {
"description": "Optional value mapping expressions to resolve to final value",
"items": {
"$ref": "#/$defs/ruleValueMapping",
"type": "array"
},
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"autoDynamicFilterValues": {
"additionalProperties": false,
"description": "Automatic filter parameter value rules keyed by filter parameter name.",
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Default value to use when no rules are matched",
"type": [
"string",
"number"
]
},
"description": {
"description": "Informative description of auto filter field and rules.",
"type": "string"
},
"evaluateAll": {
"default": false,
"description": "Whether to evaluate all rules, potentially resolving to multiple values, or stop at the first matched rule",
"type": "boolean"
},
"rules": {
"description": "Rules for evaluating automatic filter values for the filter parameter",
"items": {
"$ref": "#/$defs/autoContextOrFilterRule"
},
"type": "array"
},
"type": {
"description": "Data type for the parameter value",
"enum": [
"string",
"integer",
"long",
"float"
],
"type": "string"
}
},
"required": [
"type",
"rules"
],
"type": "object"
}
},
"type": "object"
},
"cacheControl": {
"additionalProperties": false,
"properties": {
"autoProvision": {
"description": "Indicates whether the personalization API application should automatically update the CloudFront cache and origin request policies",
"type": "boolean"
},
"noUserSpecified": {
"$ref": "#/$defs/cacheControlType",
"description": "Cache control settings to use when a user is NOT specified in the request"
},
"syntheticUserSpecified": {
"$ref": "#/$defs/cacheControlType",
"description": "Cache control settings to use when a synthetic user is specified in the request"
},
"userSpecified": {
"$ref": "#/$defs/cacheControlType",
"description": "Cache control settings to use when a user is specified in the request"
}
},
"required": [
"userSpecified",
"syntheticUserSpecified",
"noUserSpecified"
],
"type": "object"
},
"cacheControlType": {
"additionalProperties": false,
"properties": {
"directives": {
"description": "Additional directives, as comma delimited list, to include in the Cache-Control response header. For example, 'public' indicates that responses may be cached in shared caches like CloudFront and 'private' indicates that responses may only be cached in browsers.",
"type": "string"
},
"maxAge": {
"description": "The maximum amount of time (in seconds) that responses may be cached. A 'max-age' directive with this value will be included in the Cache-Control response header.",
"minimum": 0,
"type": "integer"
}
},
"required": [
"maxAge",
"directives"
],
"type": "object"
},
"experiment": {
"additionalProperties": false,
"properties": {
"description": {
"description": "Informative description of experiment.",
"type": "string"
},
"method": {
"enum": [
"evidently"
],
"type": "string"
},
"metrics": {
"additionalProperties": false,
"description": "Metrics supported by the experiment keyed by the metric name as defined for the Evidently experiment.",
"patternProperties": {
"^[\\S]+$": {
"properties": {
"entityIdKey": {
"description": "Entity ID Key for the Evidently metric to track exposures and conversions (e.g., 'userDetails.userId').",
"type": "string"
},
"trackExposures": {
"description": "Indicates whether exposures should be tracked with a custom event.",
"type": "boolean"
},
"valueKey": {
"description": "Value Key for the Evidently metric to track exposures and conversions (e.g., 'details.productClicked').",
"type": "string"
}
},
"required": [
"entityIdKey",
"valueKey"
],
"type": "object"
}
},
"type": "object"
},
"project": {
"type": "string"
}
},
"required": [
"method",
"project",
"metrics"
],
"type": "object"
},
"experimentFeature": {
"additionalProperties": false,
"description": "Evidently experiments for the recommender keyed by the feature name specified in the Evidently feature and in API requests. If only one experiment is defined in the configuration, it will be used as the default if a feature is not specified on the request.",
"patternProperties": {
"^[-a-zA-Z0-9._]*$": {
"$ref": "#/$defs/experiment"
}
},
"type": "object"
},
"inferenceItemMetadata": {
"description": "Inference item metadata datastore configuration. Defines how the Personalization APIs store and cache item metadata used to decorate responses.",
"oneOf": [
{
"additionalProperties": false,
"description": "Local DBM database that is built and downloaded to the local Lambda volume from the S3 staging bucket for each API function instance.",
"properties": {
"syncInterval": {
"description": "Number of seconds to wait before checking the S3 staging bucket for updated DBM files.",
"maximum": 3600,
"minimum": 5,
"type": "integer"
},
"type": {
"enum": [
"localdb"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "DynamoDB table that is populated with item metadata from S3 staging bucket and queried to decorate API responses.",
"properties": {
"autoProvision": {
"description": "Indicates whether the personalization API application should automatically create and update DynamoDB tables according to the configuration",
"type": "boolean"
},
"billingMode": {
"description": "DynamoDB billing mode to use when auto provisioning is enabled.",
"enum": [
"PROVISIONED",
"PAY_PER_REQUEST"
],
"type": "string"
},
"provisionedThroughput": {
"description": "DynamoDB provisioned throughput read and write capacity units to use when auto provisioning is enabled.",
"properties": {
"readCapacityUnits": {
"minimum": 0,
"type": "integer"
},
"writeCapacityUnits": {
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"type": {
"enum": [
"dynamodb"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"namespaces": {
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9_-]*$": {
"additionalProperties": false,
"description": "Namespace configuration that contains one or more recommenders.",
"properties": {
"autoContext": {
"$ref": "#/$defs/autoContext",
"description": "Automatic context rules that apply to all Personalize recommenders for this namespace unless overridden at the recommender or variation level (overrides config at root)."
},
"cacheControl": {
"$ref": "#/$defs/cacheControl",
"description": "Cache control settings that apply to all recommenders for this namespace unless overridden at the recommender or variation level (overrides config at root)."
},
"description": {
"description": "Description for this namespace. Informative only.",
"type": "string"
},
"eventTargets": {
"description": "Destinations to send events to via the events API endpoint for a namespace",
"items": {
"anyOf": [
{
"additionalProperties": false,
"description": "Amazon Personalize event tracker",
"properties": {
"trackingId": {
"description": "Personalize event tracker tracking ID.",
"pattern": "[a-zA-Z0-9\\-]+",
"type": "string"
},
"type": {
"description": "",
"enum": [
"personalize-event-tracker"
],
"type": "string"
}
},
"required": [
"type",
"trackingId"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Amazon Kinesis data stream or firehose.",
"properties": {
"streamName": {
"description": "Kinesis stream or firehose name",
"pattern": "[a-zA-Z0-9_.-]+",
"type": "string"
},
"type": {
"description": "Identifies this variation as a Lambda function.",
"enum": [
"kinesis-stream",
"kinesis-firehose"
],
"type": "string"
}
},
"required": [
"type",
"streamName"
],
"type": "object"
}
]
},
"type": "array"
},
"inferenceItemMetadata": {
"$ref": "#/$defs/inferenceItemMetadata",
"description": ""
},
"name": {
"description": "Name for this namespace. Informative only.",
"type": "string"
},
"recommenders": {
"description": "Recommenders for the namespace keyed by the recommender action type. Action must be 'recommend-items', 'related-items', or 'rerank-items'.",
"items": {
"$ref": "#/$defs/recommenderAction"
}
}
},
"required": [
"recommenders"
],
"type": "object"
}
},
"type": "object"
},
"recommender": {
"additionalProperties": false,
"description": "Recommender path that uniquely identifies the recommender within a namespace and API action. The recommender path is used to map an API request to a recommender.",
"patternProperties": {
"^[a-zA-Z0-9_-]*$": {
"additionalProperties": false,
"properties": {
"cacheControl": {
"$ref": "#/$defs/cacheControl",
"description": "Cache control settings that apply to all variations for this recommender (overrides configs at root and namespace)."
},
"description": {
"description": "Description for this recommender. Informative only.",
"type": "string"
},
"experiments": {
"$ref": "#/$defs/experimentFeature",
"description": "Controls how the variation is selected for each request for the recommender keyed by a feature name."
},
"name": {
"description": "Name for this recommender. Informative only.",
"type": "string"
},
"responsePostProcessor": {
"$ref": "#/$defs/responsePostProcessor",
"description": "Post process the response before returning it to the client"
},
"variations": {
"$ref": "#/$defs/variations",
"description": "Variations for the recommender."
}
},
"required": [
"variations"
],
"type": "object"
}
},
"type": "object"
},
"recommenderAction": {
"additionalProperties": false,
"description": "Defines the recommender action and its configuration.",
"patternProperties": {
"^(?:recommend-items|related-items|rerank-items)$": {
"$ref": "#/$defs/recommender"
}
},
"type": "object"
},
"responsePostProcessor": {
"description": "Post process the response before returning it to the client",
"oneOf": [
{
"additionalProperties": false,
"description": "AWS Lambda response post-processor",
"properties": {
"arn": {
"description": "AWS Lambda function ARN",
"pattern": "^arn:[\\w-]+:lambda:[a-z]{2}-((?:gov|iso|isob)-)?[a-z]+-\\d{1}?:\\d{12}?:function/.*$",
"type": "string"
},
"lookAheadMaximumValue": {
"description": "Used with 'lookAheadMultiplier' to set a cap on how many items are requested from the origin recommender. The look ahead value will therefore be min(numResults * lookAheadMultiplier, lookAheadMaximumValue)",
"minimum": 1,
"type": "number"
},
"lookAheadMultiplier": {
"description": "Multiplier to apply to the 'numResults' query string parameter before making the inference call to the origin recommender. This is useful in situations where the post-processor logic may remove items from the intermediate inference response and therefore increases the liklihood of returning the caller's desired 'numResults' in the post-processed result.",
"minimum": 1,
"type": "number"
},
"type": {
"enum": [
"lambda"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"type": "object"
}
],
"type": "object"
},
"ruleValueMapping": {
"description": "Maps a rule's value to a final resolved value",
"properties": {
"additionalProperties": false,
"mapTo": {
"description": "Final resolved value to use if the rule's value applied to operator and value is true",
"type": [
"string",
"number"
]
},
"operator": {
"description": "Operator to apply to rule value",
"enum": [
"equals",
"less-than",
"greater-than",
"contains",
"starts-with",
"ends-with"
],
"type": "string"
},
"value": {
"description": "Value to compare rule value to using the operator",
"type": [
"string",
"number"
]
}
},
"required": [
"operator",
"value",
"mapTo"
],
"type": "object"
},
"variations": {
"additionalProperties": false,
"description": "Variations for a recommender that are keyed by a unique variation name. The variation name must match an Evidently feature name if an experiment is also defined for the recommender. Otherwise, the first variation is used.",
"patternProperties": {
"^[a-zA-Z0-9_-]*$": {
"anyOf": [
{
"additionalProperties": false,
"description": "Amazon Personalize campaign or recommender",
"properties": {
"arn": {
"description": "ARN of the Personalize campaign or recommender.",
"pattern": "^arn:[\\w-]+:personalize:[a-z]{2}-((?:gov|iso|isob)-)?[a-z]+-\\d{1}?:\\d{12}?:(?:campaign|recommender)/.*$",
"type": "string"
},
"filters": {
"description": "Filters to choose from when determining which one to apply to a request. The first filter that matches the condition of the request is used.",
"items": {
"additionalProperties": false,
"description": "Personalize filter to use with this recommender when retrieving recommendations.",
"properties": {
"arn": {
"description": "ARN of the Personalize Filter.",
"pattern": "^arn:[\\w-]+:personalize:[a-z]{2}-((?:gov|iso|isob)-)?[a-z]+-\\d{1}?:\\d{12}?:filter/.*$",
"type": "string"
},
"autoDynamicFilterValues": {
"$ref": "#/$defs/autoDynamicFilterValues",
"description": "Automatic dynamic filter value rules."
},
"condition": {
"description": "Indicates if a user is required to evaluate the expression for this filter. This is useful when a filter is specified for a related items recommender but should be conditionally applied depending on whether a user is specified in the request.",
"enum": [
"user-required"
],
"type": "string"
}
},
"required": [
"arn"
],
"type": "object"
},
"type": "array"
},
"type": {
"description": "",
"enum": [
"personalize-campaign",
"personalize-recommender"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "AWS Lambda function to invoke to retrieve recommendations for this recommender.",
"properties": {
"arn": {
"description": "AWS Lambda function ARN",
"pattern": "^arn:[\\w-]+:lambda:[a-z]{2}-((?:gov|iso|isob)-)?[a-z]+-\\d{1}?:\\d{12}?:function/.*$",
"type": "string"
},
"type": {
"description": "Identifies this variation as a Lambda function.",
"enum": [
"function"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Amazon SageMaker inference endpoint to invoke to retrieve recommendations for this recommender.",
"properties": {
"endpointName": {
"description": "Amazon SageMaker endpoint name",
"type": "string"
},
"type": {
"description": "Identifies this variation as a SageMaker inference endpoint.",
"enum": [
"sagemaker"
],
"type": "string"
}
},
"required": [
"type",
"endpointName"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "HTTP endpoint to call to retrieve recommendations",
"properties": {
"type": {
"description": "",
"enum": [
"http"
],
"type": "string"
},
"url": {
"description": "",
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
]
}
},
"type": "object"
}
},
"$id": "/schemas/personalization_apis_config_schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"description": "",
"properties": {
"autoContext": {
"$ref": "#/$defs/autoContext",
"description": "Automatic context rules that apply to all Personalize recommenders unless overridden at the namespace, recommender, or variation level."
},
"cacheControl": {
"$ref": "#/$defs/cacheControl",
"description": "Cache control settings that apply to all recommenders unless overridden at the namespace, recommender, or variation level."
},
"description": {
"description": "Description of this configuration. Informative only.",
"type": "string"
},
"namespaces": {
"$ref": "#/$defs/namespaces",
"description": "Namespaces keyed by the namespace path which is used to map API requests to a namespace. Analagous to an applications and/or Personalize dataset groups."
},
"version": {
"description": "Indicates the version of the configuration. Will be emitted as the value of the 'X-Personalization-Config-Version' response header.",
"type": "string"
}
},
"required": [
"namespaces"
],
"title": "Personalization APIs Configuration",
"type": "object"
} | MIT-0 | en |
trntv/apis-list | e467f79cd589460f26fe3c83a53a30c265d3d857 | 2021-02-20T19:47:07 | schema.json | 164 | 2024-05-28T00:38:10.191508Z | {
"$id": "https://raw.githubusercontent.com/apis-list/apis-list/main/schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": true,
"properties": {
"categories": {
"additionalItems": true,
"description": "List of API's categories",
"items": {
"anyOf": [
{
"description": "Category name",
"type": "string"
}
]
},
"type": "array"
},
"contact": {
"description": "Contact person",
"type": "string"
},
"description": {
"description": "Description",
"type": "string"
},
"discussion_url": {
"description": "Discussion URL of this API",
"type": "string"
},
"is_active": {
"description": "Is this API active",
"type": "boolean"
},
"is_free": {
"description": "Is this API has open source or have free plans",
"type": "boolean"
},
"libraries": {
"additionalItems": true,
"description": "SDK, Libs etc",
"items": {
"anyOf": [
{
"additionalProperties": true,
"properties": {
"author": {
"description": "Library's author",
"type": "string"
},
"description": {
"description": "Library's description",
"type": "string"
},
"documentation_url": {
"description": "Library's documentation URL",
"type": "string"
},
"name": {
"description": "Library's name",
"type": "string"
},
"platform": {
"description": "Library's programing language or platform",
"type": "string"
},
"source_code_url": {
"description": "Library's source code URL (VCS, Repository etc)",
"type": "string"
},
"stargazers_count": {
"description": "Stargazers count",
"type": "integer"
},
"version": {
"description": "Library's version",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"type": "array"
},
"links": {
"additionalItems": true,
"items": {
"anyOf": [
{
"additionalProperties": true,
"properties": {
"name": {
"description": "Link's name",
"type": "string"
},
"url": {
"description": "Link's URL",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"type": "array"
},
"logo": {
"description": "URL to API's logo",
"type": "string"
},
"name": {
"description": "Name",
"type": "string"
},
"slug": {
"type": "string"
},
"specification": {
"properties": {
"type": {
"description": "Specification's type (OpenAPI, Swagger, RAML etc)",
"type": "string"
},
"url": {
"description": "Specification's URL",
"type": "string"
},
"version": {
"description": "Specification's version",
"type": "string"
}
},
"type": "object"
},
"type": {
"description": "API type (REST, GraphQL etc)",
"type": "string"
}
},
"required": [
"name",
"categories"
],
"type": "object"
} | MIT | en |
trntv/apis-list | b726404cfe5c0e5c0b03236826bfffa2a6c1eb3e | 2021-01-10T18:41:41 | schema.json | 164 | 2024-05-28T00:38:10.191508Z | {
"$id": "https://raw.githubusercontent.com/apis-list/apis-list/main/schema.json",
"$schema": "http://json-schema.org/draft-07/schema",
"additionalProperties": true,
"properties": {
"categories": {
"$id": "#/properties/categories",
"additionalItems": true,
"items": {
"$id": "#/properties/categories/items",
"anyOf": [
{
"$id": "#/properties/categories/items/anyOf/0",
"type": "string"
}
]
},
"type": "array"
},
"contact": {
"$id": "#/properties/contact",
"type": "string"
},
"description": {
"$id": "#/properties/description",
"type": "string"
},
"discussion_uri": {
"$id": "#/properties/discussion_uri",
"type": "string"
},
"is_active": {
"$id": "#/properties/is_active",
"type": "boolean"
},
"is_opensource": {
"$id": "#/properties/is_opensource",
"type": "boolean"
},
"is_paid": {
"$id": "#/properties/is_paid",
"type": "boolean"
},
"libraries": {
"$id": "#/properties/libraries",
"additionalItems": true,
"items": {
"$id": "#/properties/libraries/items",
"anyOf": [
{
"$id": "#/properties/libraries/items/anyOf/0",
"additionalProperties": true,
"properties": {
"description": {
"$id": "#/properties/libraries/items/anyOf/0/properties/description",
"type": "string"
},
"homepage_uri": {
"$id": "#/properties/libraries/items/anyOf/0/properties/homepage_uri",
"type": "string"
},
"name": {
"$id": "#/properties/libraries/items/anyOf/0/properties/name",
"type": "string"
},
"platform": {
"$id": "#/properties/libraries/items/anyOf/0/properties/platform",
"type": "string"
},
"source_code_uri": {
"$id": "#/properties/libraries/items/anyOf/0/properties/source_code_uri",
"type": "string"
},
"version": {
"$id": "#/properties/libraries/items/anyOf/0/properties/version",
"type": "string"
}
},
"required": [
"name",
"homepage_uri"
],
"type": "object"
}
]
},
"type": "array"
},
"logo": {
"$id": "#/properties/logo",
"type": "string"
},
"name": {
"$id": "#/properties/name",
"type": "string"
},
"slug": {
"$id": "#/properties/slug",
"type": "string"
},
"type": {
"$id": "#/properties/type",
"type": "string"
},
"uri": {
"$id": "#/properties/uri",
"type": "string"
}
},
"required": [
"name",
"slug",
"categories",
"uri",
"is_active"
],
"type": "object"
} | MIT | en |
trntv/apis-list | d644f8ba463aac022a92b5b14746b2ed1d3b313b | 2021-01-18T19:08:55 | schema.json | 164 | 2024-05-28T00:38:10.191508Z | {
"$id": "https://raw.githubusercontent.com/apis-list/apis-list/main/schema.json",
"$schema": "http://json-schema.org/draft-07/schema",
"additionalProperties": true,
"properties": {
"categories": {
"additionalItems": true,
"items": {
"anyOf": [
{
"type": "string"
}
]
},
"type": "array"
},
"contact": {
"type": "string"
},
"description": {
"type": "string"
},
"discussion_url": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"is_free": {
"type": "boolean"
},
"libraries": {
"additionalItems": true,
"items": {
"anyOf": [
{
"additionalProperties": true,
"properties": {
"description": {
"type": "string"
},
"documentation_url": {
"type": "string"
},
"name": {
"type": "string"
},
"platform": {
"type": "string"
},
"source_code_url": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"type": "array"
},
"links": {
"additionalItems": true,
"items": {
"anyOf": [
{
"additionalProperties": true,
"properties": {
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"type": "array"
},
"logo": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"specification": {
"properties": {
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"type": {
"type": "string"
}
},
"required": [
"name",
"slug",
"categories",
"is_active"
],
"type": "object"
} | MIT | en |
trntv/apis-list | 6283f1dfe371c947ab250fdd8735bb079404f046 | 2021-02-20T17:40:27 | schema.json | 164 | 2024-05-28T00:38:10.191508Z | {
"$id": "https://raw.githubusercontent.com/apis-list/apis-list/main/schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": true,
"properties": {
"categories": {
"additionalItems": true,
"description": "List of API's categories",
"items": {
"anyOf": [
{
"description": "Category name",
"type": "string"
}
]
},
"type": "array"
},
"contact": {
"description": "Contact person",
"type": "string"
},
"description": {
"description": "Description",
"type": "string"
},
"discussion_url": {
"description": "Discussion URL of this API",
"type": "string"
},
"is_active": {
"description": "Is this API active",
"type": "boolean"
},
"is_free": {
"description": "Is this API has open source or have free plans",
"type": "boolean"
},
"libraries": {
"additionalItems": true,
"description": "SDK, Libs etc",
"items": {
"anyOf": [
{
"additionalProperties": true,
"properties": {
"author": {
"description": "Library's author",
"type": "string"
},
"description": {
"description": "Library's description",
"type": "string"
},
"documentation_url": {
"description": "Library's documentation URL",
"type": "string"
},
"name": {
"description": "Library's name",
"type": "string"
},
"platform": {
"description": "Library's programing language or platform",
"type": "string"
},
"source_code_url": {
"description": "Library's source code URL (VCS, Repository etc)",
"type": "string"
},
"stargazers_count": {
"description": "Stargazers count",
"type": "integer"
},
"version": {
"description": "Library's version",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"type": "array"
},
"links": {
"additionalItems": true,
"items": {
"anyOf": [
{
"additionalProperties": true,
"properties": {
"name": {
"description": "Link's name",
"type": "string"
},
"url": {
"description": "Link's URL",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"type": "array"
},
"logo": {
"description": "URL to API's logo",
"type": "string"
},
"name": {
"description": "Name",
"type": "string"
},
"slug": {
"type": "string"
},
"specification": {
"properties": {
"type": {
"description": "Specification's type (OpenAPI, Swagger, RAML etc)",
"type": "string"
},
"url": {
"description": "Specification's URL",
"type": "string"
},
"version": {
"description": "Specification's version",
"type": "string"
}
},
"type": "object"
},
"type": {
"description": "API type (REST, GraphQL etc)",
"type": "string"
}
},
"required": [
"name",
"slug",
"categories",
"is_active"
],
"type": "object"
} | MIT | en |
trntv/apis-list | 0230b52d790cd23bb8277d60de7fd8190a64c136 | 2021-02-14T16:09:01 | schema.json | 164 | 2024-05-28T00:38:10.191508Z | {
"$id": "https://raw.githubusercontent.com/apis-list/apis-list/main/schema.json",
"$schema": "http://json-schema.org/draft-07/schema",
"additionalProperties": true,
"properties": {
"categories": {
"additionalItems": true,
"items": {
"anyOf": [
{
"type": "string"
}
]
},
"type": "array"
},
"contact": {
"type": "string"
},
"description": {
"type": "string"
},
"discussion_url": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"is_free": {
"type": "boolean"
},
"libraries": {
"additionalItems": true,
"items": {
"anyOf": [
{
"additionalProperties": true,
"properties": {
"author": {
"type": "string"
},
"description": {
"type": "string"
},
"documentation_url": {
"type": "string"
},
"name": {
"type": "string"
},
"platform": {
"type": "string"
},
"source_code_url": {
"type": "string"
},
"stargazers_count": {
"type": "integer"
},
"version": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"type": "array"
},
"links": {
"additionalItems": true,
"items": {
"anyOf": [
{
"additionalProperties": true,
"properties": {
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"type": "array"
},
"logo": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"specification": {
"properties": {
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"type": {
"type": "string"
}
},
"required": [
"name",
"slug",
"categories",
"is_active"
],
"type": "object"
} | MIT | en |
bnomei/kirby3-schema | 00e32cb3e05408937cb099fa5c7b1eea3cc17c3b | 2022-06-25T20:20:07 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/section"
}
]
}
},
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"field-properties": {
"default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"extends": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional help text below the field"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"multiple": {
"default": true,
"description": "If false, only a single one can be selected",
"type": "boolean"
}
},
"fields": {
"files": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"label": {
"$ref": "#/$defs/field-properties/label"
},
"multiple": {
"$ref": "#/$defs/field-properties/multiple"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"default": {
"$ref": "#/$defs/field-properties/default"
},
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"help": {
"$ref": "#/$defs/field-properties/help"
},
"label": {
"$ref": "#/$defs/field-properties/label"
},
"type": {
"enum": [
"text"
]
}
},
"required": [
"type"
]
}
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type"
],
"type": "object"
},
"files": {
"properties": {
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"translated": {
"properties": {
"de": {
"$ref": "#/$defs/nonEmptyString"
},
"en": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"wrappers": {
"columns": {
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand of extends property"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/files"
}
]
}
},
"properties": {
"legal": {
"type": "boolean"
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "http://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/nonEmptyString"
},
"image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"type": "object"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | 0438e5cd84e9744c8a3f28e098a573d81d3101d1 | 2023-11-28T11:50:03 | kirby4-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@create": {
"properties": {
"fields": {
"$ref": "#/$defs/stringArrayUnique"
},
"redirect": {
"default": true,
"type": "boolean"
},
"status": {
"default": "draft",
"enum": [
"draft",
"unlisted",
"listed"
]
},
"title": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"blueprint": {
"enum": [
"file"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"page"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"create": {
"$ref": "#/$defs/blueprint-properties/@create"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"site"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"user"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"required": [
"blueprint"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@buttons": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"enum": [
"headlines",
"italic",
"bold",
"link",
"email",
"file",
"code",
"ul",
"ol",
"|"
]
},
"type": "array"
}
]
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/booleanOrStringArrayUnique"
}
]
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@files": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/stringOrTranslated",
"description": "Optional help text below the field"
},
"@icon": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"enum": [
"account",
"add",
"alert",
"anchor",
"angle-down",
"angle-left",
"angle-right",
"angle-up",
"archive",
"attachment",
"audio",
"badge",
"bars",
"bell",
"blank",
"bold",
"bolt",
"book",
"bookmark",
"box",
"bug",
"brush",
"calendar",
"cancel",
"cancel-small",
"car",
"cart",
"chart",
"chat",
"check",
"checklist",
"circle",
"circle-filled",
"circle-filled",
"circle-half",
"circle-nested",
"circle-outline",
"clear",
"clock",
"code",
"cog",
"collapse",
"copy",
"credit-card",
"crop",
"dashboard",
"discord",
"discount",
"display",
"divider",
"document",
"dots",
"download",
"draft",
"edit",
"editv",
"email",
"expand",
"facebook",
"file",
"file-audio",
"file-code",
"file-document",
"file-image",
"file-spreadsheet",
"file-text",
"file-video",
"file-word",
"file-zip",
"filter",
"flag",
"folder",
"folder-structure",
"food",
"funnel",
"github",
"globe",
"grid",
"grid-bottom",
"grid-bottom-left",
"grid-bottom-right",
"grid-full",
"grid-left",
"grid-right",
"grid-top",
"grid-top-left",
"grid-top-right",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6",
"headline",
"heart",
"heart-filled",
"heart-outline",
"hidden",
"home",
"image",
"images",
"import",
"info",
"instagram",
"italic",
"key",
"layers",
"linkedin",
"list-bullet",
"list-numbers",
"live",
"loader",
"lock",
"logout",
"map",
"markdown",
"mastodon",
"megaphone",
"menu",
"merge",
"mobile",
"money",
"moon",
"open",
"order-alpha-asc",
"order-alpha-desc",
"order-num-asc",
"order-num-desc",
"page",
"palette",
"paragraph",
"parent",
"paypal",
"pen",
"phone",
"pin",
"pinterest",
"pipette",
"plane",
"play",
"plus",
"preview",
"print",
"protected",
"qr-code",
"question",
"quote",
"refresh",
"remove",
"search",
"server",
"settings",
"share",
"shuffle",
"sitemap",
"smile",
"sort",
"sparkling",
"split",
"star",
"star-filled",
"star-outline",
"status-draft",
"status-unlisted",
"status-listed",
"store",
"strikethrough",
"sun",
"subscript",
"superscript",
"table",
"tablet",
"tag",
"template",
"text",
"text-center",
"text-justify",
"text-left",
"text-right",
"ticket",
"tiktok",
"title",
"toggle-off",
"toggle-on",
"trash",
"underline",
"undo",
"unlock",
"upload",
"url",
"user",
"users",
"video",
"vimeo",
"wand",
"whatsapp",
"wheelchair",
"youtube"
]
}
]
},
"@image": {
"description": "Image options to control the source and look of file previews",
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"color": {
"$ref": "#/$defs/nonEmptyString"
},
"cover": {
"type": "boolean"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"query": {
"$ref": "#/$defs/nonEmptyString"
},
"ratio": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/stringOrTranslated",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
},
"type": "array"
}
]
},
"@max": {
"type": "number"
},
"@maxlength": {
"type": "number"
},
"@min": {
"type": "number"
},
"@minlength": {
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@nodes": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/nodes"
},
"type": "array"
}
]
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
},
{
"items": {
"$ref": "#/$defs/objectWithStringValues"
},
"type": "array"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@separator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"object": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"object"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"subpages": {
"default": true,
"type": "boolean"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"pages"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"radio"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"tooltip": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"range"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"select"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"allow": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"path": {
"$ref": "#/$defs/nonEmptyString"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sync": {
"$ref": "#/$defs/nonEmptyString"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"slug"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
},
"wizard": {
"additionalProperties": false,
"properties": {
"field": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"duplicate": {
"default": true,
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"prepend": {
"default": true,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"structure"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"accept": {
"$ref": "#/$defs/nonEmptyString",
"default": "all"
},
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tags"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tel"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"buttons": {
"$ref": "#/$defs/field-properties/@buttons"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"files": {
"$ref": "#/$defs/field-properties/@files"
},
"font": {
"default": "sans",
"enum": [
"sans",
"monospace"
]
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"textarea"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads"
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"notation": {
"default": 24,
"enum": [
12,
24
]
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"time"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"text": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"items": {
"$ref": "#/$defs/translated"
},
"type": "array"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggle"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"grow": {
"default": true,
"type": "boolean"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"labels": {
"default": true,
"type": "boolean"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"reset": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggles"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon",
"default": "url"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"url"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": true
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"users"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"inline": {
"default": false,
"type": "boolean"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"nodes": {
"$ref": "#/$defs/field-properties/@nodes"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"writer"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
},
"type": "array"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link",
"email"
]
},
"nodes": {
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"queryObject": {
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"textValuePair": {
"additionalProperties": false,
"properties": {
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"oneOf": [
{
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
{
"items": {
"$ref": "#/$defs/column"
},
"type": "array"
}
]
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | 7d5cb8237a779e41408c89e5b1ff8d8e88e4ec4b | 2022-06-25T20:37:38 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/section"
}
]
}
},
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"field-properties": {
"default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"extends": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional help text below the field"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"limit": {
"exclusiveMinimum": 0,
"type": "number"
},
"multiple": {
"default": true,
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
}
},
"fields": {
"files": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"label": {
"$ref": "#/$defs/field-properties/label"
},
"multiple": {
"$ref": "#/$defs/field-properties/multiple"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"default": {
"$ref": "#/$defs/field-properties/default"
},
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"help": {
"$ref": "#/$defs/field-properties/help"
},
"label": {
"$ref": "#/$defs/field-properties/label"
},
"type": {
"enum": [
"text"
]
}
},
"required": [
"type"
]
}
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type"
],
"type": "object"
},
"files": {
"properties": {
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"properties": {
"headline": {
"$ref": "#/$defs/nonEmptyString",
"description": "[deprecated] use label instead"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"theme": {
"$ref": "#/$defs/field-properties/theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"properties": {
"create": {
"$ref": "#/$defs/field-properties/create"
},
"empty": {
"$ref": "#/$defs/field-properties/empty"
},
"flip": {
"$ref": "#/$defs/field-properties/flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/headline"
},
"help": {
"$ref": "#/$defs/field-properties/help"
},
"image": {
"$ref": "#/$defs/field-properties/image"
},
"info": {
"$ref": "#/$defs/field-properties/info"
},
"label": {
"$ref": "#/$defs/field-properties/label"
},
"layout": {
"$ref": "#/$defs/field-properties/layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/max"
},
"min": {
"$ref": "#/$defs/field-properties/min"
},
"page": {
"$ref": "#/$defs/field-properties/page"
},
"parent": {
"$ref": "#/$defs/field-properties/parent"
},
"size": {
"$ref": "#/$defs/field-properties/size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/status"
},
"templates": {
"$ref": "#/$defs/field-properties/templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"translated": {
"properties": {
"de": {
"$ref": "#/$defs/nonEmptyString"
},
"en": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"wrappers": {
"columns": {
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand of extends property"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/files"
}
]
}
},
"properties": {
"legal": {
"type": "boolean"
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "http://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/nonEmptyString"
},
"image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"type": "object"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | b25ae8d8628c1daca1e1e66c4d0210a71f6b55a7 | 2022-06-25T12:41:03 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$id": "https://getkirby.com/blueprints/page.schema.json",
"$schema": "http://json-schema.org/draft-04/schema#",
"allOf": [
{
"properties": {
"icon": {
"$ref": "#/definitions/nonEmptyString",
"description": "Icon to appear in page lists when no preview image is available"
},
"image": {
"properties": {
"back": {
"$ref": "#/definitions/nonEmptyString"
},
"icon": {
"$ref": "#/definitions/nonEmptyString"
}
},
"type": "object"
},
"num": {
"$ref": "#/definitions/nonEmptyString",
"default": "zero",
"description": "sorting behaviour"
},
"options": {
"properties": {
"changeSlug": {
"type": "boolean"
},
"changeStatus": {
"type": "boolean"
},
"changeTemplate": {
"$ref": "#/definitions/booleanOrStringArrayUnique"
},
"changeTitle": {
"type": "boolean"
},
"delete": {
"type": "boolean"
},
"duplicate": {
"type": "boolean"
},
"preview": {
"$ref": "#/definitions/booleanOrString"
},
"read": {
"type": "boolean"
},
"update": {
"type": "boolean"
}
},
"type": "object"
},
"status": {
"description": "define the allowed page statuses",
"properties": {
"draft": {
"$ref": "#/definitions/stringOrLabelAndText"
},
"listed": {
"$ref": "#/definitions/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/definitions/stringOrLabelAndText"
}
},
"type": "object"
},
"title": {
"description": "title of blueprint",
"oneOf": [
{
"$ref": "#/definitions/nonEmptyString"
},
{
"$ref": "#/definitions/translated"
}
]
}
},
"type": "object"
}
],
"definitions": {
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/stringArrayUnique"
}
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/definitions/nonEmptyString"
},
{
"type": "null"
}
]
},
"stringArrayUnique": {
"items": {
"$ref": "#/definitions/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/definitions/nonEmptyString"
},
{
"properties": {
"label": {
"$ref": "#/definitions/nonEmptyString"
},
"text": {
"$ref": "#/definitions/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/definitions/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/definitions/nonEmptyString"
},
{
"$ref": "#/definitions/stringArrayUnique"
}
]
},
"translated": {
"properties": {
"de": {
"$ref": "#/definitions/nonEmptyString"
},
"en": {
"$ref": "#/definitions/nonEmptyString"
}
},
"type": "object"
}
},
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | a022e265a74668aec1f22e76f0ee6cb8b321702c | 2023-12-13T11:07:04 | kirby4-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@create": {
"properties": {
"fields": {
"$ref": "#/$defs/stringArrayUnique"
},
"redirect": {
"default": true,
"type": "boolean"
},
"status": {
"default": "draft",
"enum": [
"draft",
"unlisted",
"listed"
]
},
"title": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"blueprint": {
"enum": [
"file"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"create": {
"properties": {
"crop": {
"default": false,
"type": "boolean"
},
"height": {
"$ref": "#/$defs/numberInPixel"
},
"width": {
"$ref": "#/$defs/numberInPixel"
}
},
"type": "object"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"focus": {
"default": true,
"type": "boolean"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"page"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"create": {
"$ref": "#/$defs/blueprint-properties/@create"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"site"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"user"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"required": [
"blueprint"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@buttons": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"enum": [
"headlines",
"italic",
"bold",
"link",
"email",
"file",
"code",
"ul",
"ol",
"|"
]
},
"type": "array"
}
]
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/booleanOrStringArrayUnique"
}
]
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@files": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/stringOrTranslated",
"description": "Optional help text below the field"
},
"@icon": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"enum": [
"account",
"add",
"alert",
"anchor",
"angle-down",
"angle-left",
"angle-right",
"angle-up",
"archive",
"attachment",
"audio",
"badge",
"bars",
"bell",
"blank",
"bold",
"bolt",
"book",
"bookmark",
"box",
"bug",
"brush",
"calendar",
"cancel",
"cancel-small",
"car",
"cart",
"chart",
"chat",
"check",
"checklist",
"circle",
"circle-filled",
"circle-filled",
"circle-half",
"circle-nested",
"circle-outline",
"clear",
"clock",
"code",
"cog",
"collapse",
"copy",
"credit-card",
"crop",
"dashboard",
"discord",
"discount",
"display",
"divider",
"document",
"dots",
"download",
"draft",
"edit",
"editv",
"email",
"expand",
"facebook",
"file",
"file-audio",
"file-code",
"file-document",
"file-image",
"file-spreadsheet",
"file-text",
"file-video",
"file-word",
"file-zip",
"filter",
"flag",
"folder",
"folder-structure",
"food",
"funnel",
"github",
"globe",
"grid",
"grid-bottom",
"grid-bottom-left",
"grid-bottom-right",
"grid-full",
"grid-left",
"grid-right",
"grid-top",
"grid-top-left",
"grid-top-right",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6",
"headline",
"heart",
"heart-filled",
"heart-outline",
"hidden",
"home",
"image",
"images",
"import",
"info",
"instagram",
"italic",
"key",
"layers",
"linkedin",
"list-bullet",
"list-numbers",
"live",
"loader",
"lock",
"logout",
"map",
"markdown",
"mastodon",
"megaphone",
"menu",
"merge",
"mobile",
"money",
"moon",
"open",
"order-alpha-asc",
"order-alpha-desc",
"order-num-asc",
"order-num-desc",
"page",
"palette",
"paragraph",
"parent",
"paypal",
"pen",
"phone",
"pin",
"pinterest",
"pipette",
"plane",
"play",
"plus",
"preview",
"print",
"protected",
"qr-code",
"question",
"quote",
"refresh",
"remove",
"search",
"server",
"settings",
"share",
"shuffle",
"sitemap",
"smile",
"sort",
"sparkling",
"split",
"star",
"star-filled",
"star-outline",
"status-draft",
"status-unlisted",
"status-listed",
"store",
"strikethrough",
"sun",
"subscript",
"superscript",
"table",
"tablet",
"tag",
"template",
"text",
"text-center",
"text-justify",
"text-left",
"text-right",
"ticket",
"tiktok",
"title",
"toggle-off",
"toggle-on",
"trash",
"underline",
"undo",
"unlock",
"upload",
"url",
"user",
"users",
"video",
"vimeo",
"wand",
"whatsapp",
"wheelchair",
"youtube"
]
}
]
},
"@image": {
"description": "Image options to control the source and look of file previews",
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"color": {
"$ref": "#/$defs/nonEmptyString"
},
"cover": {
"type": "boolean"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"query": {
"$ref": "#/$defs/nonEmptyString"
},
"ratio": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/stringOrTranslated",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
},
"type": "array"
}
]
},
"@max": {
"type": "number"
},
"@maxlength": {
"type": "number"
},
"@min": {
"type": "number"
},
"@minlength": {
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@nodes": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/nodes"
},
"type": "array"
}
]
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
},
{
"items": {
"$ref": "#/$defs/objectWithStringValues"
},
"type": "array"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@separator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"object": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"object"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"subpages": {
"default": true,
"type": "boolean"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"pages"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"radio"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"tooltip": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"range"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"select"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"allow": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"path": {
"$ref": "#/$defs/nonEmptyString"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sync": {
"$ref": "#/$defs/nonEmptyString"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"slug"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
},
"wizard": {
"additionalProperties": false,
"properties": {
"field": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"duplicate": {
"default": true,
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"prepend": {
"default": true,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"structure"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"accept": {
"$ref": "#/$defs/nonEmptyString",
"default": "all"
},
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tags"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tel"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"buttons": {
"$ref": "#/$defs/field-properties/@buttons"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"files": {
"$ref": "#/$defs/field-properties/@files"
},
"font": {
"default": "sans",
"enum": [
"sans",
"monospace"
]
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"textarea"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads"
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"notation": {
"default": 24,
"enum": [
12,
24
]
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"time"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"text": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"items": {
"$ref": "#/$defs/translated"
},
"type": "array"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggle"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"grow": {
"default": true,
"type": "boolean"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"labels": {
"default": true,
"type": "boolean"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"reset": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggles"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon",
"default": "url"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"url"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": true
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"users"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"inline": {
"default": false,
"type": "boolean"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"nodes": {
"$ref": "#/$defs/field-properties/@nodes"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"writer"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
},
"type": "array"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link",
"email",
"sub",
"sup",
"clear"
]
},
"nodes": {
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"queryObject": {
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"query": {
"$ref": "#/$defs/nonEmptyString"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"templatesIgnore": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"textValuePair": {
"additionalProperties": false,
"properties": {
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"oneOf": [
{
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
{
"items": {
"$ref": "#/$defs/column"
},
"type": "array"
}
]
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 4 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | aa8105bb16a3e3ef0f60b5557072e255d9505b58 | 2022-06-25T13:14:22 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$id": "https://getkirby.com/blueprints/page.schema.json",
"$schema": "http://json-schema.org/draft-04/schema#",
"allOf": [
{
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/definitions/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/definitions/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/definitions/numberInPixel"
},
"maxsize": {
"$ref": "#/definitions/numberInBytes"
},
"maxwidth": {
"$ref": "#/definitions/numberInPixel"
},
"mime ": {
"$ref": "#/definitions/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/definitions/numberInPixel"
},
"minsize": {
"$ref": "#/definitions/numberInBytes"
},
"minwidth": {
"$ref": "#/definitions/numberInPixel"
},
"orientation": {
"$ref": "#/definitions/nonEmptyString"
},
"type": {
"$ref": "#/definitions/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"description": {
"$ref": "#/definitions/stringOrTranslated"
},
"icon": {
"$ref": "#/definitions/nonEmptyString"
},
"image": {
"properties": {
"back": {
"$ref": "#/definitions/nonEmptyString"
},
"icon": {
"$ref": "#/definitions/nonEmptyString"
}
},
"type": "object"
},
"navigation": {
"properties": {
"sortBy": {
"$ref": "#/definitions/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/definitions/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/definitions/stringOrStringArrayUnique"
}
},
"type": "object"
},
"num": {
"$ref": "#/definitions/nonEmptyString",
"default": "zero"
},
"options": {
"properties": {
"changeName": {
"$ref": "#/definitions/booleanOrObject"
},
"changeSlug": {
"$ref": "#/definitions/booleanOrObject"
},
"changeStatus": {
"$ref": "#/definitions/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/definitions/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/definitions/booleanOrObject"
},
"delete": {
"$ref": "#/definitions/booleanOrObject"
},
"duplicate": {
"$ref": "#/definitions/booleanOrObject"
},
"preview": {
"$ref": "#/definitions/booleanOrString"
},
"read": {
"$ref": "#/definitions/booleanOrObject"
},
"replace": {
"$ref": "#/definitions/booleanOrObject"
},
"update": {
"$ref": "#/definitions/booleanOrObject"
}
},
"type": "object"
},
"status": {
"properties": {
"draft": {
"$ref": "#/definitions/stringOrLabelAndText"
},
"listed": {
"$ref": "#/definitions/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/definitions/stringOrLabelAndText"
}
},
"type": "object"
},
"title": {
"$ref": "#/definitions/stringOrTranslated"
}
},
"type": "object"
}
],
"definitions": {
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/stringArrayUnique"
}
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/definitions/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": true,
"minimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": true,
"minimum": 0,
"type": "number"
},
"stringArrayUnique": {
"items": {
"$ref": "#/definitions/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/definitions/nonEmptyString"
},
{
"properties": {
"label": {
"$ref": "#/definitions/nonEmptyString"
},
"text": {
"$ref": "#/definitions/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/definitions/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/definitions/nonEmptyString"
},
{
"$ref": "#/definitions/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/definitions/nonEmptyString"
},
{
"$ref": "#/definitions/translated"
}
]
},
"translated": {
"properties": {
"de": {
"$ref": "#/definitions/nonEmptyString"
},
"en": {
"$ref": "#/definitions/nonEmptyString"
}
},
"type": "object"
}
},
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | 9f45b83d11cd3ed1c72c8bb1365c5fffe651dcba | 2022-07-03T17:40:30 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/columns"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
},
"type": {
"enum": [
"file"
]
}
},
"required": [
"type"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
},
"type": {
"enum": [
"page"
]
}
},
"required": [
"type"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/columns"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
},
"type": {
"enum": [
"site"
]
}
},
"required": [
"type"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/columns"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
},
"type": {
"enum": [
"user"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional help text below the field"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"$ref": "#/$defs/nonEmptyString",
"description": "Image options to control the source and look of file previews"
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/nonEmptyString",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@max": {
"exclusiveMinimum": 0,
"type": "number"
},
"@maxlength": {
"exclusiveMinimum": 0,
"type": "number"
},
"@min": {
"exclusiveMinimum": 0,
"type": "number"
},
"@minlength": {
"exclusiveMinimum": 0,
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@options": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"$ref": "#/$defs/nonEmptyString"
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"blocks"
]
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"checkboxes"
]
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"date"
]
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"email"
]
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"headline"
]
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"list"
]
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"multiselect"
]
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"number"
]
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"radio"
]
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"range"
]
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"select"
]
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"slug"
]
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"structure"
]
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"tags"
]
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"tel"
]
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@icon"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"textarea"
]
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"time"
]
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"toggle"
]
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"url"
]
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"users"
]
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"writer"
]
}
},
"required": [
"type"
]
}
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | 951013f67818bba57263725ebaf47d05944fddf6 | 2023-02-12T11:53:01 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"blueprint": {
"enum": [
"file"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"page"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"site"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"user"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"required": [
"blueprint"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@buttons": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"enum": [
"headlines",
"italic",
"bold",
"link",
"email",
"file",
"code",
"ul",
"ol",
"|"
]
},
"type": "array"
}
]
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/booleanOrStringArrayUnique"
}
]
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@files": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional help text below the field"
},
"@icon": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"enum": [
"account",
"add",
"alert",
"angle-down",
"angle-left",
"angle-right",
"angle-up",
"archive",
"attachment",
"audio",
"badge",
"bars",
"bell",
"blank",
"bold",
"bolt",
"book",
"bookmark",
"box",
"brush",
"bug",
"calendar",
"cancel",
"cancel-small",
"car",
"cart",
"chart",
"chat",
"check",
"circle",
"circle-filled",
"circle-half",
"circle-nested",
"circle-outline",
"clock",
"code",
"cog",
"collapse",
"copy",
"credit-card",
"crop",
"dashboard",
"discord",
"discount",
"display",
"divider",
"document",
"dots",
"download",
"draft",
"edit",
"email",
"expand",
"facebook",
"file",
"file-audio",
"file-code",
"file-document",
"file-image",
"file-spreadsheet",
"file-text",
"file-video",
"file-word",
"file-zip",
"filter",
"flag",
"folder",
"folder-structure",
"food",
"funnel",
"github",
"globe",
"grid",
"grid-bottom",
"grid-bottom-left",
"grid-bottom-right",
"grid-full",
"grid-left",
"grid-right",
"grid-top",
"grid-top-left",
"grid-top-right",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6",
"headline",
"heart",
"heart-outline",
"hidden",
"home",
"image",
"images",
"import",
"info",
"instagram",
"italic",
"key",
"layers",
"linkedin",
"list-bullet",
"list-numbers",
"live",
"loader",
"lock",
"logout",
"map",
"markdown",
"menu",
"mobile",
"money",
"moon",
"open",
"order-alpha-asc",
"order-alpha-desc",
"order-num-asc",
"order-num-desc",
"page",
"palette",
"paragraph",
"parent",
"paypal",
"pen",
"phone",
"pin",
"pinterest",
"pipette",
"play",
"preview",
"print",
"protected",
"qr-code",
"question",
"quote",
"refresh",
"remove",
"road-sign",
"search",
"server",
"settings",
"share",
"shuffle",
"sitemap",
"smile",
"sort",
"star",
"star-outline",
"store",
"strikethrough",
"sun",
"table",
"tablet",
"tag",
"template",
"text",
"text-center",
"text-justify",
"text-left",
"text-right",
"ticket",
"tiktok",
"title",
"toggle-off",
"toggle-on",
"trash",
"twitter",
"underline",
"undo",
"unlock",
"upload",
"url",
"user",
"users",
"video",
"vimeo",
"wand",
"whatsapp",
"wheelchair"
]
}
]
},
"@image": {
"description": "Image options to control the source and look of file previews",
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"color": {
"$ref": "#/$defs/nonEmptyString"
},
"cover": {
"type": "boolean"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"query": {
"$ref": "#/$defs/nonEmptyString"
},
"ratio": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/nonEmptyString",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
},
"type": "array"
}
]
},
"@max": {
"type": "number"
},
"@maxlength": {
"type": "number"
},
"@min": {
"type": "number"
},
"@minlength": {
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@nodes": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/nodes"
},
"type": "array"
}
]
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
},
{
"items": {
"$ref": "#/$defs/objectWithStringValues"
},
"type": "array"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@separator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"object": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"object"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"subpages": {
"default": true,
"type": "boolean"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"pages"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"radio"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"tooltip": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"range"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"select"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"allow": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"path": {
"$ref": "#/$defs/nonEmptyString"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sync": {
"$ref": "#/$defs/nonEmptyString"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"slug"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
},
"wizard": {
"additionalProperties": false,
"properties": {
"field": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"duplicate": {
"default": true,
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"prepend": {
"default": true,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"structure"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"accept": {
"$ref": "#/$defs/nonEmptyString",
"default": "all"
},
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tags"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tel"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"buttons": {
"$ref": "#/$defs/field-properties/@buttons"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"files": {
"$ref": "#/$defs/field-properties/@files"
},
"font": {
"default": "sans",
"enum": [
"sans",
"monospace"
]
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"textarea"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads"
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"notation": {
"default": 24,
"enum": [
12,
24
]
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"time"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"text": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"items": {
"$ref": "#/$defs/translated"
},
"type": "array"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggle"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"grow": {
"default": true,
"type": "boolean"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"labels": {
"default": true,
"type": "boolean"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"reset": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggles"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon",
"default": "url"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"url"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": true
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"users"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"inline": {
"default": false,
"type": "boolean"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"nodes": {
"$ref": "#/$defs/field-properties/@nodes"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"writer"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
},
"type": "array"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link"
]
},
"nodes": {
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"queryObject": {
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"textValuePair": {
"additionalProperties": false,
"properties": {
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"oneOf": [
{
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
{
"items": {
"$ref": "#/$defs/column"
},
"type": "array"
}
]
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | b71d964821ce78046134028e7c2cccfb22f4778f | 2023-11-28T14:19:13 | kirby4-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@create": {
"properties": {
"fields": {
"$ref": "#/$defs/stringArrayUnique"
},
"redirect": {
"default": true,
"type": "boolean"
},
"status": {
"default": "draft",
"enum": [
"draft",
"unlisted",
"listed"
]
},
"title": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"blueprint": {
"enum": [
"file"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"create": {
"properties": {
"crop": {
"default": false,
"type": "boolean"
},
"height": {
"$ref": "#/$defs/numberInPixel"
},
"width": {
"$ref": "#/$defs/numberInPixel"
}
},
"type": "object"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"focus": {
"default": true,
"type": "boolean"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"page"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"create": {
"$ref": "#/$defs/blueprint-properties/@create"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"site"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"user"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"required": [
"blueprint"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@buttons": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"enum": [
"headlines",
"italic",
"bold",
"link",
"email",
"file",
"code",
"ul",
"ol",
"|"
]
},
"type": "array"
}
]
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/booleanOrStringArrayUnique"
}
]
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@files": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/stringOrTranslated",
"description": "Optional help text below the field"
},
"@icon": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"enum": [
"account",
"add",
"alert",
"anchor",
"angle-down",
"angle-left",
"angle-right",
"angle-up",
"archive",
"attachment",
"audio",
"badge",
"bars",
"bell",
"blank",
"bold",
"bolt",
"book",
"bookmark",
"box",
"bug",
"brush",
"calendar",
"cancel",
"cancel-small",
"car",
"cart",
"chart",
"chat",
"check",
"checklist",
"circle",
"circle-filled",
"circle-filled",
"circle-half",
"circle-nested",
"circle-outline",
"clear",
"clock",
"code",
"cog",
"collapse",
"copy",
"credit-card",
"crop",
"dashboard",
"discord",
"discount",
"display",
"divider",
"document",
"dots",
"download",
"draft",
"edit",
"editv",
"email",
"expand",
"facebook",
"file",
"file-audio",
"file-code",
"file-document",
"file-image",
"file-spreadsheet",
"file-text",
"file-video",
"file-word",
"file-zip",
"filter",
"flag",
"folder",
"folder-structure",
"food",
"funnel",
"github",
"globe",
"grid",
"grid-bottom",
"grid-bottom-left",
"grid-bottom-right",
"grid-full",
"grid-left",
"grid-right",
"grid-top",
"grid-top-left",
"grid-top-right",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6",
"headline",
"heart",
"heart-filled",
"heart-outline",
"hidden",
"home",
"image",
"images",
"import",
"info",
"instagram",
"italic",
"key",
"layers",
"linkedin",
"list-bullet",
"list-numbers",
"live",
"loader",
"lock",
"logout",
"map",
"markdown",
"mastodon",
"megaphone",
"menu",
"merge",
"mobile",
"money",
"moon",
"open",
"order-alpha-asc",
"order-alpha-desc",
"order-num-asc",
"order-num-desc",
"page",
"palette",
"paragraph",
"parent",
"paypal",
"pen",
"phone",
"pin",
"pinterest",
"pipette",
"plane",
"play",
"plus",
"preview",
"print",
"protected",
"qr-code",
"question",
"quote",
"refresh",
"remove",
"search",
"server",
"settings",
"share",
"shuffle",
"sitemap",
"smile",
"sort",
"sparkling",
"split",
"star",
"star-filled",
"star-outline",
"status-draft",
"status-unlisted",
"status-listed",
"store",
"strikethrough",
"sun",
"subscript",
"superscript",
"table",
"tablet",
"tag",
"template",
"text",
"text-center",
"text-justify",
"text-left",
"text-right",
"ticket",
"tiktok",
"title",
"toggle-off",
"toggle-on",
"trash",
"underline",
"undo",
"unlock",
"upload",
"url",
"user",
"users",
"video",
"vimeo",
"wand",
"whatsapp",
"wheelchair",
"youtube"
]
}
]
},
"@image": {
"description": "Image options to control the source and look of file previews",
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"color": {
"$ref": "#/$defs/nonEmptyString"
},
"cover": {
"type": "boolean"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"query": {
"$ref": "#/$defs/nonEmptyString"
},
"ratio": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/stringOrTranslated",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
},
"type": "array"
}
]
},
"@max": {
"type": "number"
},
"@maxlength": {
"type": "number"
},
"@min": {
"type": "number"
},
"@minlength": {
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@nodes": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/nodes"
},
"type": "array"
}
]
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
},
{
"items": {
"$ref": "#/$defs/objectWithStringValues"
},
"type": "array"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@separator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"object": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"object"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"subpages": {
"default": true,
"type": "boolean"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"pages"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"radio"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"tooltip": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"range"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"select"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"allow": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"path": {
"$ref": "#/$defs/nonEmptyString"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sync": {
"$ref": "#/$defs/nonEmptyString"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"slug"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
},
"wizard": {
"additionalProperties": false,
"properties": {
"field": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"duplicate": {
"default": true,
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"prepend": {
"default": true,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"structure"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"accept": {
"$ref": "#/$defs/nonEmptyString",
"default": "all"
},
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tags"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tel"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"buttons": {
"$ref": "#/$defs/field-properties/@buttons"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"files": {
"$ref": "#/$defs/field-properties/@files"
},
"font": {
"default": "sans",
"enum": [
"sans",
"monospace"
]
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"textarea"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads"
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"notation": {
"default": 24,
"enum": [
12,
24
]
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"time"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"text": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"items": {
"$ref": "#/$defs/translated"
},
"type": "array"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggle"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"grow": {
"default": true,
"type": "boolean"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"labels": {
"default": true,
"type": "boolean"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"reset": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggles"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon",
"default": "url"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"url"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": true
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"users"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"inline": {
"default": false,
"type": "boolean"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"nodes": {
"$ref": "#/$defs/field-properties/@nodes"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"writer"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
},
"type": "array"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link",
"email",
"sub",
"sup",
"clear"
]
},
"nodes": {
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"queryObject": {
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"templatesIgnore": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"textValuePair": {
"additionalProperties": false,
"properties": {
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"oneOf": [
{
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
{
"items": {
"$ref": "#/$defs/column"
},
"type": "array"
}
]
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | b24326b359398f878a2322e6e3763bea3f13f803 | 2023-02-12T11:17:59 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"blueprint": {
"enum": [
"file"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"page"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"site"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"user"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"required": [
"blueprint"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@buttons": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"enum": [
"headlines",
"italic",
"bold",
"link",
"email",
"file",
"code",
"ul",
"ol",
"|"
]
},
"type": "array"
}
]
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/booleanOrStringArrayUnique"
}
]
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@files": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional help text below the field"
},
"@icon": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"enum": [
"account",
"add",
"alert",
"angle-down",
"angle-left",
"angle-right",
"angle-up",
"archive",
"attachment",
"audio",
"badge",
"bars",
"bell",
"blank",
"bold",
"bolt",
"book",
"bookmark",
"box",
"brush",
"bug",
"calendar",
"cancel",
"cancel-small",
"car",
"cart",
"chart",
"chat",
"check",
"circle",
"circle-filled",
"circle-half",
"circle-nested",
"circle-outline",
"clock",
"code",
"cog",
"collapse",
"copy",
"credit-card",
"crop",
"dashboard",
"discord",
"discount",
"display",
"divider",
"document",
"dots",
"download",
"draft",
"edit",
"email",
"expand",
"facebook",
"file",
"file-audio",
"file-code",
"file-document",
"file-image",
"file-spreadsheet",
"file-text",
"file-video",
"file-word",
"file-zip",
"filter",
"flag",
"folder",
"folder-structure",
"food",
"funnel",
"github",
"globe",
"grid",
"grid-bottom",
"grid-bottom-left",
"grid-bottom-right",
"grid-full",
"grid-left",
"grid-right",
"grid-top",
"grid-top-left",
"grid-top-right",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6",
"headline",
"heart",
"heart-outline",
"hidden",
"home",
"image",
"images",
"import",
"info",
"instagram",
"italic",
"key",
"layers",
"linkedin",
"list-bullet",
"list-numbers",
"live",
"loader",
"lock",
"logout",
"map",
"markdown",
"menu",
"mobile",
"money",
"moon",
"open",
"order-alpha-asc",
"order-alpha-desc",
"order-num-asc",
"order-num-desc",
"page",
"palette",
"paragraph",
"parent",
"paypal",
"pen",
"phone",
"pin",
"pinterest",
"pipette",
"play",
"preview",
"print",
"protected",
"qr-code",
"question",
"quote",
"refresh",
"remove",
"road-sign",
"search",
"server",
"settings",
"share",
"shuffle",
"sitemap",
"smile",
"sort",
"star",
"star-outline",
"store",
"strikethrough",
"sun",
"table",
"tablet",
"tag",
"template",
"text",
"text-center",
"text-justify",
"text-left",
"text-right",
"ticket",
"tiktok",
"title",
"toggle-off",
"toggle-on",
"trash",
"twitter",
"underline",
"undo",
"unlock",
"upload",
"url",
"user",
"users",
"video",
"vimeo",
"wand",
"whatsapp",
"wheelchair"
]
}
]
},
"@image": {
"description": "Image options to control the source and look of file previews",
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"cover": {
"type": "boolean"
},
"ratio": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/nonEmptyString",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
},
"type": "array"
}
]
},
"@max": {
"type": "number"
},
"@maxlength": {
"type": "number"
},
"@min": {
"type": "number"
},
"@minlength": {
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@nodes": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/nodes"
},
"type": "array"
}
]
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
},
{
"items": {
"$ref": "#/$defs/objectWithStringValues"
},
"type": "array"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@separator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"object": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"object"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"subpages": {
"default": true,
"type": "boolean"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"pages"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"radio"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"tooltip": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"range"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"select"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"allow": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"path": {
"$ref": "#/$defs/nonEmptyString"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sync": {
"$ref": "#/$defs/nonEmptyString"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"slug"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
},
"wizard": {
"additionalProperties": false,
"properties": {
"field": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"duplicate": {
"default": true,
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"prepend": {
"default": true,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"structure"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"accept": {
"$ref": "#/$defs/nonEmptyString",
"default": "all"
},
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tags"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tel"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"buttons": {
"$ref": "#/$defs/field-properties/@buttons"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"files": {
"$ref": "#/$defs/field-properties/@files"
},
"font": {
"default": "sans",
"enum": [
"sans",
"monospace"
]
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"textarea"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads"
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"notation": {
"default": 24,
"enum": [
12,
24
]
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"time"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"text": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"items": {
"$ref": "#/$defs/translated"
},
"type": "array"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggle"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"grow": {
"default": true,
"type": "boolean"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"labels": {
"default": true,
"type": "boolean"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"reset": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggles"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon",
"default": "url"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"url"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": true
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"users"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"inline": {
"default": false,
"type": "boolean"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"nodes": {
"$ref": "#/$defs/field-properties/@nodes"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"writer"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
},
"type": "array"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link"
]
},
"nodes": {
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"queryObject": {
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"textValuePair": {
"additionalProperties": false,
"properties": {
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"oneOf": [
{
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
{
"items": {
"$ref": "#/$defs/column"
},
"type": "array"
}
]
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | 657fab85e64554b77399594ea3a513093ddb5a8a | 2023-11-28T11:41:13 | kirby4-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"blueprint": {
"enum": [
"file"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"page"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"site"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"user"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"required": [
"blueprint"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@buttons": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"enum": [
"headlines",
"italic",
"bold",
"link",
"email",
"file",
"code",
"ul",
"ol",
"|"
]
},
"type": "array"
}
]
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/booleanOrStringArrayUnique"
}
]
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@files": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/stringOrTranslated",
"description": "Optional help text below the field"
},
"@icon": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"enum": [
"account",
"add",
"alert",
"anchor",
"angle-down",
"angle-left",
"angle-right",
"angle-up",
"archive",
"attachment",
"audio",
"badge",
"bars",
"bell",
"blank",
"bold",
"bolt",
"book",
"bookmark",
"box",
"bug",
"brush",
"calendar",
"cancel",
"cancel-small",
"car",
"cart",
"chart",
"chat",
"check",
"checklist",
"circle",
"circle-filled",
"circle-filled",
"circle-half",
"circle-nested",
"circle-outline",
"clear",
"clock",
"code",
"cog",
"collapse",
"copy",
"credit-card",
"crop",
"dashboard",
"discord",
"discount",
"display",
"divider",
"document",
"dots",
"download",
"draft",
"edit",
"editv",
"email",
"expand",
"facebook",
"file",
"file-audio",
"file-code",
"file-document",
"file-image",
"file-spreadsheet",
"file-text",
"file-video",
"file-word",
"file-zip",
"filter",
"flag",
"folder",
"folder-structure",
"food",
"funnel",
"github",
"globe",
"grid",
"grid-bottom",
"grid-bottom-left",
"grid-bottom-right",
"grid-full",
"grid-left",
"grid-right",
"grid-top",
"grid-top-left",
"grid-top-right",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6",
"headline",
"heart",
"heart-filled",
"heart-outline",
"hidden",
"home",
"image",
"images",
"import",
"info",
"instagram",
"italic",
"key",
"layers",
"linkedin",
"list-bullet",
"list-numbers",
"live",
"loader",
"lock",
"logout",
"map",
"markdown",
"mastodon",
"megaphone",
"menu",
"merge",
"mobile",
"money",
"moon",
"open",
"order-alpha-asc",
"order-alpha-desc",
"order-num-asc",
"order-num-desc",
"page",
"palette",
"paragraph",
"parent",
"paypal",
"pen",
"phone",
"pin",
"pinterest",
"pipette",
"plane",
"play",
"plus",
"preview",
"print",
"protected",
"qr-code",
"question",
"quote",
"refresh",
"remove",
"search",
"server",
"settings",
"share",
"shuffle",
"sitemap",
"smile",
"sort",
"sparkling",
"split",
"star",
"star-filled",
"star-outline",
"status-draft",
"status-unlisted",
"status-listed",
"store",
"strikethrough",
"sun",
"subscript",
"superscript",
"table",
"tablet",
"tag",
"template",
"text",
"text-center",
"text-justify",
"text-left",
"text-right",
"ticket",
"tiktok",
"title",
"toggle-off",
"toggle-on",
"trash",
"underline",
"undo",
"unlock",
"upload",
"url",
"user",
"users",
"video",
"vimeo",
"wand",
"whatsapp",
"wheelchair",
"youtube"
]
}
]
},
"@image": {
"description": "Image options to control the source and look of file previews",
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"color": {
"$ref": "#/$defs/nonEmptyString"
},
"cover": {
"type": "boolean"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"query": {
"$ref": "#/$defs/nonEmptyString"
},
"ratio": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/stringOrTranslated",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
},
"type": "array"
}
]
},
"@max": {
"type": "number"
},
"@maxlength": {
"type": "number"
},
"@min": {
"type": "number"
},
"@minlength": {
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@nodes": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/nodes"
},
"type": "array"
}
]
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
},
{
"items": {
"$ref": "#/$defs/objectWithStringValues"
},
"type": "array"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@separator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"object": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"object"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"subpages": {
"default": true,
"type": "boolean"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"pages"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"radio"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"tooltip": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"range"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"select"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"allow": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"path": {
"$ref": "#/$defs/nonEmptyString"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sync": {
"$ref": "#/$defs/nonEmptyString"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"slug"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
},
"wizard": {
"additionalProperties": false,
"properties": {
"field": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"duplicate": {
"default": true,
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"prepend": {
"default": true,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"structure"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"accept": {
"$ref": "#/$defs/nonEmptyString",
"default": "all"
},
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tags"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tel"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"buttons": {
"$ref": "#/$defs/field-properties/@buttons"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"files": {
"$ref": "#/$defs/field-properties/@files"
},
"font": {
"default": "sans",
"enum": [
"sans",
"monospace"
]
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"textarea"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads"
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"notation": {
"default": 24,
"enum": [
12,
24
]
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"time"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"text": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"items": {
"$ref": "#/$defs/translated"
},
"type": "array"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggle"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"grow": {
"default": true,
"type": "boolean"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"labels": {
"default": true,
"type": "boolean"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"reset": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggles"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon",
"default": "url"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"url"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": true
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"users"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"inline": {
"default": false,
"type": "boolean"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"nodes": {
"$ref": "#/$defs/field-properties/@nodes"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"writer"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
},
"type": "array"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link",
"email"
]
},
"nodes": {
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"queryObject": {
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"textValuePair": {
"additionalProperties": false,
"properties": {
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"oneOf": [
{
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
{
"items": {
"$ref": "#/$defs/column"
},
"type": "array"
}
]
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | 102e04431a0f6287e0d73d164a66d9e6f2f0cd7d | 2022-11-07T11:30:05 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"blueprint": {
"enum": [
"file"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"page"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"site"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"user"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"required": [
"blueprint"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@buttons": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"enum": [
"headlines",
"italic",
"bold",
"link",
"email",
"file",
"code",
"ul",
"ol",
"|"
]
},
"type": "array"
}
]
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/booleanOrStringArrayUnique"
}
]
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@files": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional help text below the field"
},
"@icon": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"enum": [
"account",
"add",
"alert",
"angle-down",
"angle-left",
"angle-right",
"angle-up",
"archive",
"attachment",
"audio",
"badge",
"bars",
"bell",
"blank",
"bold",
"bolt",
"book",
"bookmark",
"box",
"brush",
"bug",
"calendar",
"cancel",
"cancel-small",
"car",
"cart",
"chart",
"chat",
"check",
"circle",
"circle-filled",
"circle-half",
"circle-nested",
"circle-outline",
"clock",
"code",
"cog",
"collapse",
"copy",
"credit-card",
"crop",
"dashboard",
"discord",
"discount",
"display",
"divider",
"document",
"dots",
"download",
"draft",
"edit",
"email",
"expand",
"facebook",
"file",
"file-audio",
"file-code",
"file-document",
"file-image",
"file-spreadsheet",
"file-text",
"file-video",
"file-word",
"file-zip",
"filter",
"flag",
"folder",
"folder-structure",
"food",
"funnel",
"github",
"globe",
"grid",
"grid-bottom",
"grid-bottom-left",
"grid-bottom-right",
"grid-full",
"grid-left",
"grid-right",
"grid-top",
"grid-top-left",
"grid-top-right",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6",
"headline",
"heart",
"heart-outline",
"hidden",
"home",
"image",
"images",
"import",
"info",
"instagram",
"italic",
"key",
"layers",
"linkedin",
"list-bullet",
"list-numbers",
"live",
"loader",
"lock",
"logout",
"map",
"markdown",
"menu",
"mobile",
"money",
"moon",
"open",
"order-alpha-asc",
"order-alpha-desc",
"order-num-asc",
"order-num-desc",
"page",
"palette",
"paragraph",
"parent",
"paypal",
"pen",
"phone",
"pin",
"pinterest",
"pipette",
"play",
"preview",
"print",
"protected",
"qr-code",
"question",
"quote",
"refresh",
"remove",
"road-sign",
"search",
"server",
"settings",
"share",
"shuffle",
"sitemap",
"smile",
"sort",
"star",
"star-outline",
"store",
"strikethrough",
"sun",
"table",
"tablet",
"tag",
"template",
"text",
"text-center",
"text-justify",
"text-left",
"text-right",
"ticket",
"tiktok",
"title",
"toggle-off",
"toggle-on",
"trash",
"twitter",
"underline",
"undo",
"unlock",
"upload",
"url",
"user",
"users",
"video",
"vimeo",
"wand",
"whatsapp",
"wheelchair"
]
}
]
},
"@image": {
"description": "Image options to control the source and look of file previews",
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"cover": {
"type": "boolean"
},
"ratio": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/nonEmptyString",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
},
"type": "array"
}
]
},
"@max": {
"type": "number"
},
"@maxlength": {
"type": "number"
},
"@min": {
"type": "number"
},
"@minlength": {
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@nodes": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/nodes"
},
"type": "array"
}
]
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
},
{
"items": {
"$ref": "#/$defs/objectWithStringValues"
},
"type": "array"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@separator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"object": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"object"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"subpages": {
"default": true,
"type": "boolean"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"pages"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"radio"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"tooltip": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"range"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"select"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"allow": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"path": {
"$ref": "#/$defs/nonEmptyString"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sync": {
"$ref": "#/$defs/nonEmptyString"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"slug"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
},
"wizard": {
"additionalProperties": false,
"properties": {
"field": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"duplicate": {
"default": true,
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"prepend": {
"default": true,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"structure"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"accept": {
"$ref": "#/$defs/nonEmptyString",
"default": "all"
},
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tags"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tel"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"buttons": {
"$ref": "#/$defs/field-properties/@buttons"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"files": {
"$ref": "#/$defs/field-properties/@files"
},
"font": {
"default": "sans",
"enum": [
"sans",
"monospace"
]
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"textarea"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads"
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"notation": {
"default": 24,
"enum": [
12,
24
]
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"time"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"text": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"items": {
"$ref": "#/$defs/translated"
},
"type": "array"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggle"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"grow": {
"default": true,
"type": "boolean"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"labels": {
"default": true,
"type": "boolean"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"reset": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggles"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon",
"default": "url"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"url"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": true
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"users"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"inline": {
"default": false,
"type": "boolean"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"nodes": {
"$ref": "#/$defs/field-properties/@nodes"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"writer"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
},
"type": "array"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link"
]
},
"nodes": {
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"queryObject": {
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"textValuePair": {
"additionalProperties": false,
"properties": {
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"oneOf": [
{
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
{
"items": {
"$ref": "#/$defs/column"
},
"type": "array"
}
]
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | a74ae16a937bb4e8d0925642bd7aa403eb4ddd6f | 2022-07-04T18:19:18 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/columns"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
},
"type": {
"enum": [
"file"
]
}
},
"required": [
"type"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
},
"type": {
"enum": [
"page"
]
}
},
"required": [
"type"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/columns"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
},
"type": {
"enum": [
"site"
]
}
},
"required": [
"type"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/columns"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
},
"type": {
"enum": [
"user"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional help text below the field"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"$ref": "#/$defs/nonEmptyString",
"description": "Image options to control the source and look of file previews"
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/nonEmptyString",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@max": {
"exclusiveMinimum": 0,
"type": "number"
},
"@maxlength": {
"exclusiveMinimum": 0,
"type": "number"
},
"@min": {
"exclusiveMinimum": 0,
"type": "number"
},
"@minlength": {
"exclusiveMinimum": 0,
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"$ref": "#/$defs/stringArrayUnique"
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"$ref": "#/$defs/nonEmptyString"
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"email"
]
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"headline"
]
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"list"
]
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"multiselect"
]
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"number"
]
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"radio"
]
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"range"
]
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"select"
]
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"slug"
]
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"structure"
]
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"tags"
]
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"tel"
]
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@icon"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"textarea"
]
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"time"
]
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"toggle"
]
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"toggles"
]
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"url"
]
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"users"
]
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"writer"
]
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
}
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | cd9fdd9ba84353544c45e78ebaed4d43d408982a | 2023-03-08T08:35:06 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"blueprint": {
"enum": [
"file"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"page"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"site"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"user"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"required": [
"blueprint"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@buttons": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"enum": [
"headlines",
"italic",
"bold",
"link",
"email",
"file",
"code",
"ul",
"ol",
"|"
]
},
"type": "array"
}
]
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/booleanOrStringArrayUnique"
}
]
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@files": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional help text below the field"
},
"@icon": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"enum": [
"account",
"add",
"alert",
"angle-down",
"angle-left",
"angle-right",
"angle-up",
"archive",
"attachment",
"audio",
"badge",
"bars",
"bell",
"blank",
"bold",
"bolt",
"book",
"bookmark",
"box",
"brush",
"bug",
"calendar",
"cancel",
"cancel-small",
"car",
"cart",
"chart",
"chat",
"check",
"circle",
"circle-filled",
"circle-half",
"circle-nested",
"circle-outline",
"clock",
"code",
"cog",
"collapse",
"copy",
"credit-card",
"crop",
"dashboard",
"discord",
"discount",
"display",
"divider",
"document",
"dots",
"download",
"draft",
"edit",
"email",
"expand",
"facebook",
"file",
"file-audio",
"file-code",
"file-document",
"file-image",
"file-spreadsheet",
"file-text",
"file-video",
"file-word",
"file-zip",
"filter",
"flag",
"folder",
"folder-structure",
"food",
"funnel",
"github",
"globe",
"grid",
"grid-bottom",
"grid-bottom-left",
"grid-bottom-right",
"grid-full",
"grid-left",
"grid-right",
"grid-top",
"grid-top-left",
"grid-top-right",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6",
"headline",
"heart",
"heart-outline",
"hidden",
"home",
"image",
"images",
"import",
"info",
"instagram",
"italic",
"key",
"layers",
"linkedin",
"list-bullet",
"list-numbers",
"live",
"loader",
"lock",
"logout",
"map",
"markdown",
"menu",
"mobile",
"money",
"moon",
"open",
"order-alpha-asc",
"order-alpha-desc",
"order-num-asc",
"order-num-desc",
"page",
"palette",
"paragraph",
"parent",
"paypal",
"pen",
"phone",
"pin",
"pinterest",
"pipette",
"play",
"preview",
"print",
"protected",
"qr-code",
"question",
"quote",
"refresh",
"remove",
"road-sign",
"search",
"server",
"settings",
"share",
"shuffle",
"sitemap",
"smile",
"sort",
"star",
"star-outline",
"store",
"strikethrough",
"sun",
"table",
"tablet",
"tag",
"template",
"text",
"text-center",
"text-justify",
"text-left",
"text-right",
"ticket",
"tiktok",
"title",
"toggle-off",
"toggle-on",
"trash",
"twitter",
"underline",
"undo",
"unlock",
"upload",
"url",
"user",
"users",
"video",
"vimeo",
"wand",
"whatsapp",
"wheelchair"
]
}
]
},
"@image": {
"description": "Image options to control the source and look of file previews",
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"color": {
"$ref": "#/$defs/nonEmptyString"
},
"cover": {
"type": "boolean"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"query": {
"$ref": "#/$defs/nonEmptyString"
},
"ratio": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/stringOrTranslated",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
},
"type": "array"
}
]
},
"@max": {
"type": "number"
},
"@maxlength": {
"type": "number"
},
"@min": {
"type": "number"
},
"@minlength": {
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@nodes": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/nodes"
},
"type": "array"
}
]
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
},
{
"items": {
"$ref": "#/$defs/objectWithStringValues"
},
"type": "array"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@separator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"object": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"object"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"subpages": {
"default": true,
"type": "boolean"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"pages"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"radio"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"tooltip": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"range"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"select"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"allow": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"path": {
"$ref": "#/$defs/nonEmptyString"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sync": {
"$ref": "#/$defs/nonEmptyString"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"slug"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
},
"wizard": {
"additionalProperties": false,
"properties": {
"field": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"duplicate": {
"default": true,
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"prepend": {
"default": true,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"structure"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"accept": {
"$ref": "#/$defs/nonEmptyString",
"default": "all"
},
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tags"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tel"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"buttons": {
"$ref": "#/$defs/field-properties/@buttons"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"files": {
"$ref": "#/$defs/field-properties/@files"
},
"font": {
"default": "sans",
"enum": [
"sans",
"monospace"
]
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"textarea"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads"
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"notation": {
"default": 24,
"enum": [
12,
24
]
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"time"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"text": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"items": {
"$ref": "#/$defs/translated"
},
"type": "array"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggle"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"grow": {
"default": true,
"type": "boolean"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"labels": {
"default": true,
"type": "boolean"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"reset": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggles"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon",
"default": "url"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"url"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": true
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"users"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"inline": {
"default": false,
"type": "boolean"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"nodes": {
"$ref": "#/$defs/field-properties/@nodes"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"writer"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
},
"type": "array"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link"
]
},
"nodes": {
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"queryObject": {
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"textValuePair": {
"additionalProperties": false,
"properties": {
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"oneOf": [
{
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
{
"items": {
"$ref": "#/$defs/column"
},
"type": "array"
}
]
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | d786851721061876899fe80c3a7b1e231f06c757 | 2023-04-03T10:33:26 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"blueprint": {
"enum": [
"file"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"page"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"site"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"user"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"required": [
"blueprint"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@buttons": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"enum": [
"headlines",
"italic",
"bold",
"link",
"email",
"file",
"code",
"ul",
"ol",
"|"
]
},
"type": "array"
}
]
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/booleanOrStringArrayUnique"
}
]
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@files": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/stringOrTranslated",
"description": "Optional help text below the field"
},
"@icon": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"enum": [
"account",
"add",
"alert",
"angle-down",
"angle-left",
"angle-right",
"angle-up",
"archive",
"attachment",
"audio",
"badge",
"bars",
"bell",
"blank",
"bold",
"bolt",
"book",
"bookmark",
"box",
"brush",
"bug",
"calendar",
"cancel",
"cancel-small",
"car",
"cart",
"chart",
"chat",
"check",
"circle",
"circle-filled",
"circle-half",
"circle-nested",
"circle-outline",
"clock",
"code",
"cog",
"collapse",
"copy",
"credit-card",
"crop",
"dashboard",
"discord",
"discount",
"display",
"divider",
"document",
"dots",
"download",
"draft",
"edit",
"email",
"expand",
"facebook",
"file",
"file-audio",
"file-code",
"file-document",
"file-image",
"file-spreadsheet",
"file-text",
"file-video",
"file-word",
"file-zip",
"filter",
"flag",
"folder",
"folder-structure",
"food",
"funnel",
"github",
"globe",
"grid",
"grid-bottom",
"grid-bottom-left",
"grid-bottom-right",
"grid-full",
"grid-left",
"grid-right",
"grid-top",
"grid-top-left",
"grid-top-right",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6",
"headline",
"heart",
"heart-outline",
"hidden",
"home",
"image",
"images",
"import",
"info",
"instagram",
"italic",
"key",
"layers",
"linkedin",
"list-bullet",
"list-numbers",
"live",
"loader",
"lock",
"logout",
"map",
"markdown",
"menu",
"mobile",
"money",
"moon",
"open",
"order-alpha-asc",
"order-alpha-desc",
"order-num-asc",
"order-num-desc",
"page",
"palette",
"paragraph",
"parent",
"paypal",
"pen",
"phone",
"pin",
"pinterest",
"pipette",
"play",
"preview",
"print",
"protected",
"qr-code",
"question",
"quote",
"refresh",
"remove",
"road-sign",
"search",
"server",
"settings",
"share",
"shuffle",
"sitemap",
"smile",
"sort",
"star",
"star-outline",
"store",
"strikethrough",
"sun",
"table",
"tablet",
"tag",
"template",
"text",
"text-center",
"text-justify",
"text-left",
"text-right",
"ticket",
"tiktok",
"title",
"toggle-off",
"toggle-on",
"trash",
"twitter",
"underline",
"undo",
"unlock",
"upload",
"url",
"user",
"users",
"video",
"vimeo",
"wand",
"whatsapp",
"wheelchair"
]
}
]
},
"@image": {
"description": "Image options to control the source and look of file previews",
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"color": {
"$ref": "#/$defs/nonEmptyString"
},
"cover": {
"type": "boolean"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"query": {
"$ref": "#/$defs/nonEmptyString"
},
"ratio": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/stringOrTranslated",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
},
"type": "array"
}
]
},
"@max": {
"type": "number"
},
"@maxlength": {
"type": "number"
},
"@min": {
"type": "number"
},
"@minlength": {
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@nodes": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/nodes"
},
"type": "array"
}
]
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
},
{
"items": {
"$ref": "#/$defs/objectWithStringValues"
},
"type": "array"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@separator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"object": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"object"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"subpages": {
"default": true,
"type": "boolean"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"pages"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"radio"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"tooltip": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"range"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"select"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"allow": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"path": {
"$ref": "#/$defs/nonEmptyString"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sync": {
"$ref": "#/$defs/nonEmptyString"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"slug"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
},
"wizard": {
"additionalProperties": false,
"properties": {
"field": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"duplicate": {
"default": true,
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"prepend": {
"default": true,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"structure"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"accept": {
"$ref": "#/$defs/nonEmptyString",
"default": "all"
},
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tags"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tel"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"buttons": {
"$ref": "#/$defs/field-properties/@buttons"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"files": {
"$ref": "#/$defs/field-properties/@files"
},
"font": {
"default": "sans",
"enum": [
"sans",
"monospace"
]
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"textarea"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads"
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"notation": {
"default": 24,
"enum": [
12,
24
]
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"time"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"text": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"items": {
"$ref": "#/$defs/translated"
},
"type": "array"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggle"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"grow": {
"default": true,
"type": "boolean"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"labels": {
"default": true,
"type": "boolean"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"reset": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggles"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon",
"default": "url"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"url"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": true
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"users"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"inline": {
"default": false,
"type": "boolean"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"nodes": {
"$ref": "#/$defs/field-properties/@nodes"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"writer"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
},
"type": "array"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link",
"email"
]
},
"nodes": {
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"queryObject": {
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"textValuePair": {
"additionalProperties": false,
"properties": {
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"oneOf": [
{
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
{
"items": {
"$ref": "#/$defs/column"
},
"type": "array"
}
]
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | 988316447bc3c9cf654d65928e4e21722a75af41 | 2022-07-04T19:55:33 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/columns"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
},
"type": {
"enum": [
"file"
]
}
},
"required": [
"type"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
},
"type": {
"enum": [
"page"
]
}
},
"required": [
"type"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/columns"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
},
"type": {
"enum": [
"site"
]
}
},
"required": [
"type"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/columns"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
},
"type": {
"enum": [
"user"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional help text below the field"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"$ref": "#/$defs/nonEmptyString",
"description": "Image options to control the source and look of file previews"
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/nonEmptyString",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
}
}
]
},
"@max": {
"exclusiveMinimum": 0,
"type": "number"
},
"@maxlength": {
"exclusiveMinimum": 0,
"type": "number"
},
"@min": {
"exclusiveMinimum": 0,
"type": "number"
},
"@minlength": {
"exclusiveMinimum": 0,
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@seperator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"$ref": "#/$defs/stringArrayUnique"
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"seperator": {
"$ref": "#/$defs/field-properties/@seperator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"radio"
]
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"range"
]
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"select"
]
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"slug"
]
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"structure"
]
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"tags"
]
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"tel"
]
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"textarea"
]
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"time"
]
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"toggle"
]
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"toggles"
]
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"url"
]
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"users"
]
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"writer"
]
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
}
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | 0086eecef634f8e79ddf0ea332bd5841240257ee | 2022-06-26T08:48:56 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/section"
}
]
}
},
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"field-properties": {
"create": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"extends": {
"$ref": "#/$defs/nonEmptyString"
},
"flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"help": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional help text below the field"
},
"image": {
"$ref": "#/$defs/nonEmptyString",
"description": "Image options to control the source and look of file previews"
},
"info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"label": {
"$ref": "#/$defs/nonEmptyString",
"description": "label is the new official replacement for headline"
},
"layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"max": {
"description": "Sets the maximum number of allowed entries in the section",
"exclusiveMinimum": 0,
"type": "number"
},
"min": {
"description": "Sets the minimum number of required entries in the section",
"exclusiveMinimum": 0,
"type": "number"
},
"multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"templates": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
}
},
"fields": {
"files": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"label": {
"$ref": "#/$defs/field-properties/label"
},
"multiple": {
"$ref": "#/$defs/field-properties/multiple",
"default": true
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"default": {
"$ref": "#/$defs/field-properties/default"
},
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"headline": {
"$ref": "#/$defs/field-properties/headline"
},
"help": {
"$ref": "#/$defs/field-properties/help"
},
"label": {
"$ref": "#/$defs/field-properties/label"
},
"type": {
"enum": [
"text"
]
}
},
"required": [
"type"
]
}
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type"
],
"type": "object"
},
"files": {
"properties": {
"empty": {
"$ref": "#/$defs/field-properties/empty"
},
"flip": {
"$ref": "#/$defs/field-properties/flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/headline"
},
"help": {
"$ref": "#/$defs/field-properties/help"
},
"image": {
"$ref": "#/$defs/field-properties/image"
},
"info": {
"$ref": "#/$defs/field-properties/info"
},
"label": {
"$ref": "#/$defs/field-properties/label"
},
"layout": {
"$ref": "#/$defs/field-properties/layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/max"
},
"min": {
"$ref": "#/$defs/field-properties/min"
},
"page": {
"$ref": "#/$defs/field-properties/page"
},
"parent": {
"$ref": "#/$defs/field-properties/parent"
},
"size": {
"$ref": "#/$defs/field-properties/size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/status"
},
"template": {
"$ref": "#/$defs/field-properties/template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"properties": {
"headline": {
"$ref": "#/$defs/field-properties/headline"
},
"label": {
"$ref": "#/$defs/field-properties/label"
},
"text": {
"$ref": "#/$defs/field-properties/text"
},
"theme": {
"$ref": "#/$defs/field-properties/theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"properties": {
"create": {
"$ref": "#/$defs/field-properties/create"
},
"empty": {
"$ref": "#/$defs/field-properties/empty"
},
"flip": {
"$ref": "#/$defs/field-properties/flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/headline"
},
"help": {
"$ref": "#/$defs/field-properties/help"
},
"image": {
"$ref": "#/$defs/field-properties/image"
},
"info": {
"$ref": "#/$defs/field-properties/info"
},
"label": {
"$ref": "#/$defs/field-properties/label"
},
"layout": {
"$ref": "#/$defs/field-properties/layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/max"
},
"min": {
"$ref": "#/$defs/field-properties/min"
},
"page": {
"$ref": "#/$defs/field-properties/page"
},
"parent": {
"$ref": "#/$defs/field-properties/parent"
},
"size": {
"$ref": "#/$defs/field-properties/size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/status"
},
"templates": {
"$ref": "#/$defs/field-properties/templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"translated": {
"properties": {
"de": {
"$ref": "#/$defs/nonEmptyString"
},
"en": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"wrappers": {
"columns": {
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/files"
}
]
}
},
"properties": {
"legal": {
"type": "boolean"
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "http://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/nonEmptyString"
},
"image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"type": "object"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | 9a91e6e444bfccc6faf7bee1f49ffe197c330315 | 2023-11-28T14:11:03 | kirby4-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@create": {
"properties": {
"fields": {
"$ref": "#/$defs/stringArrayUnique"
},
"redirect": {
"default": true,
"type": "boolean"
},
"status": {
"default": "draft",
"enum": [
"draft",
"unlisted",
"listed"
]
},
"title": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"blueprint": {
"enum": [
"file"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"page"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"create": {
"$ref": "#/$defs/blueprint-properties/@create"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"site"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"user"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"required": [
"blueprint"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@buttons": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"enum": [
"headlines",
"italic",
"bold",
"link",
"email",
"file",
"code",
"ul",
"ol",
"|"
]
},
"type": "array"
}
]
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/booleanOrStringArrayUnique"
}
]
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@files": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/stringOrTranslated",
"description": "Optional help text below the field"
},
"@icon": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"enum": [
"account",
"add",
"alert",
"anchor",
"angle-down",
"angle-left",
"angle-right",
"angle-up",
"archive",
"attachment",
"audio",
"badge",
"bars",
"bell",
"blank",
"bold",
"bolt",
"book",
"bookmark",
"box",
"bug",
"brush",
"calendar",
"cancel",
"cancel-small",
"car",
"cart",
"chart",
"chat",
"check",
"checklist",
"circle",
"circle-filled",
"circle-filled",
"circle-half",
"circle-nested",
"circle-outline",
"clear",
"clock",
"code",
"cog",
"collapse",
"copy",
"credit-card",
"crop",
"dashboard",
"discord",
"discount",
"display",
"divider",
"document",
"dots",
"download",
"draft",
"edit",
"editv",
"email",
"expand",
"facebook",
"file",
"file-audio",
"file-code",
"file-document",
"file-image",
"file-spreadsheet",
"file-text",
"file-video",
"file-word",
"file-zip",
"filter",
"flag",
"folder",
"folder-structure",
"food",
"funnel",
"github",
"globe",
"grid",
"grid-bottom",
"grid-bottom-left",
"grid-bottom-right",
"grid-full",
"grid-left",
"grid-right",
"grid-top",
"grid-top-left",
"grid-top-right",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6",
"headline",
"heart",
"heart-filled",
"heart-outline",
"hidden",
"home",
"image",
"images",
"import",
"info",
"instagram",
"italic",
"key",
"layers",
"linkedin",
"list-bullet",
"list-numbers",
"live",
"loader",
"lock",
"logout",
"map",
"markdown",
"mastodon",
"megaphone",
"menu",
"merge",
"mobile",
"money",
"moon",
"open",
"order-alpha-asc",
"order-alpha-desc",
"order-num-asc",
"order-num-desc",
"page",
"palette",
"paragraph",
"parent",
"paypal",
"pen",
"phone",
"pin",
"pinterest",
"pipette",
"plane",
"play",
"plus",
"preview",
"print",
"protected",
"qr-code",
"question",
"quote",
"refresh",
"remove",
"search",
"server",
"settings",
"share",
"shuffle",
"sitemap",
"smile",
"sort",
"sparkling",
"split",
"star",
"star-filled",
"star-outline",
"status-draft",
"status-unlisted",
"status-listed",
"store",
"strikethrough",
"sun",
"subscript",
"superscript",
"table",
"tablet",
"tag",
"template",
"text",
"text-center",
"text-justify",
"text-left",
"text-right",
"ticket",
"tiktok",
"title",
"toggle-off",
"toggle-on",
"trash",
"underline",
"undo",
"unlock",
"upload",
"url",
"user",
"users",
"video",
"vimeo",
"wand",
"whatsapp",
"wheelchair",
"youtube"
]
}
]
},
"@image": {
"description": "Image options to control the source and look of file previews",
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"color": {
"$ref": "#/$defs/nonEmptyString"
},
"cover": {
"type": "boolean"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"query": {
"$ref": "#/$defs/nonEmptyString"
},
"ratio": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/stringOrTranslated",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
},
"type": "array"
}
]
},
"@max": {
"type": "number"
},
"@maxlength": {
"type": "number"
},
"@min": {
"type": "number"
},
"@minlength": {
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@nodes": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/nodes"
},
"type": "array"
}
]
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
},
{
"items": {
"$ref": "#/$defs/objectWithStringValues"
},
"type": "array"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@separator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"object": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"object"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"subpages": {
"default": true,
"type": "boolean"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"pages"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"radio"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"tooltip": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"range"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"select"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"allow": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"path": {
"$ref": "#/$defs/nonEmptyString"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sync": {
"$ref": "#/$defs/nonEmptyString"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"slug"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
},
"wizard": {
"additionalProperties": false,
"properties": {
"field": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"duplicate": {
"default": true,
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"prepend": {
"default": true,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"structure"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"accept": {
"$ref": "#/$defs/nonEmptyString",
"default": "all"
},
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tags"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tel"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"buttons": {
"$ref": "#/$defs/field-properties/@buttons"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"files": {
"$ref": "#/$defs/field-properties/@files"
},
"font": {
"default": "sans",
"enum": [
"sans",
"monospace"
]
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"textarea"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads"
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"notation": {
"default": 24,
"enum": [
12,
24
]
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"time"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"text": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"items": {
"$ref": "#/$defs/translated"
},
"type": "array"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggle"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"grow": {
"default": true,
"type": "boolean"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"labels": {
"default": true,
"type": "boolean"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"reset": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggles"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon",
"default": "url"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"url"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": true
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"users"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"inline": {
"default": false,
"type": "boolean"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"nodes": {
"$ref": "#/$defs/field-properties/@nodes"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"writer"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
},
"type": "array"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link",
"email",
"sub",
"sup",
"clear"
]
},
"nodes": {
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"queryObject": {
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"templatesIgnore": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"textValuePair": {
"additionalProperties": false,
"properties": {
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"oneOf": [
{
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
{
"items": {
"$ref": "#/$defs/column"
},
"type": "array"
}
]
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | 3a6bd1f72d71b4ea82cedf5f751691e203ffd5af | 2023-11-28T15:58:55 | kirby4-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@create": {
"properties": {
"fields": {
"$ref": "#/$defs/stringArrayUnique"
},
"redirect": {
"default": true,
"type": "boolean"
},
"status": {
"default": "draft",
"enum": [
"draft",
"unlisted",
"listed"
]
},
"title": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"blueprint": {
"enum": [
"file"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"create": {
"properties": {
"crop": {
"default": false,
"type": "boolean"
},
"height": {
"$ref": "#/$defs/numberInPixel"
},
"width": {
"$ref": "#/$defs/numberInPixel"
}
},
"type": "object"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"focus": {
"default": true,
"type": "boolean"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"page"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"create": {
"$ref": "#/$defs/blueprint-properties/@create"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"site"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"user"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"required": [
"blueprint"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@buttons": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"enum": [
"headlines",
"italic",
"bold",
"link",
"email",
"file",
"code",
"ul",
"ol",
"|"
]
},
"type": "array"
}
]
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/booleanOrStringArrayUnique"
}
]
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@files": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/stringOrTranslated",
"description": "Optional help text below the field"
},
"@icon": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"enum": [
"account",
"add",
"alert",
"anchor",
"angle-down",
"angle-left",
"angle-right",
"angle-up",
"archive",
"attachment",
"audio",
"badge",
"bars",
"bell",
"blank",
"bold",
"bolt",
"book",
"bookmark",
"box",
"bug",
"brush",
"calendar",
"cancel",
"cancel-small",
"car",
"cart",
"chart",
"chat",
"check",
"checklist",
"circle",
"circle-filled",
"circle-filled",
"circle-half",
"circle-nested",
"circle-outline",
"clear",
"clock",
"code",
"cog",
"collapse",
"copy",
"credit-card",
"crop",
"dashboard",
"discord",
"discount",
"display",
"divider",
"document",
"dots",
"download",
"draft",
"edit",
"editv",
"email",
"expand",
"facebook",
"file",
"file-audio",
"file-code",
"file-document",
"file-image",
"file-spreadsheet",
"file-text",
"file-video",
"file-word",
"file-zip",
"filter",
"flag",
"folder",
"folder-structure",
"food",
"funnel",
"github",
"globe",
"grid",
"grid-bottom",
"grid-bottom-left",
"grid-bottom-right",
"grid-full",
"grid-left",
"grid-right",
"grid-top",
"grid-top-left",
"grid-top-right",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6",
"headline",
"heart",
"heart-filled",
"heart-outline",
"hidden",
"home",
"image",
"images",
"import",
"info",
"instagram",
"italic",
"key",
"layers",
"linkedin",
"list-bullet",
"list-numbers",
"live",
"loader",
"lock",
"logout",
"map",
"markdown",
"mastodon",
"megaphone",
"menu",
"merge",
"mobile",
"money",
"moon",
"open",
"order-alpha-asc",
"order-alpha-desc",
"order-num-asc",
"order-num-desc",
"page",
"palette",
"paragraph",
"parent",
"paypal",
"pen",
"phone",
"pin",
"pinterest",
"pipette",
"plane",
"play",
"plus",
"preview",
"print",
"protected",
"qr-code",
"question",
"quote",
"refresh",
"remove",
"search",
"server",
"settings",
"share",
"shuffle",
"sitemap",
"smile",
"sort",
"sparkling",
"split",
"star",
"star-filled",
"star-outline",
"status-draft",
"status-unlisted",
"status-listed",
"store",
"strikethrough",
"sun",
"subscript",
"superscript",
"table",
"tablet",
"tag",
"template",
"text",
"text-center",
"text-justify",
"text-left",
"text-right",
"ticket",
"tiktok",
"title",
"toggle-off",
"toggle-on",
"trash",
"underline",
"undo",
"unlock",
"upload",
"url",
"user",
"users",
"video",
"vimeo",
"wand",
"whatsapp",
"wheelchair",
"youtube"
]
}
]
},
"@image": {
"description": "Image options to control the source and look of file previews",
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"color": {
"$ref": "#/$defs/nonEmptyString"
},
"cover": {
"type": "boolean"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"query": {
"$ref": "#/$defs/nonEmptyString"
},
"ratio": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/stringOrTranslated",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
},
"type": "array"
}
]
},
"@max": {
"type": "number"
},
"@maxlength": {
"type": "number"
},
"@min": {
"type": "number"
},
"@minlength": {
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@nodes": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/nodes"
},
"type": "array"
}
]
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
},
{
"items": {
"$ref": "#/$defs/objectWithStringValues"
},
"type": "array"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@separator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"object": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"object"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"subpages": {
"default": true,
"type": "boolean"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"pages"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"radio"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"tooltip": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"range"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"select"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"allow": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"path": {
"$ref": "#/$defs/nonEmptyString"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sync": {
"$ref": "#/$defs/nonEmptyString"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"slug"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
},
"wizard": {
"additionalProperties": false,
"properties": {
"field": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"duplicate": {
"default": true,
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"prepend": {
"default": true,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"structure"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"accept": {
"$ref": "#/$defs/nonEmptyString",
"default": "all"
},
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tags"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tel"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"buttons": {
"$ref": "#/$defs/field-properties/@buttons"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"files": {
"$ref": "#/$defs/field-properties/@files"
},
"font": {
"default": "sans",
"enum": [
"sans",
"monospace"
]
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"textarea"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads"
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"notation": {
"default": 24,
"enum": [
12,
24
]
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"time"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"text": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"items": {
"$ref": "#/$defs/translated"
},
"type": "array"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggle"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"grow": {
"default": true,
"type": "boolean"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"labels": {
"default": true,
"type": "boolean"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"reset": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggles"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon",
"default": "url"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"url"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": true
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"users"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"inline": {
"default": false,
"type": "boolean"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"nodes": {
"$ref": "#/$defs/field-properties/@nodes"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"writer"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
},
"type": "array"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link",
"email",
"sub",
"sup",
"clear"
]
},
"nodes": {
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"queryObject": {
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"query": {
"$ref": "#/$defs/nonEmptyString"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"templatesIgnore": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"textValuePair": {
"additionalProperties": false,
"properties": {
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"oneOf": [
{
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
{
"items": {
"$ref": "#/$defs/column"
},
"type": "array"
}
]
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | 3a91ba8c4c58af938f8b208be251a2009b9ba7af | 2022-07-27T08:24:30 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"blueprint": {
"enum": [
"file"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"page"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"site"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"user"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"required": [
"blueprint"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@buttons": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"enum": [
"headlines",
"italic",
"bold",
"link",
"email",
"file",
"code",
"ul",
"ol",
"|"
]
},
"type": "array"
}
]
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/booleanOrStringArrayUnique"
}
]
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@files": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional help text below the field"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"description": "Image options to control the source and look of file previews",
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"cover": {
"type": "boolean"
},
"ratio": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/nonEmptyString",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
},
"type": "array"
}
]
},
"@max": {
"type": "number"
},
"@maxlength": {
"type": "number"
},
"@min": {
"type": "number"
},
"@minlength": {
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@nodes": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/nodes"
},
"type": "array"
}
]
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
},
{
"items": {
"$ref": "#/$defs/objectWithStringValues"
},
"type": "array"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@separator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"subpages": {
"default": true,
"type": "boolean"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"pages"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"radio"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"tooltip": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"range"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"select"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"allow": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"path": {
"$ref": "#/$defs/nonEmptyString"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sync": {
"$ref": "#/$defs/nonEmptyString"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"slug"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
},
"wizard": {
"additionalProperties": false,
"properties": {
"field": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"duplicate": {
"default": true,
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"prepend": {
"default": true,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"structure"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"accept": {
"$ref": "#/$defs/nonEmptyString",
"default": "all"
},
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tags"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tel"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"buttons": {
"$ref": "#/$defs/field-properties/@buttons"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"files": {
"$ref": "#/$defs/field-properties/@files"
},
"font": {
"default": "sans",
"enum": [
"sans",
"monospace"
]
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"textarea"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads"
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"notation": {
"default": 24,
"enum": [
12,
24
]
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"time"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"text": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"items": {
"$ref": "#/$defs/translated"
},
"type": "array"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggle"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"grow": {
"default": true,
"type": "boolean"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"labels": {
"default": true,
"type": "boolean"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"reset": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggles"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon",
"default": "url"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"url"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": true
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"users"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"inline": {
"default": false,
"type": "boolean"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"nodes": {
"$ref": "#/$defs/field-properties/@nodes"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"writer"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
},
"type": "array"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link"
]
},
"nodes": {
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"queryObject": {
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"textValuePair": {
"additionalProperties": false,
"properties": {
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"oneOf": [
{
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
{
"items": {
"$ref": "#/$defs/column"
},
"type": "array"
}
]
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | d26edd382a6457bd7f00649e7bba22f21dcd613d | 2022-07-03T10:44:46 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/section"
}
]
}
},
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"field-properties": {
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@required": {
"type": "boolean"
},
"after": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"type": "boolean"
},
"before": {
"$ref": "#/$defs/nonEmptyString"
},
"converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"counter": {
"type": "boolean"
},
"create": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"disabled": {
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"extends": {
"$ref": "#/$defs/nonEmptyString"
},
"flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"headline": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional help text below the field"
},
"icon": {
"$ref": "#/$defs/nonEmptyString"
},
"image": {
"$ref": "#/$defs/nonEmptyString",
"description": "Image options to control the source and look of file previews"
},
"info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"label": {
"$ref": "#/$defs/nonEmptyString",
"description": "label is the new official replacement for headline"
},
"layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"link": {
"type": "boolean"
},
"max": {
"exclusiveMinimum": 0,
"type": "number"
},
"maxlength": {
"exclusiveMinimum": 0,
"type": "number"
},
"min": {
"exclusiveMinimum": 0,
"type": "number"
},
"minlength": {
"exclusiveMinimum": 0,
"type": "number"
},
"multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"options": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"query": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"search": {
"type": "boolean"
},
"size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"spellcheck": {
"type": "boolean"
},
"status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"templates": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"translate": {
"type": "boolean"
},
"uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"when": {
"$ref": "#/$defs/nonEmptyString"
},
"width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"blocks"
]
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"checkboxes"
]
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"date"
]
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"email"
]
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"default": {
"$ref": "#/$defs/field-properties/default"
},
"disabled": {
"$ref": "#/$defs/field-properties/disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/empty"
},
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"help": {
"$ref": "#/$defs/field-properties/help"
},
"image": {
"$ref": "#/$defs/field-properties/image"
},
"info": {
"$ref": "#/$defs/field-properties/info"
},
"label": {
"$ref": "#/$defs/field-properties/label"
},
"link": {
"$ref": "#/$defs/field-properties/link"
},
"max": {
"$ref": "#/$defs/field-properties/max"
},
"min": {
"$ref": "#/$defs/field-properties/min"
},
"multiple": {
"$ref": "#/$defs/field-properties/multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/text"
},
"translate": {
"$ref": "#/$defs/field-properties/translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/when"
},
"width": {
"$ref": "#/$defs/field-properties/width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"gap"
]
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"headline"
]
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"list"
]
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"multiselect"
]
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"number"
]
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"radio"
]
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"range"
]
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"select"
]
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"slug"
]
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"structure"
]
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"tags"
]
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"tel"
]
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/before"
},
"converter": {
"$ref": "#/$defs/field-properties/converter"
},
"counter": {
"$ref": "#/$defs/field-properties/counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/default"
},
"disabled": {
"$ref": "#/$defs/field-properties/disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"help": {
"$ref": "#/$defs/field-properties/help"
},
"icon": {
"$ref": "#/$defs/field-properties/icon"
},
"label": {
"$ref": "#/$defs/field-properties/label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/icon"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/when"
},
"width": {
"$ref": "#/$defs/field-properties/width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"textarea"
]
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"time"
]
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"toggle"
]
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"url"
]
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"users"
]
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/extends"
},
"type": {
"enum": [
"writer"
]
}
},
"required": [
"type"
]
}
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type"
],
"type": "object"
},
"files": {
"properties": {
"empty": {
"$ref": "#/$defs/field-properties/empty"
},
"flip": {
"$ref": "#/$defs/field-properties/flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/headline"
},
"help": {
"$ref": "#/$defs/field-properties/help"
},
"image": {
"$ref": "#/$defs/field-properties/image"
},
"info": {
"$ref": "#/$defs/field-properties/info"
},
"label": {
"$ref": "#/$defs/field-properties/label"
},
"layout": {
"$ref": "#/$defs/field-properties/layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/max"
},
"min": {
"$ref": "#/$defs/field-properties/min"
},
"page": {
"$ref": "#/$defs/field-properties/page"
},
"parent": {
"$ref": "#/$defs/field-properties/parent"
},
"size": {
"$ref": "#/$defs/field-properties/size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/status"
},
"template": {
"$ref": "#/$defs/field-properties/template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"properties": {
"headline": {
"$ref": "#/$defs/field-properties/headline"
},
"label": {
"$ref": "#/$defs/field-properties/label"
},
"text": {
"$ref": "#/$defs/field-properties/text"
},
"theme": {
"$ref": "#/$defs/field-properties/theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"properties": {
"create": {
"$ref": "#/$defs/field-properties/create"
},
"empty": {
"$ref": "#/$defs/field-properties/empty"
},
"flip": {
"$ref": "#/$defs/field-properties/flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/headline"
},
"help": {
"$ref": "#/$defs/field-properties/help"
},
"image": {
"$ref": "#/$defs/field-properties/image"
},
"info": {
"$ref": "#/$defs/field-properties/info"
},
"label": {
"$ref": "#/$defs/field-properties/label"
},
"layout": {
"$ref": "#/$defs/field-properties/layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/max"
},
"min": {
"$ref": "#/$defs/field-properties/min"
},
"page": {
"$ref": "#/$defs/field-properties/page"
},
"parent": {
"$ref": "#/$defs/field-properties/parent"
},
"size": {
"$ref": "#/$defs/field-properties/size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/status"
},
"templates": {
"$ref": "#/$defs/field-properties/templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"translated": {
"properties": {
"de": {
"$ref": "#/$defs/nonEmptyString"
},
"en": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"wrappers": {
"columns": {
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/nonEmptyString"
},
"image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"preset": {
"enum": [
"files",
"page",
"pages"
]
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"type": "object"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | 02ff66505ad222a8b222c9b7e441e8c5c4fa6bf9 | 2022-07-27T08:30:55 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"blueprint": {
"enum": [
"file"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"page"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"site"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"user"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"required": [
"blueprint"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@buttons": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"enum": [
"headlines",
"italic",
"bold",
"link",
"email",
"file",
"code",
"ul",
"ol",
"|"
]
},
"type": "array"
}
]
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/booleanOrStringArrayUnique"
}
]
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@files": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional help text below the field"
},
"@icon": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"enum": [
"account",
"add",
"alert",
"angle-down",
"angle-left",
"angle-right",
"angle-up",
"archive",
"attachment",
"audio",
"badge",
"bars",
"bell",
"blank",
"bold",
"bolt",
"book",
"bookmark",
"box",
"brush",
"bug",
"calendar",
"cancel",
"cancel-small",
"car",
"cart",
"chart",
"chat",
"check",
"circle",
"circle-filled",
"circle-half",
"circle-nested",
"circle-outline",
"clock",
"code",
"cog",
"collapse",
"copy",
"credit-card",
"crop",
"dashboard",
"discord",
"discount",
"display",
"divider",
"document",
"dots",
"download",
"draft",
"edit",
"email",
"expand",
"facebook",
"file",
"file-audio",
"file-code",
"file-document",
"file-image",
"file-spreadsheet",
"file-text",
"file-video",
"file-word",
"file-zip",
"filter",
"flag",
"folder",
"folder-structure",
"food",
"funnel",
"github",
"globe",
"grid",
"grid-bottom",
"grid-bottom-left",
"grid-bottom-right",
"grid-full",
"grid-left",
"grid-right",
"grid-top",
"grid-top-left",
"grid-top-right",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6",
"headline",
"heart",
"heart-outline",
"hidden",
"home",
"image",
"images",
"import",
"info",
"instagram",
"italic",
"key",
"layers",
"linkedin",
"list-bullet",
"list-numbers",
"live",
"loader",
"lock",
"logout",
"map",
"markdown",
"menu",
"mobile",
"money",
"moon",
"open",
"order-alpha-asc",
"order-alpha-desc",
"order-num-asc",
"order-num-desc",
"page",
"palette",
"paragraph",
"parent",
"paypal",
"pen",
"phone",
"pin",
"pinterest",
"pipette",
"play",
"preview",
"print",
"protected",
"qr-code",
"question",
"quote",
"refresh",
"remove",
"road-sign",
"search",
"server",
"settings",
"share",
"shuffle",
"sitemap",
"smile",
"sort",
"star",
"star-outline",
"store",
"strikethrough",
"sun",
"table",
"tablet",
"tag",
"template",
"text",
"text-center",
"text-justify",
"text-left",
"text-right",
"ticket",
"tiktok",
"title",
"toggle-off",
"toggle-on",
"trash",
"twitter",
"underline",
"undo",
"unlock",
"upload",
"url",
"user",
"users",
"video",
"vimeo",
"wand",
"whatsapp",
"wheelchair"
]
}
]
},
"@image": {
"description": "Image options to control the source and look of file previews",
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"cover": {
"type": "boolean"
},
"ratio": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/nonEmptyString",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
},
"type": "array"
}
]
},
"@max": {
"type": "number"
},
"@maxlength": {
"type": "number"
},
"@min": {
"type": "number"
},
"@minlength": {
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@nodes": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/nodes"
},
"type": "array"
}
]
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
},
{
"items": {
"$ref": "#/$defs/objectWithStringValues"
},
"type": "array"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@separator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"subpages": {
"default": true,
"type": "boolean"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"pages"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"radio"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"tooltip": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"range"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"select"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"allow": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"path": {
"$ref": "#/$defs/nonEmptyString"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sync": {
"$ref": "#/$defs/nonEmptyString"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"slug"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
},
"wizard": {
"additionalProperties": false,
"properties": {
"field": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"duplicate": {
"default": true,
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"prepend": {
"default": true,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"structure"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"accept": {
"$ref": "#/$defs/nonEmptyString",
"default": "all"
},
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tags"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tel"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"buttons": {
"$ref": "#/$defs/field-properties/@buttons"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"files": {
"$ref": "#/$defs/field-properties/@files"
},
"font": {
"default": "sans",
"enum": [
"sans",
"monospace"
]
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"textarea"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads"
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"notation": {
"default": 24,
"enum": [
12,
24
]
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"time"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"text": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"items": {
"$ref": "#/$defs/translated"
},
"type": "array"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggle"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"grow": {
"default": true,
"type": "boolean"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"labels": {
"default": true,
"type": "boolean"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"reset": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggles"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon",
"default": "url"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"url"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": true
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"users"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"inline": {
"default": false,
"type": "boolean"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"nodes": {
"$ref": "#/$defs/field-properties/@nodes"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"writer"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
},
"type": "array"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link"
]
},
"nodes": {
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"queryObject": {
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"textValuePair": {
"additionalProperties": false,
"properties": {
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"oneOf": [
{
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
{
"items": {
"$ref": "#/$defs/column"
},
"type": "array"
}
]
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | 7529e2c22f2e421d16a4a8efa865bdae0d25e9f2 | 2022-07-04T23:54:03 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"blueprint": {
"enum": [
"file"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"page"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"site"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"user"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"required": [
"blueprint"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@buttons": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"enum": [
"headlines",
"italic",
"bold",
"link",
"email",
"file",
"code",
"ul",
"ol",
"|"
]
},
"type": "array"
}
]
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/booleanOrStringArrayUnique"
}
]
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@files": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional help text below the field"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"description": "Image options to control the source and look of file previews",
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"cover": {
"type": "boolean"
},
"ratio": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/nonEmptyString",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
},
"type": "array"
}
]
},
"@max": {
"type": "number"
},
"@maxlength": {
"type": "number"
},
"@min": {
"type": "number"
},
"@minlength": {
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@nodes": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/nodes"
},
"type": "array"
}
]
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
},
{
"items": {
"$ref": "#/$defs/objectWithStringValues"
},
"type": "array"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@separator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"subpages": {
"default": true,
"type": "boolean"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"pages"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"radio"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"tooltip": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"range"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"select"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"allow": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"path": {
"$ref": "#/$defs/nonEmptyString"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sync": {
"$ref": "#/$defs/nonEmptyString"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"slug"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
},
"wizard": {
"additionalProperties": false,
"properties": {
"field": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"duplicate": {
"default": true,
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"prepend": {
"default": true,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"structure"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"accept": {
"$ref": "#/$defs/nonEmptyString",
"default": "all"
},
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tags"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tel"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"buttons": {
"$ref": "#/$defs/field-properties/@buttons"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"files": {
"$ref": "#/$defs/field-properties/@files"
},
"font": {
"default": "sans",
"enum": [
"sans",
"monospace"
]
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"textarea"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads"
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"notation": {
"default": 24,
"enum": [
12,
24
]
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"time"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"text": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"items": {
"$ref": "#/$defs/translated"
},
"type": "array"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggle"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"grow": {
"default": true,
"type": "boolean"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"labels": {
"default": true,
"type": "boolean"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"reset": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggles"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon",
"default": "url"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"url"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": true
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"users"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"inline": {
"default": false,
"type": "boolean"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"nodes": {
"$ref": "#/$defs/field-properties/@nodes"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"writer"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
},
"type": "array"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link"
]
},
"nodes": {
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"queryObject": {
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"textValuePair": {
"additionalProperties": false,
"properties": {
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"oneOf": [
{
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
{
"items": {
"$ref": "#/$defs/column"
},
"type": "array"
}
]
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | ce2929e401ff80b0447a5c6f0d7a2af37a646257 | 2023-04-03T10:03:03 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"blueprint": {
"enum": [
"file"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"page"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"site"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"user"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"required": [
"blueprint"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@buttons": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"enum": [
"headlines",
"italic",
"bold",
"link",
"email",
"file",
"code",
"ul",
"ol",
"|"
]
},
"type": "array"
}
]
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/booleanOrStringArrayUnique"
}
]
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@files": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/stringOrTranslated",
"description": "Optional help text below the field"
},
"@icon": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"enum": [
"account",
"add",
"alert",
"angle-down",
"angle-left",
"angle-right",
"angle-up",
"archive",
"attachment",
"audio",
"badge",
"bars",
"bell",
"blank",
"bold",
"bolt",
"book",
"bookmark",
"box",
"brush",
"bug",
"calendar",
"cancel",
"cancel-small",
"car",
"cart",
"chart",
"chat",
"check",
"circle",
"circle-filled",
"circle-half",
"circle-nested",
"circle-outline",
"clock",
"code",
"cog",
"collapse",
"copy",
"credit-card",
"crop",
"dashboard",
"discord",
"discount",
"display",
"divider",
"document",
"dots",
"download",
"draft",
"edit",
"email",
"expand",
"facebook",
"file",
"file-audio",
"file-code",
"file-document",
"file-image",
"file-spreadsheet",
"file-text",
"file-video",
"file-word",
"file-zip",
"filter",
"flag",
"folder",
"folder-structure",
"food",
"funnel",
"github",
"globe",
"grid",
"grid-bottom",
"grid-bottom-left",
"grid-bottom-right",
"grid-full",
"grid-left",
"grid-right",
"grid-top",
"grid-top-left",
"grid-top-right",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6",
"headline",
"heart",
"heart-outline",
"hidden",
"home",
"image",
"images",
"import",
"info",
"instagram",
"italic",
"key",
"layers",
"linkedin",
"list-bullet",
"list-numbers",
"live",
"loader",
"lock",
"logout",
"map",
"markdown",
"menu",
"mobile",
"money",
"moon",
"open",
"order-alpha-asc",
"order-alpha-desc",
"order-num-asc",
"order-num-desc",
"page",
"palette",
"paragraph",
"parent",
"paypal",
"pen",
"phone",
"pin",
"pinterest",
"pipette",
"play",
"preview",
"print",
"protected",
"qr-code",
"question",
"quote",
"refresh",
"remove",
"road-sign",
"search",
"server",
"settings",
"share",
"shuffle",
"sitemap",
"smile",
"sort",
"star",
"star-outline",
"store",
"strikethrough",
"sun",
"table",
"tablet",
"tag",
"template",
"text",
"text-center",
"text-justify",
"text-left",
"text-right",
"ticket",
"tiktok",
"title",
"toggle-off",
"toggle-on",
"trash",
"twitter",
"underline",
"undo",
"unlock",
"upload",
"url",
"user",
"users",
"video",
"vimeo",
"wand",
"whatsapp",
"wheelchair"
]
}
]
},
"@image": {
"description": "Image options to control the source and look of file previews",
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"color": {
"$ref": "#/$defs/nonEmptyString"
},
"cover": {
"type": "boolean"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"query": {
"$ref": "#/$defs/nonEmptyString"
},
"ratio": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/stringOrTranslated",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
},
"type": "array"
}
]
},
"@max": {
"type": "number"
},
"@maxlength": {
"type": "number"
},
"@min": {
"type": "number"
},
"@minlength": {
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@nodes": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/nodes"
},
"type": "array"
}
]
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
},
{
"items": {
"$ref": "#/$defs/objectWithStringValues"
},
"type": "array"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@separator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"object": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"object"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"subpages": {
"default": true,
"type": "boolean"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"pages"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"radio"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"tooltip": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"range"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"select"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"allow": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"path": {
"$ref": "#/$defs/nonEmptyString"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sync": {
"$ref": "#/$defs/nonEmptyString"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"slug"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
},
"wizard": {
"additionalProperties": false,
"properties": {
"field": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"duplicate": {
"default": true,
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"prepend": {
"default": true,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"structure"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"accept": {
"$ref": "#/$defs/nonEmptyString",
"default": "all"
},
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tags"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tel"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"buttons": {
"$ref": "#/$defs/field-properties/@buttons"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"files": {
"$ref": "#/$defs/field-properties/@files"
},
"font": {
"default": "sans",
"enum": [
"sans",
"monospace"
]
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"textarea"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads"
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"notation": {
"default": 24,
"enum": [
12,
24
]
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"time"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"text": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"items": {
"$ref": "#/$defs/translated"
},
"type": "array"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggle"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"grow": {
"default": true,
"type": "boolean"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"labels": {
"default": true,
"type": "boolean"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"reset": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggles"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon",
"default": "url"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"url"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": true
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"users"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"inline": {
"default": false,
"type": "boolean"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"nodes": {
"$ref": "#/$defs/field-properties/@nodes"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"writer"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
},
"type": "array"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link"
]
},
"nodes": {
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"queryObject": {
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"textValuePair": {
"additionalProperties": false,
"properties": {
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"oneOf": [
{
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
{
"items": {
"$ref": "#/$defs/column"
},
"type": "array"
}
]
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | a01e92420d536681517d741f344e56f5bd16b830 | 2022-07-04T22:54:11 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/columns"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
},
"type": {
"enum": [
"file"
]
}
},
"required": [
"type"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
},
"type": {
"enum": [
"page"
]
}
},
"required": [
"type"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/columns"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
},
"type": {
"enum": [
"site"
]
}
},
"required": [
"type"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/columns"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
},
"type": {
"enum": [
"user"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@buttons": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"enum": [
"headlines",
"italic",
"bold",
"link",
"email",
"file",
"code",
"ul",
"ol",
"|"
]
},
"type": "array"
}
]
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@files": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional help text below the field"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"$ref": "#/$defs/nonEmptyString",
"description": "Image options to control the source and look of file previews"
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/nonEmptyString",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
},
"type": "array"
}
]
},
"@max": {
"type": "number"
},
"@maxlength": {
"type": "number"
},
"@min": {
"type": "number"
},
"@minlength": {
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@nodes": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/nodes"
},
"type": "array"
}
]
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
},
{
"items": {
"$ref": "#/$defs/textValuePair"
},
"type": "array"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@separator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"subpages": {
"default": true,
"type": "boolean"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"pages"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"radio"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"tooltip": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"range"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"select"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"allow": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"path": {
"$ref": "#/$defs/nonEmptyString"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sync": {
"$ref": "#/$defs/nonEmptyString"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"slug"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
},
"wizard": {
"additionalProperties": false,
"properties": {
"field": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"duplicate": {
"default": true,
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"prepend": {
"default": true,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"structure"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"accept": {
"$ref": "#/$defs/nonEmptyString",
"default": "all"
},
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tags"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tel"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"buttons": {
"$ref": "#/$defs/field-properties/@buttons"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"files": {
"$ref": "#/$defs/field-properties/@files"
},
"font": {
"default": "sans",
"enum": [
"sans",
"monospace"
]
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"textarea"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads"
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"notation": {
"default": 24,
"enum": [
12,
24
]
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"time"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"text": {
"items": {
"$ref": "#/$defs/translated"
},
"type": "array"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggle"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"grow": {
"default": true,
"type": "boolean"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"labels": {
"default": true,
"type": "boolean"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"reset": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggles"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon",
"default": "url"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"url"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": true
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"users"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"inline": {
"default": false,
"type": "boolean"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"nodes": {
"$ref": "#/$defs/field-properties/@nodes"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"writer"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
},
"type": "array"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link"
]
},
"nodes": {
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"queryObject": {
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"textValuePair": {
"additionalProperties": false,
"properties": {
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | 06acf348e1df613af650b4997d9d728e6a94fbc8 | 2023-02-12T11:25:19 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"blueprint": {
"enum": [
"file"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"page"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"site"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"user"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"required": [
"blueprint"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@buttons": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"enum": [
"headlines",
"italic",
"bold",
"link",
"email",
"file",
"code",
"ul",
"ol",
"|"
]
},
"type": "array"
}
]
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/booleanOrStringArrayUnique"
}
]
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@files": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional help text below the field"
},
"@icon": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"enum": [
"account",
"add",
"alert",
"angle-down",
"angle-left",
"angle-right",
"angle-up",
"archive",
"attachment",
"audio",
"badge",
"bars",
"bell",
"blank",
"bold",
"bolt",
"book",
"bookmark",
"box",
"brush",
"bug",
"calendar",
"cancel",
"cancel-small",
"car",
"cart",
"chart",
"chat",
"check",
"circle",
"circle-filled",
"circle-half",
"circle-nested",
"circle-outline",
"clock",
"code",
"cog",
"collapse",
"copy",
"credit-card",
"crop",
"dashboard",
"discord",
"discount",
"display",
"divider",
"document",
"dots",
"download",
"draft",
"edit",
"email",
"expand",
"facebook",
"file",
"file-audio",
"file-code",
"file-document",
"file-image",
"file-spreadsheet",
"file-text",
"file-video",
"file-word",
"file-zip",
"filter",
"flag",
"folder",
"folder-structure",
"food",
"funnel",
"github",
"globe",
"grid",
"grid-bottom",
"grid-bottom-left",
"grid-bottom-right",
"grid-full",
"grid-left",
"grid-right",
"grid-top",
"grid-top-left",
"grid-top-right",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6",
"headline",
"heart",
"heart-outline",
"hidden",
"home",
"image",
"images",
"import",
"info",
"instagram",
"italic",
"key",
"layers",
"linkedin",
"list-bullet",
"list-numbers",
"live",
"loader",
"lock",
"logout",
"map",
"markdown",
"menu",
"mobile",
"money",
"moon",
"open",
"order-alpha-asc",
"order-alpha-desc",
"order-num-asc",
"order-num-desc",
"page",
"palette",
"paragraph",
"parent",
"paypal",
"pen",
"phone",
"pin",
"pinterest",
"pipette",
"play",
"preview",
"print",
"protected",
"qr-code",
"question",
"quote",
"refresh",
"remove",
"road-sign",
"search",
"server",
"settings",
"share",
"shuffle",
"sitemap",
"smile",
"sort",
"star",
"star-outline",
"store",
"strikethrough",
"sun",
"table",
"tablet",
"tag",
"template",
"text",
"text-center",
"text-justify",
"text-left",
"text-right",
"ticket",
"tiktok",
"title",
"toggle-off",
"toggle-on",
"trash",
"twitter",
"underline",
"undo",
"unlock",
"upload",
"url",
"user",
"users",
"video",
"vimeo",
"wand",
"whatsapp",
"wheelchair"
]
}
]
},
"@image": {
"description": "Image options to control the source and look of file previews",
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"color": {
"$ref": "#/$defs/nonEmptyString"
},
"cover": {
"type": "boolean"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"query": {
"$ref": "#/$defs/nonEmptyString"
},
"ratio": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/nonEmptyString",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
},
"type": "array"
}
]
},
"@max": {
"type": "number"
},
"@maxlength": {
"type": "number"
},
"@min": {
"type": "number"
},
"@minlength": {
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@nodes": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/nodes"
},
"type": "array"
}
]
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
},
{
"items": {
"$ref": "#/$defs/objectWithStringValues"
},
"type": "array"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@separator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"object": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"object"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"subpages": {
"default": true,
"type": "boolean"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"pages"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"radio"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"tooltip": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"range"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"select"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"allow": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"path": {
"$ref": "#/$defs/nonEmptyString"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sync": {
"$ref": "#/$defs/nonEmptyString"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"slug"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
},
"wizard": {
"additionalProperties": false,
"properties": {
"field": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"duplicate": {
"default": true,
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"prepend": {
"default": true,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"structure"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"accept": {
"$ref": "#/$defs/nonEmptyString",
"default": "all"
},
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tags"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tel"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"buttons": {
"$ref": "#/$defs/field-properties/@buttons"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"files": {
"$ref": "#/$defs/field-properties/@files"
},
"font": {
"default": "sans",
"enum": [
"sans",
"monospace"
]
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"textarea"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads"
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"notation": {
"default": 24,
"enum": [
12,
24
]
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"time"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"text": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"items": {
"$ref": "#/$defs/translated"
},
"type": "array"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggle"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"grow": {
"default": true,
"type": "boolean"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"labels": {
"default": true,
"type": "boolean"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"reset": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggles"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon",
"default": "url"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"url"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": true
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"users"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"inline": {
"default": false,
"type": "boolean"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"nodes": {
"$ref": "#/$defs/field-properties/@nodes"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"writer"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
},
"type": "array"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link"
]
},
"nodes": {
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"queryObject": {
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"textValuePair": {
"additionalProperties": false,
"properties": {
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"oneOf": [
{
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
{
"items": {
"$ref": "#/$defs/column"
},
"type": "array"
}
]
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | fee52cd992420d139e90947e9e1b8064f81a79ce | 2023-04-03T10:08:37 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"blueprint": {
"enum": [
"file"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"page"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"site"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"user"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"required": [
"blueprint"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@buttons": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"enum": [
"headlines",
"italic",
"bold",
"link",
"email",
"file",
"code",
"ul",
"ol",
"|"
]
},
"type": "array"
}
]
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/booleanOrStringArrayUnique"
}
]
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@files": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional help text below the field"
},
"@icon": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"enum": [
"account",
"add",
"alert",
"angle-down",
"angle-left",
"angle-right",
"angle-up",
"archive",
"attachment",
"audio",
"badge",
"bars",
"bell",
"blank",
"bold",
"bolt",
"book",
"bookmark",
"box",
"brush",
"bug",
"calendar",
"cancel",
"cancel-small",
"car",
"cart",
"chart",
"chat",
"check",
"circle",
"circle-filled",
"circle-half",
"circle-nested",
"circle-outline",
"clock",
"code",
"cog",
"collapse",
"copy",
"credit-card",
"crop",
"dashboard",
"discord",
"discount",
"display",
"divider",
"document",
"dots",
"download",
"draft",
"edit",
"email",
"expand",
"facebook",
"file",
"file-audio",
"file-code",
"file-document",
"file-image",
"file-spreadsheet",
"file-text",
"file-video",
"file-word",
"file-zip",
"filter",
"flag",
"folder",
"folder-structure",
"food",
"funnel",
"github",
"globe",
"grid",
"grid-bottom",
"grid-bottom-left",
"grid-bottom-right",
"grid-full",
"grid-left",
"grid-right",
"grid-top",
"grid-top-left",
"grid-top-right",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6",
"headline",
"heart",
"heart-outline",
"hidden",
"home",
"image",
"images",
"import",
"info",
"instagram",
"italic",
"key",
"layers",
"linkedin",
"list-bullet",
"list-numbers",
"live",
"loader",
"lock",
"logout",
"map",
"markdown",
"menu",
"mobile",
"money",
"moon",
"open",
"order-alpha-asc",
"order-alpha-desc",
"order-num-asc",
"order-num-desc",
"page",
"palette",
"paragraph",
"parent",
"paypal",
"pen",
"phone",
"pin",
"pinterest",
"pipette",
"play",
"preview",
"print",
"protected",
"qr-code",
"question",
"quote",
"refresh",
"remove",
"road-sign",
"search",
"server",
"settings",
"share",
"shuffle",
"sitemap",
"smile",
"sort",
"star",
"star-outline",
"store",
"strikethrough",
"sun",
"table",
"tablet",
"tag",
"template",
"text",
"text-center",
"text-justify",
"text-left",
"text-right",
"ticket",
"tiktok",
"title",
"toggle-off",
"toggle-on",
"trash",
"twitter",
"underline",
"undo",
"unlock",
"upload",
"url",
"user",
"users",
"video",
"vimeo",
"wand",
"whatsapp",
"wheelchair"
]
}
]
},
"@image": {
"description": "Image options to control the source and look of file previews",
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"color": {
"$ref": "#/$defs/nonEmptyString"
},
"cover": {
"type": "boolean"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"query": {
"$ref": "#/$defs/nonEmptyString"
},
"ratio": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/stringOrTranslated",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
},
"type": "array"
}
]
},
"@max": {
"type": "number"
},
"@maxlength": {
"type": "number"
},
"@min": {
"type": "number"
},
"@minlength": {
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@nodes": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/nodes"
},
"type": "array"
}
]
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
},
{
"items": {
"$ref": "#/$defs/objectWithStringValues"
},
"type": "array"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@separator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"object": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"object"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"subpages": {
"default": true,
"type": "boolean"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"pages"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"radio"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"tooltip": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"range"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"select"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"allow": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"path": {
"$ref": "#/$defs/nonEmptyString"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sync": {
"$ref": "#/$defs/nonEmptyString"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"slug"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
},
"wizard": {
"additionalProperties": false,
"properties": {
"field": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"duplicate": {
"default": true,
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"prepend": {
"default": true,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"structure"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"accept": {
"$ref": "#/$defs/nonEmptyString",
"default": "all"
},
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tags"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tel"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"buttons": {
"$ref": "#/$defs/field-properties/@buttons"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"files": {
"$ref": "#/$defs/field-properties/@files"
},
"font": {
"default": "sans",
"enum": [
"sans",
"monospace"
]
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"textarea"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads"
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"notation": {
"default": 24,
"enum": [
12,
24
]
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"time"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"text": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"items": {
"$ref": "#/$defs/translated"
},
"type": "array"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggle"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"grow": {
"default": true,
"type": "boolean"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"labels": {
"default": true,
"type": "boolean"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"reset": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggles"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon",
"default": "url"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"url"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": true
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"users"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"inline": {
"default": false,
"type": "boolean"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"nodes": {
"$ref": "#/$defs/field-properties/@nodes"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"writer"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
},
"type": "array"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link",
"email"
]
},
"nodes": {
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"queryObject": {
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"textValuePair": {
"additionalProperties": false,
"properties": {
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"oneOf": [
{
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
{
"items": {
"$ref": "#/$defs/column"
},
"type": "array"
}
]
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | 5fa682aa8034d467c2fb8572216eacb1e03dd0fc | 2022-07-04T23:07:31 | kirby3-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/columns"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
},
"type": {
"enum": [
"file"
]
}
},
"required": [
"type"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
},
"type": {
"enum": [
"page"
]
}
},
"required": [
"type"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/columns"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
},
"type": {
"enum": [
"site"
]
}
},
"required": [
"type"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/columns"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
},
"type": {
"enum": [
"user"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@buttons": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"enum": [
"headlines",
"italic",
"bold",
"link",
"email",
"file",
"code",
"ul",
"ol",
"|"
]
},
"type": "array"
}
]
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/booleanOrStringArrayUnique"
}
]
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@files": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional help text below the field"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"description": "Image options to control the source and look of file previews",
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"cover": {
"type": "boolean"
},
"ratio": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/nonEmptyString",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
},
"type": "array"
}
]
},
"@max": {
"type": "number"
},
"@maxlength": {
"type": "number"
},
"@min": {
"type": "number"
},
"@minlength": {
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@nodes": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/nodes"
},
"type": "array"
}
]
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
},
{
"items": {
"$ref": "#/$defs/textValuePair"
},
"type": "array"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@separator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"subpages": {
"default": true,
"type": "boolean"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"pages"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"radio"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"tooltip": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"range"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"select"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"allow": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"path": {
"$ref": "#/$defs/nonEmptyString"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sync": {
"$ref": "#/$defs/nonEmptyString"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"slug"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
},
"wizard": {
"additionalProperties": false,
"properties": {
"field": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"duplicate": {
"default": true,
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"prepend": {
"default": true,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"structure"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"accept": {
"$ref": "#/$defs/nonEmptyString",
"default": "all"
},
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tags"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tel"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"buttons": {
"$ref": "#/$defs/field-properties/@buttons"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"files": {
"$ref": "#/$defs/field-properties/@files"
},
"font": {
"default": "sans",
"enum": [
"sans",
"monospace"
]
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"textarea"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads"
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"notation": {
"default": 24,
"enum": [
12,
24
]
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"time"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"text": {
"items": {
"$ref": "#/$defs/translated"
},
"type": "array"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggle"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"grow": {
"default": true,
"type": "boolean"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"labels": {
"default": true,
"type": "boolean"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"reset": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggles"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon",
"default": "url"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"url"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": true
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"users"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"inline": {
"default": false,
"type": "boolean"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"nodes": {
"$ref": "#/$defs/field-properties/@nodes"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"writer"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
},
"type": "array"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link"
]
},
"nodes": {
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"queryObject": {
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"label": {
"$ref": "#/$defs/nonEmptyString"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"textValuePair": {
"additionalProperties": false,
"properties": {
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"oneOf": [
{
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
{
"items": {
"$ref": "#/$defs/column"
},
"type": "array"
}
]
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
bnomei/kirby3-schema | 5b091e2332ef05ac46da37f1c884162cdc914701 | 2023-11-28T14:16:39 | kirby4-blueprints.schema.json | 37 | 2024-05-27T05:43:57.021867Z | {
"$defs": {
"arrayOrBooleanOrNumberOrObjectOrString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"blueprint-properties": {
"@create": {
"properties": {
"fields": {
"$ref": "#/$defs/stringArrayUnique"
},
"redirect": {
"default": true,
"type": "boolean"
},
"status": {
"default": "draft",
"enum": [
"draft",
"unlisted",
"listed"
]
},
"title": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@description": {
"$ref": "#/$defs/stringOrTranslated"
},
"@home": {
"$ref": "#/$defs/nonEmptyString"
},
"@icon": {
"$ref": "#/$defs/nonEmptyString"
},
"@image": {
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
}
},
"type": "object"
},
"@navigation": {
"properties": {
"sortBy": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"status": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"template": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
},
"@num": {
"$ref": "#/$defs/nonEmptyString",
"default": "zero"
},
"@options": {
"properties": {
"changeName": {
"$ref": "#/$defs/booleanOrObject"
},
"changeSlug": {
"$ref": "#/$defs/booleanOrObject"
},
"changeStatus": {
"$ref": "#/$defs/booleanOrObject"
},
"changeTemplate": {
"$ref": "#/$defs/booleanOrStringArrayUnique"
},
"changeTitle": {
"$ref": "#/$defs/booleanOrObject"
},
"delete": {
"$ref": "#/$defs/booleanOrObject"
},
"duplicate": {
"$ref": "#/$defs/booleanOrObject"
},
"preview": {
"$ref": "#/$defs/booleanOrString"
},
"read": {
"$ref": "#/$defs/booleanOrObject"
},
"replace": {
"$ref": "#/$defs/booleanOrObject"
},
"update": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@permissions": {
"properties": {
"access": {
"$ref": "#/$defs/booleanOrObject"
},
"files": {
"$ref": "#/$defs/booleanOrObject"
},
"pages": {
"$ref": "#/$defs/booleanOrObject"
},
"site": {
"$ref": "#/$defs/booleanOrObject"
},
"user": {
"$ref": "#/$defs/booleanOrObject"
},
"users": {
"$ref": "#/$defs/booleanOrObject"
}
},
"type": "object"
},
"@preset": {
"enum": [
"files",
"page",
"pages"
]
},
"@reports": {
"items": {
"$ref": "#/$defs/report"
},
"minItems": 1,
"type": "array"
},
"@status": {
"properties": {
"draft": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"listed": {
"$ref": "#/$defs/stringOrLabelAndText"
},
"unlisted": {
"$ref": "#/$defs/stringOrLabelAndText"
}
},
"type": "object"
},
"@title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"blueprints": {
"file": {
"additionalProperties": false,
"properties": {
"accept": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"properties": {
"extension": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"maxheight": {
"$ref": "#/$defs/numberInPixel"
},
"maxsize": {
"$ref": "#/$defs/numberInBytes"
},
"maxwidth": {
"$ref": "#/$defs/numberInPixel"
},
"mime ": {
"$ref": "#/$defs/stringOrStringArrayUnique"
},
"minheight": {
"$ref": "#/$defs/numberInPixel"
},
"minsize": {
"$ref": "#/$defs/numberInBytes"
},
"minwidth": {
"$ref": "#/$defs/numberInPixel"
},
"orientation": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"$ref": "#/$defs/stringOrStringArrayUnique"
}
},
"type": "object"
}
]
},
"blueprint": {
"enum": [
"file"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"focus": {
"default": true,
"type": "boolean"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"page": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"page"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"create": {
"$ref": "#/$defs/blueprint-properties/@create"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"navigation": {
"$ref": "#/$defs/blueprint-properties/@navigation"
},
"num": {
"$ref": "#/$defs/blueprint-properties/@num"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"preset": {
"$ref": "#/$defs/blueprint-properties/@preset"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"status": {
"$ref": "#/$defs/blueprint-properties/@status"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"site": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"site"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/blueprint-properties/@title"
}
},
"required": [
"blueprint"
],
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"user"
]
},
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"description": {
"$ref": "#/$defs/stringOrTranslated"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"home": {
"$ref": "#/$defs/blueprint-properties/@home"
},
"image": {
"$ref": "#/$defs/blueprint-properties/@image"
},
"options": {
"$ref": "#/$defs/blueprint-properties/@options"
},
"permissions": {
"$ref": "#/$defs/blueprint-properties/@permissions"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"tabs": {
"$ref": "#/$defs/wrappers/tabs"
},
"title": {
"$ref": "#/$defs/stringOrTranslated"
}
},
"required": [
"blueprint"
],
"type": "object"
}
},
"booleanOrObject": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"booleanOrString": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"booleanOrStringArrayUnique": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"column": {
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
},
"sticky": {
"default": false,
"type": "boolean"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"required": [
"width"
]
},
"field": {
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
}
},
"type": "object"
},
"field-properties": {
"@after": {
"$ref": "#/$defs/nonEmptyString"
},
"@align": {
"default": "left",
"enum": [
"left",
"center",
"right"
]
},
"@api": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@autocomplete": {
"$ref": "#/$defs/nonEmptyString"
},
"@autofocus": {
"type": "boolean"
},
"@before": {
"$ref": "#/$defs/nonEmptyString"
},
"@buttons": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"enum": [
"headlines",
"italic",
"bold",
"link",
"email",
"file",
"code",
"ul",
"ol",
"|"
]
},
"type": "array"
}
]
},
"@columns": {
"patternProperties": {
".*": {
"properties": {
"align": {
"$ref": "#/$defs/field-properties/@align"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
},
"width": {
"$ref": "#/$defs/fraction"
}
},
"type": "object"
}
},
"type": "object"
},
"@converter": {
"enum": [
"lower",
"upper",
"ucfirst",
"slug"
]
},
"@counter": {
"type": "boolean"
},
"@create": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/booleanOrStringArrayUnique"
}
]
},
"@default": {
"$ref": "#/$defs/arrayOrBooleanOrNumberOrObjectOrString",
"description": "Default value for the field, which will be used when a page/file/user is created"
},
"@disabled": {
"type": "boolean"
},
"@empty": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the text for the empty state box"
},
"@extends": {
"$ref": "#/$defs/nonEmptyString"
},
"@fieldsets": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/fieldsetsGroup"
}
},
"type": "object"
}
]
},
"@files": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
}
},
"type": "object"
}
]
},
"@flip": {
"description": "Enables/disables reverse sorting",
"type": "boolean"
},
"@headline": {
"$ref": "#/$defs/nonEmptyString"
},
"@help": {
"$ref": "#/$defs/stringOrTranslated",
"description": "Optional help text below the field"
},
"@icon": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"enum": [
"account",
"add",
"alert",
"anchor",
"angle-down",
"angle-left",
"angle-right",
"angle-up",
"archive",
"attachment",
"audio",
"badge",
"bars",
"bell",
"blank",
"bold",
"bolt",
"book",
"bookmark",
"box",
"bug",
"brush",
"calendar",
"cancel",
"cancel-small",
"car",
"cart",
"chart",
"chat",
"check",
"checklist",
"circle",
"circle-filled",
"circle-filled",
"circle-half",
"circle-nested",
"circle-outline",
"clear",
"clock",
"code",
"cog",
"collapse",
"copy",
"credit-card",
"crop",
"dashboard",
"discord",
"discount",
"display",
"divider",
"document",
"dots",
"download",
"draft",
"edit",
"editv",
"email",
"expand",
"facebook",
"file",
"file-audio",
"file-code",
"file-document",
"file-image",
"file-spreadsheet",
"file-text",
"file-video",
"file-word",
"file-zip",
"filter",
"flag",
"folder",
"folder-structure",
"food",
"funnel",
"github",
"globe",
"grid",
"grid-bottom",
"grid-bottom-left",
"grid-bottom-right",
"grid-full",
"grid-left",
"grid-right",
"grid-top",
"grid-top-left",
"grid-top-right",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6",
"headline",
"heart",
"heart-filled",
"heart-outline",
"hidden",
"home",
"image",
"images",
"import",
"info",
"instagram",
"italic",
"key",
"layers",
"linkedin",
"list-bullet",
"list-numbers",
"live",
"loader",
"lock",
"logout",
"map",
"markdown",
"mastodon",
"megaphone",
"menu",
"merge",
"mobile",
"money",
"moon",
"open",
"order-alpha-asc",
"order-alpha-desc",
"order-num-asc",
"order-num-desc",
"page",
"palette",
"paragraph",
"parent",
"paypal",
"pen",
"phone",
"pin",
"pinterest",
"pipette",
"plane",
"play",
"plus",
"preview",
"print",
"protected",
"qr-code",
"question",
"quote",
"refresh",
"remove",
"search",
"server",
"settings",
"share",
"shuffle",
"sitemap",
"smile",
"sort",
"sparkling",
"split",
"star",
"star-filled",
"star-outline",
"status-draft",
"status-unlisted",
"status-listed",
"store",
"strikethrough",
"sun",
"subscript",
"superscript",
"table",
"tablet",
"tag",
"template",
"text",
"text-center",
"text-justify",
"text-left",
"text-right",
"ticket",
"tiktok",
"title",
"toggle-off",
"toggle-on",
"trash",
"underline",
"undo",
"unlock",
"upload",
"url",
"user",
"users",
"video",
"vimeo",
"wand",
"whatsapp",
"wheelchair",
"youtube"
]
}
]
},
"@image": {
"description": "Image options to control the source and look of file previews",
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"back": {
"$ref": "#/$defs/nonEmptyString"
},
"color": {
"$ref": "#/$defs/nonEmptyString"
},
"cover": {
"type": "boolean"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"query": {
"$ref": "#/$defs/nonEmptyString"
},
"ratio": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@info": {
"$ref": "#/$defs/nonEmptyString",
"description": "Optional info text setup"
},
"@label": {
"$ref": "#/$defs/stringOrTranslated",
"description": "label is the new official replacement for headline"
},
"@layout": {
"$ref": "#/$defs/nonEmptyString",
"description": "Section layout"
},
"@limit": {
"description": "Sets the number of items per page",
"exclusiveMinimum": 0,
"type": "number"
},
"@link": {
"type": "boolean"
},
"@linkUrl": {
"$ref": "#/$defs/nonEmptyString"
},
"@marks": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/marks"
},
"type": "array"
}
]
},
"@max": {
"type": "number"
},
"@maxlength": {
"type": "number"
},
"@min": {
"type": "number"
},
"@minlength": {
"type": "number"
},
"@multiple": {
"description": "If false, only a single one can be selected",
"type": "boolean"
},
"@nodes": {
"oneOf": [
{
"type": "boolean"
},
{
"items": {
"$ref": "#/$defs/nodes"
},
"type": "array"
}
]
},
"@options": {
"oneOf": [
{
"$ref": "#/$defs/stringOrStringArrayUnique"
},
{
"$ref": "#/$defs/objectWithStringValues"
},
{
"items": {
"$ref": "#/$defs/objectWithStringValues"
},
"type": "array"
}
]
},
"@page": {
"description": "Sets the default page for the pagination",
"exclusiveMinimum": 0,
"type": "number"
},
"@parent": {
"$ref": "#/$defs/nonEmptyString",
"description": "Sets the query to a parent to find items for the list"
},
"@pattern": {
"$ref": "#/$defs/nonEmptyString",
"description": "A regular expression, which will be used to validate the input"
},
"@placeholder": {
"$ref": "#/$defs/nonEmptyString"
},
"@query": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/queryObject"
}
]
},
"@required": {
"type": "boolean"
},
"@search": {
"type": "boolean"
},
"@separator": {
"$ref": "#/$defs/nonEmptyString"
},
"@size": {
"description": "The size option controls the size of cards",
"enum": [
"tiny",
"small",
"medium",
"large",
"huge"
]
},
"@sort": {
"type": "boolean"
},
"@sortBy": {
"$ref": "#/$defs/nonEmptyString",
"description": "Overwrites manual sorting and sorts by the given field and sorting direction"
},
"@sortable": {
"description": "Enables/disables manual sorting",
"type": "boolean"
},
"@spellcheck": {
"type": "boolean"
},
"@status": {
"enum": [
"draft",
"unlisted",
"listed",
"published",
"all"
]
},
"@step": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/$defs/nonEmptyString"
}
]
},
"@template": {
"$ref": "#/$defs/nonEmptyString",
"description": "Filters all files by template and also sets the template, which will be used for all uploads"
},
"@templates": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"@text": {
"$ref": "#/$defs/nonEmptyString",
"description": "Setup for the main text in the list or cards"
},
"@theme": {
"enum": [
"none",
"positive",
"info",
"negative"
]
},
"@translate": {
"type": "boolean"
},
"@uploads": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"parent": {
"$ref": "#/$defs/nonEmptyString"
},
"template": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"@value": {
"$ref": "#/$defs/stringOrNumber"
},
"@when": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/objectWithStringValues"
}
]
},
"@width": {
"default": "1/1",
"enum": [
"1/1",
"1/2",
"1/3",
"1/4",
"2/3",
"3/4"
]
}
},
"fields": {
"blocks": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"pretty": {
"default": false,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"blocks"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"checkboxes": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"checkboxes"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"date": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"calendar": {
"default": false,
"type": "boolean"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"time": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"step": {
"$ref": "#/$defs/field-properties/@step"
}
},
"type": "object"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"date"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"email": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete",
"default": "email"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"email"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": false
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"files"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads",
"default": []
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"gap": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"gap"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"headline": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"numbered": {
"type": "boolean"
},
"type": {
"enum": [
"headline"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"hidden": {
"additionalProperties": false,
"properties": {
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"hidden"
]
}
},
"required": [
"type"
]
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"type": {
"enum": [
"info"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"layout": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fieldsets": {
"$ref": "#/$defs/field-properties/@fieldsets"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layouts": {
"$ref": "#/$defs/stringArrayUnique"
},
"settings": {
"description": "--- TODO ---",
"type": "object"
},
"type": {
"enum": [
"layout"
]
}
},
"required": [
"type"
]
},
"line": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"type": {
"enum": [
"line"
]
}
},
"required": [
"type"
]
},
"list": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"list"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"multiselect": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"sort": {
"$ref": "#/$defs/field-properties/@sort",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"multiselect"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"number": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"number"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"object": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"object"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"subpages": {
"default": true,
"type": "boolean"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"pages"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"radio": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"default": 1,
"type": "number"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"radio"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"range": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"tooltip": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"range"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"select": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"select"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"slug": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"allow": {
"$ref": "#/$defs/nonEmptyString"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"path": {
"$ref": "#/$defs/nonEmptyString"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sync": {
"$ref": "#/$defs/nonEmptyString"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"slug"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
},
"wizard": {
"additionalProperties": false,
"properties": {
"field": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
},
"required": [
"type"
]
},
"structure": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"duplicate": {
"default": true,
"type": "boolean"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"prepend": {
"default": true,
"type": "boolean"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"structure"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tags": {
"additionalProperties": false,
"properties": {
"accept": {
"$ref": "#/$defs/nonEmptyString",
"default": "all"
},
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"separator": {
"$ref": "#/$defs/field-properties/@separator",
"default": ","
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tags"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"tel": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"tel"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"text": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"converter": {
"$ref": "#/$defs/field-properties/@converter"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"text"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"textarea": {
"additionalProperties": false,
"properties": {
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"buttons": {
"$ref": "#/$defs/field-properties/@buttons"
},
"counter": {
"$ref": "#/$defs/field-properties/@counter",
"default": true
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"files": {
"$ref": "#/$defs/field-properties/@files"
},
"font": {
"default": "sans",
"enum": [
"sans",
"monospace"
]
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"size": {
"$ref": "#/$defs/field-properties/@size"
},
"spellcheck": {
"$ref": "#/$defs/field-properties/@spellcheck",
"default": false
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"textarea"
]
},
"uploads": {
"$ref": "#/$defs/field-properties/@uploads"
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"time": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"display": {
"$ref": "#/$defs/nonEmptyString"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"format": {
"$ref": "#/$defs/nonEmptyString"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"notation": {
"default": 24,
"enum": [
12,
24
]
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"step": {
"$ref": "#/$defs/field-properties/@step"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"time"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggle": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"text": {
"oneOf": [
{
"$ref": "#/$defs/stringArrayUnique"
},
{
"items": {
"$ref": "#/$defs/translated"
},
"type": "array"
}
]
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggle"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"toggles": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/field-properties/@api"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"grow": {
"default": true,
"type": "boolean"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"labels": {
"default": true,
"type": "boolean"
},
"options": {
"$ref": "#/$defs/field-properties/@options"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required",
"default": false
},
"reset": {
"default": true,
"type": "boolean"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"toggles"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"url": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autocomplete": {
"$ref": "#/$defs/field-properties/@autocomplete"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon",
"default": "url"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"maxlength": {
"$ref": "#/$defs/field-properties/@maxlength"
},
"minlength": {
"$ref": "#/$defs/field-properties/@minlength"
},
"pattern": {
"$ref": "#/$defs/field-properties/@pattern"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"url"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
},
"users": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout"
},
"link": {
"$ref": "#/$defs/field-properties/@link"
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"multiple": {
"$ref": "#/$defs/field-properties/@multiple",
"default": true
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"search": {
"$ref": "#/$defs/field-properties/@search",
"default": true
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"users"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width",
"default": "1/1"
}
},
"required": [
"type"
]
},
"writer": {
"additionalProperties": false,
"properties": {
"after": {
"$ref": "#/$defs/field-properties/@after"
},
"autofocus": {
"$ref": "#/$defs/field-properties/@autofocus"
},
"before": {
"$ref": "#/$defs/field-properties/@before"
},
"blueprint": {
"enum": [
"field"
]
},
"default": {
"$ref": "#/$defs/field-properties/@default"
},
"disabled": {
"$ref": "#/$defs/field-properties/@disabled"
},
"extends": {
"$ref": "#/$defs/field-properties/@extends"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"icon": {
"$ref": "#/$defs/field-properties/@icon"
},
"inline": {
"default": false,
"type": "boolean"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"marks": {
"$ref": "#/$defs/field-properties/@marks"
},
"nodes": {
"$ref": "#/$defs/field-properties/@nodes"
},
"placeholder": {
"$ref": "#/$defs/field-properties/@placeholder"
},
"required": {
"$ref": "#/$defs/field-properties/@required"
},
"translate": {
"$ref": "#/$defs/field-properties/@translate",
"default": true
},
"type": {
"enum": [
"writer"
]
},
"when": {
"$ref": "#/$defs/field-properties/@when"
},
"width": {
"$ref": "#/$defs/field-properties/@width"
}
},
"required": [
"type"
]
}
},
"fieldsetsGroup": {
"additionalProperties": false,
"properties": {
"fieldsets": {
"items": {
"$ref": "#/$defs/fieldsetsItem"
},
"type": "array"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"open": {
"default": true,
"type": "boolean"
},
"type": {
"enum": [
"group"
]
}
},
"required": [
"type"
],
"type": "object"
},
"fieldsetsItem": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"patternProperties": {
".*": {
"items": {
"properties": {
"content": {
"type": "object"
},
"type": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
"fraction": {
"$ref": "#/$defs/nonEmptyString"
},
"marks": {
"enum": [
"bold",
"italic",
"underline",
"strike",
"code",
"link",
"email",
"sub",
"sup",
"clear"
]
},
"nodes": {
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"nonEmptyString": {
"minLength": 1,
"type": "string"
},
"notRequiredNonEmptyString": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "null"
}
]
},
"numberInBytes": {
"description": "in bytes",
"exclusiveMinimum": 0,
"type": "number"
},
"numberInPixel": {
"description": "in px",
"exclusiveMinimum": 0,
"type": "number"
},
"objectWithStringValues": {
"patternProperties": {
".*": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"queryObject": {
"additionalProperties": false,
"properties": {
"fetch": {
"$ref": "#/$defs/nonEmptyString"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"url": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"report": {
"additionalProperties": false,
"properties": {
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"link": {
"$ref": "#/$defs/field-properties/@linkUrl"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme"
},
"value": {
"$ref": "#/$defs/field-properties/@value"
}
},
"type": "object"
},
"section": {
"properties": {
"sec-label": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"sections": {
"fields": {
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"type": {
"enum": [
"fields"
]
}
},
"required": [
"type",
"fields"
],
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"files"
]
}
},
"required": [
"type"
],
"type": "object"
},
"info": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/field-properties/@text"
},
"theme": {
"$ref": "#/$defs/field-properties/@theme",
"default": "info"
},
"type": {
"enum": [
"info"
]
}
},
"required": [
"type"
],
"type": "object"
},
"pages": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"columns": {
"$ref": "#/$defs/field-properties/@columns"
},
"create": {
"$ref": "#/$defs/field-properties/@create"
},
"empty": {
"$ref": "#/$defs/field-properties/@empty"
},
"flip": {
"$ref": "#/$defs/field-properties/@flip",
"default": false
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"help": {
"$ref": "#/$defs/field-properties/@help"
},
"image": {
"$ref": "#/$defs/field-properties/@image"
},
"info": {
"$ref": "#/$defs/field-properties/@info"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"layout": {
"$ref": "#/$defs/field-properties/@layout",
"default": "list"
},
"limit": {
"$ref": "#/$defs/field-properties/@limit",
"default": 20
},
"max": {
"$ref": "#/$defs/field-properties/@max"
},
"min": {
"$ref": "#/$defs/field-properties/@min"
},
"page": {
"$ref": "#/$defs/field-properties/@page"
},
"parent": {
"$ref": "#/$defs/field-properties/@parent"
},
"query": {
"$ref": "#/$defs/field-properties/@query"
},
"search": {
"$ref": "#/$defs/field-properties/@search"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "auto"
},
"sortBy": {
"$ref": "#/$defs/field-properties/@sortBy"
},
"sortable": {
"$ref": "#/$defs/field-properties/@sortable",
"default": true
},
"status": {
"$ref": "#/$defs/field-properties/@status"
},
"template": {
"$ref": "#/$defs/field-properties/@template"
},
"templates": {
"$ref": "#/$defs/field-properties/@templates"
},
"templatesIgnore": {
"$ref": "#/$defs/field-properties/@templates"
},
"text": {
"$ref": "#/$defs/nonEmptyString",
"default": "'{{ page.title }}'"
},
"type": {
"enum": [
"pages"
]
}
},
"required": [
"type"
],
"type": "object"
},
"stats": {
"additionalProperties": false,
"properties": {
"blueprint": {
"enum": [
"section"
]
},
"headline": {
"$ref": "#/$defs/field-properties/@headline"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"reports": {
"$ref": "#/$defs/blueprint-properties/@reports"
},
"size": {
"$ref": "#/$defs/field-properties/@size",
"default": "large"
},
"type": {
"enum": [
"stats"
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"stringArrayUnique": {
"items": {
"$ref": "#/$defs/nonEmptyString"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stringOrLabelAndText": {
"oneOf": [
{
"$ref": "#/$defs/booleanOrString"
},
{
"properties": {
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"text": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
}
]
},
"stringOrNumber": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"type": "number"
}
]
},
"stringOrStringArrayUnique": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/stringArrayUnique"
}
]
},
"stringOrTranslated": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString"
},
{
"$ref": "#/$defs/translated"
}
]
},
"tab": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/wrappers/fields"
},
{
"$ref": "#/$defs/wrappers/sections"
},
{
"$ref": "#/$defs/wrappers/columns"
}
]
}
},
"properties": {
"columns": {
"$ref": "#/$defs/wrappers/columns"
},
"fields": {
"$ref": "#/$defs/wrappers/fields"
},
"icon": {
"$ref": "#/$defs/blueprint-properties/@icon"
},
"label": {
"$ref": "#/$defs/field-properties/@label"
},
"sections": {
"$ref": "#/$defs/wrappers/sections"
}
},
"type": "object"
},
"textValuePair": {
"additionalProperties": false,
"properties": {
"text": {
"$ref": "#/$defs/nonEmptyString"
},
"value": {
"$ref": "#/$defs/nonEmptyString"
}
},
"type": "object"
},
"translated": {
"patternProperties": {
"[a-z]{2}": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString"
}
]
}
},
"type": "object"
},
"wrappers": {
"columns": {
"oneOf": [
{
"patternProperties": {
".*": {
"$ref": "#/$defs/column"
}
},
"type": "object"
},
{
"items": {
"$ref": "#/$defs/column"
},
"type": "array"
}
]
},
"fields": {
"patternProperties": {
".*": {
"anyOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
}
]
}
},
"type": "object"
},
"sections": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#/$defs/nonEmptyString",
"description": "shorthand version of extends property"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
}
]
}
},
"type": "object"
},
"tabs": {
"patternProperties": {
".*": {
"$ref": "#/$defs/tab"
}
},
"type": "object"
}
}
},
"$id": "https://getkirby.com/schema/blueprints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"$ref": "#/$defs/fields/blocks"
},
{
"$ref": "#/$defs/fields/checkboxes"
},
{
"$ref": "#/$defs/fields/date"
},
{
"$ref": "#/$defs/fields/email"
},
{
"$ref": "#/$defs/fields/files"
},
{
"$ref": "#/$defs/fields/gap"
},
{
"$ref": "#/$defs/fields/headline"
},
{
"$ref": "#/$defs/fields/hidden"
},
{
"$ref": "#/$defs/fields/info"
},
{
"$ref": "#/$defs/fields/layout"
},
{
"$ref": "#/$defs/fields/line"
},
{
"$ref": "#/$defs/fields/list"
},
{
"$ref": "#/$defs/fields/multiselect"
},
{
"$ref": "#/$defs/fields/number"
},
{
"$ref": "#/$defs/fields/object"
},
{
"$ref": "#/$defs/fields/pages"
},
{
"$ref": "#/$defs/fields/radio"
},
{
"$ref": "#/$defs/fields/range"
},
{
"$ref": "#/$defs/fields/select"
},
{
"$ref": "#/$defs/fields/slug"
},
{
"$ref": "#/$defs/fields/structure"
},
{
"$ref": "#/$defs/fields/tags"
},
{
"$ref": "#/$defs/fields/tel"
},
{
"$ref": "#/$defs/fields/text"
},
{
"$ref": "#/$defs/fields/textarea"
},
{
"$ref": "#/$defs/fields/time"
},
{
"$ref": "#/$defs/fields/toggle"
},
{
"$ref": "#/$defs/fields/toggles"
},
{
"$ref": "#/$defs/fields/url"
},
{
"$ref": "#/$defs/fields/users"
},
{
"$ref": "#/$defs/fields/writer"
},
{
"$ref": "#/$defs/sections/info"
},
{
"$ref": "#/$defs/sections/fields"
},
{
"$ref": "#/$defs/sections/files"
},
{
"$ref": "#/$defs/sections/pages"
},
{
"$ref": "#/$defs/sections/stats"
},
{
"$ref": "#/$defs/blueprints/file"
},
{
"$ref": "#/$defs/blueprints/page"
},
{
"$ref": "#/$defs/blueprints/site"
},
{
"$ref": "#/$defs/blueprints/user"
}
],
"title": "JSON schema for Kirby 3 CMS blueprint files"
} | MIT | en |
ccc-certifier-framework/certifier-framework-for-confidential-computing | 971ca4649e94d3309605a3af87c463bb2c2026f6 | 2023-03-05T00:04:02 | utilities/policy_schema.json | 46 | 2024-05-27T06:47:09.966131Z | {
"$defs": {
"simpleClause": {
"oneOf": [
{
"required": [
"keyObject"
]
},
{
"required": [
"measurementObject"
]
},
{
"required": [
"platformObject"
]
},
{
"required": [
"environmentObject"
]
}
],
"properties": {
"certSubject": {
"type": "string"
},
"environmentObject": {
"type": "string"
},
"environmentSubject": {
"type": "string"
},
"keyObject": {
"type": "string"
},
"keySubject": {
"type": "string"
},
"measurementObject": {
"type": "string"
},
"measurementSubject": {
"type": "string"
},
"platformObject": {
"type": "string"
},
"platformSubject": {
"type": "string"
},
"verb": {
"type": "string"
}
},
"required": [
"verb"
],
"title": "The simpleClause Schema",
"type": "object"
},
"unaryClause": {
"oneOf": [
{
"required": [
"keySubject"
]
},
{
"required": [
"certSubject"
]
},
{
"required": [
"measurementSubject"
]
},
{
"required": [
"platformSubject"
]
},
{
"required": [
"environmentSubject"
]
}
],
"properties": {
"certSubject": {
"type": "string"
},
"environmentSubject": {
"type": "string"
},
"keySubject": {
"type": "string"
},
"measurementSubject": {
"type": "string"
},
"platformSubject": {
"type": "string"
},
"verb": {
"type": "string"
}
},
"required": [
"verb"
],
"title": "The unaryClause Schema",
"type": "object"
}
},
"$id": "https://github.com/vmware-research/certifier-framework-for-confidential-computing",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"properties": {
"claims": {
"items": {
"allOf": [
{
"oneOf": [
{
"required": [
"keySubject"
]
},
{
"required": [
"certSubject"
]
},
{
"required": [
"measurementSubject"
]
},
{
"required": [
"platformSubject"
]
},
{
"required": [
"environmentSubject"
]
}
]
},
{
"oneOf": [
{
"required": [
"unaryClause"
]
},
{
"required": [
"simpleClause"
]
},
{
"required": [
"indirectClause"
]
}
]
}
],
"properties": {
"certSubject": {
"type": "string"
},
"environmentSubject": {
"type": "string"
},
"indirectClause": {
"allOf": [
{
"oneOf": [
{
"required": [
"keySubject"
]
},
{
"required": [
"certSubject"
]
},
{
"required": [
"measurementSubject"
]
},
{
"required": [
"platformSubject"
]
},
{
"required": [
"environmentSubject"
]
}
]
},
{
"oneOf": [
{
"required": [
"unaryClause"
]
},
{
"required": [
"simpleClause"
]
}
]
}
],
"properties": {
"certSubject": {
"type": "string"
},
"environmentSubject": {
"type": "string"
},
"keySubject": {
"type": "string"
},
"measurementSubject": {
"type": "string"
},
"platformSubject": {
"type": "string"
},
"simpleClause": {
"$ref": "#/$defs/simpleClause"
},
"unaryClause": {
"$ref": "#/$defs/unaryClause"
},
"verb": {
"type": "string"
}
},
"required": [
"verb"
],
"type": "object"
},
"keySubject": {
"type": "string"
},
"measurementSubject": {
"type": "string"
},
"platformSubject": {
"type": "string"
},
"signingKey": {
"type": "string"
},
"simpleClause": {
"$ref": "#/$defs/simpleClause"
},
"unaryClause": {
"$ref": "#/$defs/unaryClause"
},
"verb": {
"type": "string"
}
},
"required": [
"verb"
],
"type": "object"
},
"title": "The claims Schema",
"type": "array"
},
"measurements": {
"items": {
"title": "A single measurement to be trusted",
"type": "string"
},
"title": "The trusted measurements Schema",
"type": "array"
},
"platforms": {
"items": {
"properties": {
"props": {
"items": {
"properties": {
"comparator": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"comparator",
"type",
"name",
"value"
],
"title": "A single property",
"type": "object"
},
"title": "Properties for a single platform",
"type": "array"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"props"
],
"type": "object"
},
"title": "The platforms type Schema",
"type": "array"
},
"policyKey": {
"title": "The policyKey Schema",
"type": "string"
}
},
"required": [
"policyKey",
"measurements"
],
"title": "The Certifier Policy Schema",
"type": "object"
} | Apache-2.0 | en |
ccc-certifier-framework/certifier-framework-for-confidential-computing | a0797c5939bf550c4d60583f3b9055400229f266 | 2023-03-01T00:58:49 | utilities/policy_schema.json | 46 | 2024-05-27T06:47:09.966131Z | {
"$defs": {
"simpleClause": {
"oneOf": [
{
"required": [
"keySubject"
]
},
{
"required": [
"certSubject"
]
},
{
"required": [
"measurementSubject"
]
},
{
"required": [
"platformSubject"
]
},
{
"required": [
"environmentSubject"
]
}
],
"properties": {
"certSubject": {
"type": "string"
},
"environmentSubject": {
"type": "string"
},
"keySubject": {
"type": "string"
},
"measurementSubject": {
"type": "string"
},
"platformSubject": {
"type": "string"
},
"verb": {
"type": "string"
}
},
"required": [
"verb"
],
"title": "The simpleClause Schema",
"type": "object"
},
"unaryClause": {
"oneOf": [
{
"required": [
"keySubject"
]
},
{
"required": [
"certSubject"
]
},
{
"required": [
"measurementSubject"
]
},
{
"required": [
"platformSubject"
]
},
{
"required": [
"environmentSubject"
]
}
],
"properties": {
"certSubject": {
"type": "string"
},
"environmentSubject": {
"type": "string"
},
"keySubject": {
"type": "string"
},
"measurementSubject": {
"type": "string"
},
"platformSubject": {
"type": "string"
},
"verb": {
"type": "string"
}
},
"required": [
"verb"
],
"title": "The unaryClause Schema",
"type": "object"
}
},
"$id": "https://github.com/vmware-research/certifier-framework-for-confidential-computing",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"properties": {
"claims": {
"items": {
"allOf": [
{
"oneOf": [
{
"required": [
"keySubject"
]
},
{
"required": [
"certSubject"
]
},
{
"required": [
"measurementSubject"
]
},
{
"required": [
"platformSubject"
]
},
{
"required": [
"environmentSubject"
]
}
]
},
{
"oneOf": [
{
"required": [
"unaryClause"
]
},
{
"required": [
"simpleClause"
]
},
{
"required": [
"indirectClause"
]
}
]
}
],
"properties": {
"certSubject": {
"type": "string"
},
"environmentSubject": {
"type": "string"
},
"indirectClause": {
"allOf": [
{
"oneOf": [
{
"required": [
"keySubject"
]
},
{
"required": [
"certSubject"
]
},
{
"required": [
"measurementSubject"
]
},
{
"required": [
"platformSubject"
]
},
{
"required": [
"environmentSubject"
]
}
]
},
{
"oneOf": [
{
"required": [
"unaryClause"
]
},
{
"required": [
"simpleClause"
]
}
]
}
],
"properties": {
"certSubject": {
"type": "string"
},
"environmentSubject": {
"type": "string"
},
"keySubject": {
"type": "string"
},
"measurementSubject": {
"type": "string"
},
"platformSubject": {
"type": "string"
},
"simpleClause": {
"$ref": "#/$defs/simpleClause"
},
"unaryClause": {
"$ref": "#/$defs/unaryClause"
},
"verb": {
"type": "string"
}
},
"required": [
"verb"
],
"type": "object"
},
"keySubject": {
"type": "string"
},
"measurementSubject": {
"type": "string"
},
"platformSubject": {
"type": "string"
},
"signingKey": {
"type": "string"
},
"simpleClause": {
"$ref": "#/$defs/simpleClause"
},
"unaryClause": {
"$ref": "#/$defs/unaryClause"
},
"verb": {
"type": "string"
}
},
"required": [
"verb"
],
"type": "object"
},
"title": "The claims Schema",
"type": "array"
},
"measurements": {
"items": {
"title": "A single measurement to be trusted",
"type": "string"
},
"title": "The trusted measurements Schema",
"type": "array"
},
"platforms": {
"items": {
"items": {
"properties": {
"comparator": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"comparator",
"type",
"name",
"value"
],
"title": "A single property",
"type": "object"
},
"title": "Properties for a single platform",
"type": "array"
},
"title": "The platforms properties Schema",
"type": "array"
},
"policyKey": {
"title": "The policyKey Schema",
"type": "string"
}
},
"required": [
"policyKey",
"measurements"
],
"title": "The Certifier Policy Schema",
"type": "object"
} | Apache-2.0 | en |
mondeja/mkdocs-include-markdown-plugin | ac861edb145baf44dbcb4969381e4e9364ab4561 | 2022-03-04T16:20:03 | schema.json | 90 | 2024-05-27T23:45:46.29856Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"enum": [
"include-markdown"
],
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#readme",
"title": "Mkdocs Markdown includer plugin."
} | Apache-2.0 | en |
mondeja/mkdocs-include-markdown-plugin | 6c10d0032138c843ea06676b0c647dddcd6fb9e4 | 2023-08-11T00:48:42 | schema.json | 90 | 2024-05-27T23:45:46.29856Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"oneOf": [
{
"enum": [
"include-markdown"
],
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#readme"
},
{
"additionalProperties": false,
"properties": {
"include-markdown": {
"additionalProperties": false,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#documentation",
"properties": {
"cache": {
"default": 0,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#configuration",
"type": "integer"
},
"closing_tag": {
"default": "%}",
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#config_tags",
"type": "string"
},
"comments": {
"default": true,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include-markdown_comments",
"type": "boolean"
},
"dedent": {
"default": false,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include_dedent",
"type": "boolean"
},
"encoding": {
"default": "utf-8",
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include_encoding",
"type": "string"
},
"end": {
"default": "<!--end-->",
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include-markdown_end",
"type": "string"
},
"exclude": {
"items": {
"type": "string"
},
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include-markdown_exclude",
"type": "array"
},
"heading_offset": {
"default": 0,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include-markdown_heading-offset",
"type": "integer"
},
"opening_tag": {
"default": "{%",
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#config_tags",
"type": "string"
},
"preserve_includer_indent": {
"default": true,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include_preserve-includer-indent",
"type": "boolean"
},
"rewrite_relative_urls": {
"default": true,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include-markdown_trailing-newlines",
"type": "boolean"
},
"start": {
"default": "<!--start-->",
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include-markdown_start",
"type": "string"
},
"trailing_newlines": {
"default": true,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include_trailing-newlines",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
],
"title": "Mkdocs Markdown includer plugin."
} | Apache-2.0 | en |
mondeja/mkdocs-include-markdown-plugin | 7ec8c3beddca8b5b040d0db35d49bb44cdf1a123 | 2023-08-01T07:35:07 | schema.json | 90 | 2024-05-27T23:45:46.29856Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"oneOf": [
{
"enum": [
"include-markdown"
],
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#readme"
},
{
"additionalProperties": false,
"properties": {
"include-markdown": {
"additionalProperties": false,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#documentation",
"properties": {
"cache": {
"default": 0,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#configuration",
"type": "integer"
},
"closing_tag": {
"default": "%}",
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#config_tags",
"type": "string"
},
"comments": {
"default": true,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include-markdown_comments",
"type": "boolean"
},
"dedent": {
"default": false,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include_dedent",
"type": "boolean"
},
"encoding": {
"default": "utf-8",
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include_encoding",
"type": "string"
},
"end": {
"default": "<!--end-->",
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include-markdown_end",
"type": "string"
},
"exclude": {
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include-markdown_exclude",
"type": "string"
},
"heading_offset": {
"default": 0,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include-markdown_heading-offset",
"type": "integer"
},
"opening_tag": {
"default": "{%",
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#config_tags",
"type": "string"
},
"preserve_includer_indent": {
"default": true,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include_preserve-includer-indent",
"type": "boolean"
},
"rewrite_relative_urls": {
"default": true,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include-markdown_trailing-newlines",
"type": "boolean"
},
"start": {
"default": "<!--start-->",
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include-markdown_start",
"type": "string"
},
"trailing_newlines": {
"default": true,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include_trailing-newlines",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
],
"title": "Mkdocs Markdown includer plugin."
} | Apache-2.0 | en |
mondeja/mkdocs-include-markdown-plugin | d3c7066a5d0128e4dfcb86d51ca385aa5456ea90 | 2022-09-15T10:39:09 | schema.json | 90 | 2024-05-27T23:45:46.29856Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"oneOf": [
{
"enum": [
"include-markdown"
],
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#readme"
},
{
"additionalProperties": false,
"properties": {
"include-markdown": {
"additionalProperties": false,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#documentation",
"properties": {
"closing_tag": {
"default": "%}",
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#config_tags",
"type": "string"
},
"comments": {
"default": true,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include-markdown_comments",
"type": "boolean"
},
"dedent": {
"default": false,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include_dedent",
"type": "boolean"
},
"encoding": {
"default": "utf-8",
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include_encoding",
"type": "string"
},
"opening_tag": {
"default": "{%",
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#config_tags",
"type": "string"
},
"preserve_includer_indent": {
"default": true,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include_preserve-includer-indent",
"type": "boolean"
},
"trailing_newlines": {
"default": true,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#include_trailing-newlines",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
],
"title": "Mkdocs Markdown includer plugin."
} | Apache-2.0 | en |
mondeja/mkdocs-include-markdown-plugin | 0f984609e0dbc729b22decfc62aedda8b79ba3ad | 2022-07-21T12:59:40 | schema.json | 90 | 2024-05-27T23:45:46.29856Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"oneOf": [
{
"enum": [
"include-markdown"
],
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#readme"
},
{
"additionalProperties": false,
"properties": {
"include-markdown": {
"additionalProperties": false,
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#documentation",
"properties": {
"closing_tag": {
"default": "%}",
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#custom-opening-and-closing-tags",
"type": "string"
},
"opening_tag": {
"default": "{%",
"markdownDescription": "https://github.com/mondeja/mkdocs-include-markdown-plugin#custom-opening-and-closing-tags",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
],
"title": "Mkdocs Markdown includer plugin."
} | Apache-2.0 | en |
InseeFr/Eno | 36392f6068a0e2eb96a5e6b57f2226b354fc2ae2 | 2023-11-25T14:19:29 | eno-treatments/src/main/resources/schema.regrouping.json | 13 | 2024-05-28T06:00:28.463344Z | {
"$id": "https://insee.fr/eno/regrouping.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "List of variable names to be grouped in the same page in the Lunatic questionnaire.",
"items": {
"items": {
"type": "string"
},
"minItems": 2,
"type": "array",
"uniqueItems": true
},
"title": "Regrouping specific treatments schema",
"type": "array"
} | MIT | en |
InseeFr/Eno | 36392f6068a0e2eb96a5e6b57f2226b354fc2ae2 | 2023-11-25T14:19:29 | eno-treatments/src/main/resources/schema.suggesters.json | 13 | 2024-05-28T06:00:28.463344Z | {
"$defs": {
"field_synonym": {
"patternProperties": {
".*": {
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
},
"query_parser": {
"properties": {
"params": {
"$ref": "#/$defs/query_parser_params"
},
"type": {
"enum": [
"soft",
"tokenized"
]
}
},
"required": [
"type"
],
"type": "object"
},
"query_parser_params": {
"properties": {
"language": {
"enum": [
"French",
"English"
]
},
"min": {
"type": "number"
},
"pattern": {
"type": "string"
},
"stemmer": {
"type": "boolean"
}
},
"type": "object"
},
"suggester": {
"properties": {
"fields": {
"items": {
"$ref": "#/$defs/suggester_field"
},
"type": "array"
},
"max": {
"type": "number"
},
"meloto": {
"type": "boolean"
},
"name": {
"type": "string"
},
"order": {
"$ref": "#/$defs/suggester_order"
},
"queryParser": {
"$ref": "#/$defs/query_parser"
},
"responseNames": {
"description": "Property that is not in Lunatic schema, used to associate suggester with components.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"stopWords": {
"items": {
"type": "string"
},
"type": "array"
},
"url": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"fields",
"queryParser",
"version"
],
"type": "object"
},
"suggester_field": {
"properties": {
"language": {
"enum": [
"French",
"English"
]
},
"min": {
"type": "number"
},
"name": {
"type": "string"
},
"rules": {
"pattern": "^soft$",
"type": [
"string",
"array"
]
},
"stemmer": {
"type": "boolean"
},
"synonyms": {
"$ref": "#/$defs/field_synonym"
}
},
"required": [
"name"
],
"type": "object"
},
"suggester_order": {
"properties": {
"field": {
"type": "string"
},
"type": {
"enum": [
"ascending",
"desceding"
]
}
},
"required": [
"type",
"field"
],
"type": "object"
}
},
"$id": "https://insee.fr/eno/suggesters.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fits Lunatic suggesters property's schema, except a 'responseName' attribute is added here.",
"items": {
"$ref": "#/$defs/suggester"
},
"title": "Lunatic suggesters' schema for Eno specific treatment",
"type": "array"
} | MIT | en |
Subsets and Splits