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 |
|---|---|---|---|---|---|---|---|---|
BiRD-project/BiRD_view | c96367bf56a138b6b7d4eff5889594a19850b966 | 2021-11-26T23:45:50 | BRDF_JSON_schema/dimensions_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing physical dimensions of the different optical elements, illumination beam and/or samples used for BRDF measurements.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the dimensions of the different optical elements, illumination beam and/or samples that cannot be presented within \"dimensions\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"area": {
"additionalProperties": false,
"description": "Area of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the area of an optical element, illumination beam and/or sample as a string that can have values \"pm^2\", \"nm^2\", \"\u03bcm^2\", \"mm^2\", \"dm^2\" or \"m^2\".",
"enum": [
"pm^2",
"nm^2",
"\u03bcm^2",
"mm^2",
"dm^2",
"m^2"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the area of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "area",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding dimensions of the different optical elements, illumination beam and/or samples used for BRDF measurements as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"diameter": {
"additionalProperties": false,
"description": "Diameter of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the diameter of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the diameter of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "diameter",
"type": "object"
},
"height": {
"additionalProperties": false,
"description": "Height of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the height of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the height of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "height",
"type": "object"
},
"length": {
"additionalProperties": false,
"description": "Length of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the length of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the length of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "length",
"type": "object"
},
"radius": {
"additionalProperties": false,
"description": "Radius of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the radius of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the radius of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "radius",
"type": "object"
},
"semi_major_axis": {
"additionalProperties": false,
"description": "Semi-major axis of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the semi-major axis of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the semi-major axis of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "semi_major_axis",
"type": "object"
},
"semi_minor_axis": {
"additionalProperties": false,
"description": "Semi-minor axis of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the semi-minor axis of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the semi-minor axis of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "semi_minor_axis",
"type": "object"
},
"thickness": {
"additionalProperties": false,
"description": "Thickness of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the thickness of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the thickness of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "thickness",
"type": "object"
},
"width": {
"additionalProperties": false,
"description": "Width of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the width of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the width of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "width",
"type": "object"
}
},
"required": [
"area",
"length"
],
"title": "dimensions",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | 2021-11-25T21:59:18 | BRDF_JSON_schema/brdf_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/brdf_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A JSON schema for automatic validation of Universal BRDF data format proposed by BiRD project consortium in 2021",
"properties": {
"data": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/data_json_schema_v1.0.json",
"description": "an object with keys related to definition of BRDF function, variable properties of BRDF data and BRDF values themselves",
"title": "data",
"type": "object"
},
"metadata": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/metadata_json_schema_v1.0.json",
"description": "A section of a file that describes the measured or simulated BRDF data set from the point of view of data origin, simulation or measurement system's parameters, sample parameters and evironment. It also contains a globaly unique dataset identifier, specifices the data type, file name and records a timestamp of a measurement or simulation",
"title": "metadata",
"type": "object"
}
},
"required": [
"metadata",
"data"
],
"title": "Universal BRDF data format schema",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | 2021-11-25T21:59:18 | BRDF_JSON_schema/environment_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/environment_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing the environmental conditions during BRDF measurement like pressure, temperature, humidity, etc.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the environmental conditions during BRDF measurements that cannot be presented within \"environment\" object properties provided by schema. Adhoc section can contain all types of entries except new objects",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "A section that allows to add any additional information regarding environmental conditions during BRDF measurements. Comments should be presented as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An object that allows to refer to available external information regarding environmental conditions during BRDF measurements. Array of string URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"pressure": {
"additionalProperties": false,
"description": "An object describing pressure within the environment in which measurement sample's BRDF was measured.",
"properties": {
"unit": {
"description": "Unit of the relative pressure within the environment in which measurement sample's BRDF was measured as a string that can have value \"Pa\", \"kPa\", \"bar\" and \"psi\".",
"enum": [
"Pa",
"kPa",
"bar",
"psi"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the pressure within the environment (at the given temperature) in which measurement sample's BRDF was measured as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "pressure",
"type": "object"
},
"relative_humidity": {
"additionalProperties": false,
"description": "An object describing relative humidity of the environment in which measurement sample's BRDF was measured.",
"properties": {
"unit": {
"description": "Unit of the relative humidity of the environment in which measurement sample's BRDF was measured as a string that can have value \"%\".",
"enum": [
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the relative humidity of the environment (at the given temperature) in which measurement sample's BRDF was measured as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "relative_humidity",
"type": "object"
},
"temperature": {
"additionalProperties": false,
"description": "An object describing ambient temperature of the environment in which measurement sample's BRDF was measured.",
"properties": {
"unit": {
"description": "Unit of the ambient temperature of the environment in which measurement sample's BRDF was measured as a string that can have values \"K\", \"kK\" or \"\u00b0C\".",
"enum": [
"K",
"kK",
"\u00b0C"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the ambient temperature of the environment in which measurement sample's BRDF was measured as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "temperature",
"type": "object"
}
},
"required": [
"temperature"
],
"title": "environment",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | 2021-11-25T21:59:18 | BRDF_JSON_schema/monochromator_setting_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/monochromator_setting_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing monochromator parameters for a single selected wavelength or wavelength range within which these parameters were constant during BRDF measurements",
"oneOf": [
{
"required": [
"wl_range",
"bandpass_FWHM"
]
},
{
"required": [
"selected_wl",
"bandpass_FWHM"
]
}
],
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the monochromator parameters used during BRDF measurements that cannot be presented within \"monochromator_setting\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section"
},
"bandpass_FWHM": {
"additionalProperties": false,
"description": "Full Width at Half Maximum of spectral band passed through monochromator. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the monochromator's bandpass FWHM as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[\u03bcn]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the monochromator's bandpass FWHM as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "bandpass_FWHM",
"type": "object"
},
"comments": {
"description": "A field allowing to describe any additional information related to monochromator settings as a text (i.e. string)",
"title": "comments",
"type": "string"
},
"selected_wl": {
"additionalProperties": false,
"description": "Wavelength that was selected at monochromator settings for single-wavelength BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the set monochromator's wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[\u03bcn]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the set monochromator's wavelength as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "selected_wl",
"type": "object"
},
"slit_width": {
"additionalProperties": false,
"description": "Slit width of the monochromator for the given wavelength range. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the monochromator's slit width as a string that can have values \"nm\", \"\u03bcm\", \"mm\" or \"m\".",
"pattern": "^[\u03bcnm]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the monochromator's slit width as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "slit_width",
"type": "object"
},
"spectral_resolution": {
"additionalProperties": false,
"description": "Description of monochromator's wavelength resolving/separation/dispersion capabilities as width of transmitted light spectral band per width of monochromator output slit. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the monochromator's wavelength resolving/separation/dispersion capabilities as a string that can have value \"nm/mm\".",
"pattern": "nm/mm$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the monochromator's wavelength resolving/separation/dispersion capabilities as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "spectral_resolution",
"type": "object"
},
"wl_range": {
"additionalProperties": false,
"description": "Design or set operation wavelength range of the monochromator used to select illumination or detection wavelength during BRDF measurements. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the monochromator's transmission longest wavelength as a number.",
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the monochromator's transmission shortest wavelength as a number.",
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Unit of the monochromator's transmission shortest and longest wavelengths as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[\u03bcn]?m$",
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "wl_range"
}
},
"title": "monochromator_setting",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | 2021-11-26T20:30:56 | BRDF_JSON_schema/dimensions_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing physical dimensions of the different optical elements, illumination beam and/or samples used for BRDF measurements.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the dimensions of the different optical elements, illumination beam and/or samples that cannot be presented within \"dimensions\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"area": {
"additionalProperties": false,
"description": "Area of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the area of an optical element, illumination beam and/or sample as a string that can have values \"pm2\", \"nm2\", \"\u03bcm2\", \"mm2\", \"dm2\", \"m2\", \"km2\", \"Mm2\" or \"Gm2\".",
"pattern": "^[GMkmd\u03bcnp]?m2$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the area of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "area",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding dimensions of the different optical elements, illumination beam and/or samples used for BRDF measurements as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"diameter": {
"additionalProperties": false,
"description": "Diameter of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the diameter of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the diameter of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "diameter",
"type": "object"
},
"height": {
"additionalProperties": false,
"description": "Height of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the height of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the height of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "height",
"type": "object"
},
"length": {
"additionalProperties": false,
"description": "Length of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the length of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the length of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "length",
"type": "object"
},
"radius": {
"additionalProperties": false,
"description": "Radius of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the radius of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the radius of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "radius",
"type": "object"
},
"semi_major_axis": {
"additionalProperties": false,
"description": "Semi-major axis of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the semi-major axis of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the semi-major axis of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "semi_major_axis",
"type": "object"
},
"semi_minor_axis": {
"additionalProperties": false,
"description": "Semi-minor axis of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the semi-minor axis of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the semi-minor axis of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "semi_minor_axis",
"type": "object"
},
"thickness": {
"additionalProperties": false,
"description": "Thickness of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the thickness of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the thickness of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "thickness",
"type": "object"
},
"width": {
"additionalProperties": false,
"description": "Width of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the width of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the width of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "width",
"type": "object"
}
},
"required": [],
"title": "dimensions",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | 2021-12-02T01:06:05 | BRDF_JSON_schema/simulation_model_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/simulation_model_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing the mathematical or physical simulation model and its parameters used to produce BRDF data.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"simulation_model\" object) describing any information relevant to the mathematical or physical simulation model used to produce BRDF data presented in the file. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "A section that allows to add any additional information regarding the mathematical or physical simulation model used to produce BRDF data presented in the file. Comments should be presented as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allow to refer to any external information related to the mathematical or physical simulation model that were used to produce BRDF data presented in the file. For example, link to the article describing model. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "Short description of the mathematical or physical simulation model used to produce BRDF data as a text (i.e. string). It may refer to authors of model, its key principles, description of most significant variables, application limits etc.",
"title": "description",
"type": "string"
},
"equation": {
"description": "Equation of mathematical or physical simulation model used to produce BRDF data as a text (i.e. string) according to text-based math standards: https://w3c.github.io/mathonwebpages/research/text_based_standards.html. NB! Correct spelling of math equations cannot be checked by JSON validator.",
"title": "equation",
"type": "string"
},
"name": {
"description": "Short name commonly used to refer to mathematical or physical simulation model used to produce BRDF data as a text (i.e. string). For example, \"Torrance-Sparrow model\", \"Cook-Torrance model\" etc.",
"title": "name",
"type": "string"
},
"parameters": {
"description": "An array of unique \"model_parameter\" objects describing mathematical or physical simulation model parameters.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/simulation_model_parameter_json_schema_v1.0.json",
"description": "An object describing a single mathematical or physical simulation model parameter. I.e. its name, meaning, value, unit, symbol etc.",
"title": "model_parameter",
"type": "object"
},
"title": "parameters",
"type": "array",
"uniqueItems": true
}
},
"required": [
"name",
"description"
],
"title": "simulation_model"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | 2021-11-26T20:30:56 | BRDF_JSON_schema/beam_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/beam_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with properties describing illumination beam parameters like size, shape, uniformity etc.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the illumination beam that cannot be presented within \"aperture\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding illumination beam as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding illumination beam used for BRDF measurements. Array of URL links as a text (i.e.string).",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"description": "An object describing physical dimensions of the beam at the surface of the measurement sample.",
"required": [
"area"
],
"title": "dimensions",
"type": "object"
},
"divergence": {
"additionalProperties": false,
"description": "An object describing divergence of the illumination beam at the surface of the measurement sample.",
"properties": {
"unit": {
"description": "Unit of the divergence of the illumination beam at the surface of the measurement sample. as a string that can have values \"deg\" or \"rad\".",
"enum": [
"deg",
"rad"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the divergence of the illumination beam at the surface of the measurement sample. It is defined as a ratio of the minimum and maximum optical power values within illumination beam area. It is an object with keys \"value\", \"unit\" and/or \"comments\".",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "divergence",
"type": "object"
},
"shape": {
"description": "Shape of the illumination beam at the surface of the measurement sample as a text (i.e. string). For example \"circular\", \"square\", \"rectangular\", \"elliptical\" etc.",
"title": "shape",
"type": "string"
},
"uniformity": {
"additionalProperties": false,
"description": "An object describing uniformity of the illumination beam at the surface of the measurement sample. It is defined as a ratio of the minimum and maximum optical power values within illumination beam area. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the uniformity of the illumination beam at the surface of the measurement sample as a string that can have values \"%\" or unitless i.e. \"\".",
"pattern": "^%?$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the uniformity of the illumination beam at the surface of the measurement sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uniformity",
"type": "object"
}
},
"required": [
"shape",
"dimensions"
],
"title": "beam",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | 2021-11-25T21:59:18 | BRDF_JSON_schema/polarization_alterant_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/polarization_alterant_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing a single polarization altering element or an assembly that included to the set-up used for (usually polarimetric) BRDF measurements. Note that the same object describes polarization altering elements integrated to illumination or detection systems.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the polarization altering element included to the of the set-up used for (usually polarimetric) BRDF measurements that cannot be presented within \"polarization_alterant\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "A section that allows to provide in the form of text (i.e. string) any comments relevant to polarization altering element included to the set-up used for (usually polarimetric) BRDF measurements.",
"title": "comments",
"type": "string"
},
"damage_treshold": {
"additionalProperties": false,
"description": "The field describing maximum power at which polarization altering element can be operated. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the maximum optical power at which polarization altering element can be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\".",
"pattern": "^[pn\u03bcmkMG]?W$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the maximum power at which polarization altering element can be operated as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "damage_treshold",
"type": "object"
},
"data_links": {
"description": "An array with links to any relevant technical information regarding polarization altering element included to the set-up used for (usually polarimetric) BRDF measurements.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"design_wl": {
"additionalProperties": false,
"description": "An object describing wavelength at which polarization altering element is most effective by design.",
"properties": {
"unit": {
"description": "Unit of the wavelength at which polarization altering element is most effective as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[n\u03bc]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the wavelength at which polarization altering element is most effective as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "design_wl",
"type": "object"
},
"extinction_ratio": {
"additionalProperties": false,
"description": "The field to describe typical extinction ratio of polarizer used for altering polarization of illumination. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Polarizer's extinction ratio is unitless and unit property should be filled with empty string \"\".",
"pattern": "",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the polarizer's extinction ratio as a number. Note that extinction ratio is usually presented as X : 1, but since 1 is a constant only X is the value requested here.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "extinction_ratio",
"type": "object"
},
"manufacturer": {
"description": "Manufacturer of the polarization altering element as a text/string.",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Field describing the material of polarization altering element as a text/string.",
"title": "material",
"type": "string"
},
"model": {
"description": "Model name of the polarization altering element given by manufacturer. As a text/string.",
"title": "model",
"type": "string"
},
"name": {
"description": "Short name of an element used for alteration of illumination or detection polarization state. As a text/string.",
"title": "name",
"type": "string"
},
"type": {
"description": "Type of the polarization altering element. For example, \"linear polarizer\", \"quater-wave plate\", \"half-wave plate\", \"retarder\", \"depolarizer\" etc. As a text/string.",
"title": "type",
"type": "string"
},
"wl_range": {
"additionalProperties": false,
"description": "Wavelength range within which polarization altering element is designed to be operated.",
"properties": {
"max_value": {
"description": "Numerical value of the longest wavelength at which polarization altering element can be used as a number.",
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of shortest wavelength at which polarization altering element can be used as a number.",
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Unit of the shortest and longest wavelengths at which polarization altering element can be used as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[\u03bcn]?m$",
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "wl_range",
"type": "object"
}
},
"required": [
"name",
"type"
],
"title": "polarization_alterant",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | 2021-12-02T01:06:05 | BRDF_JSON_schema/wavelength_selectors_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/wavelength_selectors_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing optical components that were used to select/filter specific wavelength or wavelength ranges from incoming radiation as well as properties and settings these components.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the wavelength selecting optical elements and devices that cannot be presented within \"wavelength_selectors\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "A field for providing any additional information regarding wavelength selecting optical elements and devices as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"monochromator": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/monochromator_json_schema_v1.0.json",
"description": "The object describing properties and settings of the monochromator used for BRDF measurements.",
"title": "monochromator",
"type": "object"
},
"optical_filters": {
"description": "An array of unique \"optical_filter\" objects each describing the filters that were used to define illumination or collected light spectral properties during BRDF measurement.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/optical_filter_json_schema_v1.0.json",
"description": "The \"optical_filter\" object describing properties of the optical filter used for BRDF measurement.",
"title": "optical_filter",
"type": "object"
},
"title": "optical_filters",
"type": "array",
"uniqueItems": true
}
},
"required": [],
"title": "wavelength_selectors",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | 2021-11-25T21:59:18 | BRDF_JSON_schema/data_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/data_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "an object with keys related to definition of BRDF function, variable properties of BRDF data and BRDF values themselves",
"properties": {
"values": {
"description": "Array of length N corresponding to number of measured BRDF points where each element is and array of length M corresponding to M varibles that were varied during simulation/measurement",
"items": {
"description": "Array of length M corresponding to M varibles that were varied during simulation/measurement alongside BRDF vales and their uncertainties. Order of elements should corespond to order of variables in \"variables\"",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"type": "array"
},
"title": "values",
"type": "array"
},
"variables": {
"allOf": [
{
"contains": {
"properties": {
"name": {
"const": "theta_i",
"title": "name",
"type": "string"
},
"unit": {
"enum": [
"deg",
"rad"
],
"title": "unit",
"type": "string"
}
},
"type": "object"
}
},
{
"contains": {
"properties": {
"name": {
"const": "phi_i",
"title": "name",
"type": "string"
},
"unit": {
"enum": [
"deg",
"rad"
],
"title": "unit",
"type": "string"
}
},
"type": "object"
}
},
{
"contains": {
"properties": {
"name": {
"const": "theta_r",
"title": "name",
"type": "string"
},
"unit": {
"enum": [
"deg",
"rad"
],
"title": "unit",
"type": "string"
}
},
"type": "object"
}
},
{
"contains": {
"properties": {
"name": {
"const": "phi_r",
"title": "name",
"type": "string"
},
"unit": {
"enum": [
"deg",
"rad"
],
"title": "unit",
"type": "string"
}
},
"type": "object"
}
},
{
"contains": {
"properties": {
"name": {
"const": "BRDF",
"title": "name",
"type": "string"
},
"unit": {
"const": "sr-1",
"title": "unit",
"type": "string"
}
},
"type": "object"
}
},
{
"contains": {
"properties": {
"name": {
"const": "uBRDF",
"title": "name",
"type": "string"
},
"unit": {
"const": "sr-1",
"title": "unit",
"type": "string"
}
},
"type": "object"
}
}
],
"description": " an array of the objects where each object desribes a variables that were changed during measurement or simulation",
"items": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"properties": {
"description": {
"description": "short description of variable or its definition",
"title": "description",
"type": "string"
},
"name": {
"description": "Short keyword describing variable",
"title": "name",
"type": "string"
},
"type": {
"description": "Type of corresponding value in \"values\" as a number or string written within \"...\"",
"enum": [
"string",
"number"
],
"title": "type",
"type": "string"
},
"unit": {
"description": "units of variable as a string",
"title": "unit",
"type": "string"
}
},
"required": [
"name",
"type",
"unit",
"description"
],
"type": "object"
},
"title": "variables",
"type": "array"
}
},
"required": [
"variables",
"values"
],
"title": "data",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | c8e4c003dd63387d1f4df5883d65f7cea46b1a85 | 2022-02-11T00:21:57 | BRDF_JSON_schema/optical_filter_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/optical_filter_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "The \"optical_filter\" object describes properties of a single optical filter that was used during BRDF measurements. Note that the same object describes optical filters integrated to illumination or detection systems.",
"oneOf": [
{
"required": [
"name",
"type",
"cut_on_wl"
]
},
{
"required": [
"name",
"type",
"cut_off_wl"
]
},
{
"required": [
"name",
"type",
"wl_range"
]
},
{
"required": [
"name",
"type",
"central_wl",
"transmittance_FWHM"
]
}
],
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the optical filter placed in in the path of light of illumination source that cannot be presented within \"filter\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"avg_transmittance": {
"additionalProperties": false,
"description": "Average transmittance value of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's average transmittance value as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the optical filter's average transmittance value as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical filter's average transmittance value as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's average transmittance value as a positive number from 0 to 100.",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "avg_transmittance",
"type": "object"
},
"blocking_avg": {
"additionalProperties": false,
"description": "Average blocking/absorption value of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's average blocking/absorption value as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the optical filter's average blocking/absorption as a string that can have value \"OD\" (optical density) or \"%\".",
"enum": [
"OD",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical filter's average blocking/absorption as a string that can have value \"OD\" (optical density).",
"enum": [
"OD"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's average blocking/absorption value as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "blocking_avg",
"type": "object"
},
"central_wl": {
"additionalProperties": false,
"description": "The central transmission wavelength of the of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter central transmission wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Unit of the uncertainty of the optical filter central transmission wavelength as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Unit of the optical filter central transmission wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter central transmission wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "central_wl",
"type": "object"
},
"comments": {
"description": "An object that allows to provide any additional information regarding used for BRDF measurements as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"cut_off_wl": {
"additionalProperties": false,
"description": "A cut-off wavelength of an optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter cut-off wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Unit of the uncertainty of the optical filter cut-off wavelength as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Unit of the optical filter cut-off wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter cut-off wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "cut_off_wl",
"type": "object"
},
"cut_on_wl": {
"additionalProperties": false,
"description": "A cut-on wavelength of an optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter cut-on wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Unit of the uncertainty of the optical filter cut-on wavelength as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Unit of the optical filter cut-on wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter cut-on wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "cut_on_wl",
"type": "object"
},
"damage_threshold": {
"additionalProperties": false,
"description": "Field describing maximal optical power at which optical filter is designed to be operated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the maximal optical power at which optical filter is designed to be operated as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the the uncertainty of the maximal optical power at which optical filter is designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\", \"GW\" or \"%\".",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the maximal optical power at which optical filter is designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\".",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the maximal optical power at which optical filter is designed to be operated as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "damage_threshold"
},
"data_links": {
"description": "An object that allows to refer to available external technical information regarding optical filter used for BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"manufacturer": {
"description": "Manufacturer of an optical filter used for BRDF measurements as a text (i.e.string).",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Material of an optical filter used for BRDF measurements as a text (i.e.string).",
"title": "material",
"type": "string"
},
"max_blocking": {
"additionalProperties": false,
"description": "Maximal blocking/absorption value of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's maximal blocking/absorption value as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the optical filter's maximal blocking/absorption as a string that can have value \"OD\" (optical density) or \"%\".",
"enum": [
"OD",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical filter's maximal blocking/absorption as a string that can have value \"OD\" (optical density).",
"enum": [
"OD"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's maximal blocking/absorption value as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "max_blocking"
},
"max_transmittance": {
"additionalProperties": false,
"description": "Maximal transmittance value of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's maximal transmittance value as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the optical filter's maximal transmittance value as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical filter's maximal transmittance value as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's maximal transmittance value as a positive number from 0 to 100.",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "max_transmittance",
"type": "object"
},
"min_blocking": {
"additionalProperties": false,
"description": "Minimal blocking/absorption value of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's minimal blocking/absorption value as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the optical filter's minimal blocking/absorption as a string that can have value \"OD\" (optical density) or \"%\".",
"enum": [
"OD",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical filter's minimal blocking/absorption as a string that can have value \"OD\" (optical density).",
"enum": [
"OD"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's minimal blocking/absorption value as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "min_blocking"
},
"min_transmittance": {
"additionalProperties": false,
"description": "Minimal transmittance value of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's minimal transmittance value as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the optical filter's minimal transmittance value as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical filter's minimal transmittance value as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's minimal transmittance value as a positive number from 0 to 100.",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "min_transmittance",
"type": "object"
},
"model": {
"description": "Model of an optical filter used for BRDF measurements as a text (i.e.string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of an optical filter used for BRDF measurements as a text (i.e.string).",
"title": "name",
"type": "string"
},
"transmittance_FWHM": {
"additionalProperties": false,
"description": "Full Width at Half Maximum of the spectral transmission range of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's transmission FWHM as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Unit of the uncertainty of the optical filter's transmission FWHM as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Unit of the optical filter's transmission FWHM as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's transmission FWHM as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "transmittance_FWHM",
"type": "object"
},
"type": {
"description": "Type of an optical filter used for BRDF measurements. For example, \"interference filter\", \"neutral density filter\", \"absorptive filter\" etc. as a text (i.e.string).",
"title": "type",
"type": "string"
},
"wl_range": {
"additionalProperties": false,
"description": "The field describing transmission wavelength range of the optical filter used for BRDF measurements. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the optical filter's transmission longest wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the optical filter's transmission shortest wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Unit of the optical filter's transmission shortest and longest wavelengths as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "wl_range"
}
},
"title": "optical_filter",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | 2021-11-26T20:30:56 | BRDF_JSON_schema/data_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/data_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "an object with keys related to definition of BRDF function, variable properties of BRDF data and BRDF values themselves",
"properties": {
"values": {
"description": "Array of length N corresponding to number of measured BRDF points where each element is and array of length M corresponding to M varibles that were varied during simulation/measurement",
"items": {
"description": "Array of length M corresponding to M varibles that were varied during simulation/measurement alongside BRDF vales and their uncertainties. Order of elements should corespond to order of variables in \"variables\"",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"type": "array"
},
"title": "values",
"type": "array"
},
"variables": {
"allOf": [
{
"contains": {
"properties": {
"name": {
"const": "theta_i",
"title": "name",
"type": "string"
},
"unit": {
"enum": [
"deg",
"rad"
],
"title": "unit",
"type": "string"
}
},
"type": "object"
}
},
{
"contains": {
"properties": {
"name": {
"const": "phi_i",
"title": "name",
"type": "string"
},
"unit": {
"enum": [
"deg",
"rad"
],
"title": "unit",
"type": "string"
}
},
"type": "object"
}
},
{
"contains": {
"properties": {
"name": {
"const": "theta_r",
"title": "name",
"type": "string"
},
"unit": {
"enum": [
"deg",
"rad"
],
"title": "unit",
"type": "string"
}
},
"type": "object"
}
},
{
"contains": {
"properties": {
"name": {
"const": "phi_r",
"title": "name",
"type": "string"
},
"unit": {
"enum": [
"deg",
"rad"
],
"title": "unit",
"type": "string"
}
},
"type": "object"
}
},
{
"contains": {
"properties": {
"name": {
"const": "BRDF",
"title": "name",
"type": "string"
},
"unit": {
"const": "sr-1",
"title": "unit",
"type": "string"
}
},
"type": "object"
}
},
{
"contains": {
"properties": {
"name": {
"const": "uBRDF",
"title": "name",
"type": "string"
},
"unit": {
"const": "sr-1",
"title": "unit",
"type": "string"
}
},
"type": "object"
}
}
],
"description": " an array of the objects where each object desribes a variables that were changed during measurement or simulation",
"items": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"properties": {
"description": {
"description": "short description of variable or its definition",
"title": "description",
"type": "string"
},
"name": {
"description": "Short keyword describing variable",
"title": "name",
"type": "string"
},
"type": {
"description": "Type of corresponding value in \"values\" as a number or string written within \"...\"",
"enum": [
"string",
"number"
],
"title": "type",
"type": "string"
},
"unit": {
"description": "units of variable as a string",
"title": "unit",
"type": "string"
}
},
"required": [
"name",
"type",
"unit",
"description"
],
"type": "object"
},
"title": "variables",
"type": "array"
}
},
"required": [
"variables",
"values"
],
"title": "data",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 3ea1db7afa7841b2d56c04abc3bbc962619465a9 | 2021-12-07T15:41:51 | BRDF_JSON_schema/sample_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/sample_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing the physical or virtual sample which BRDF was measured or simulated.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"sample\" object) describing any information relevant to the sample which BRDF was measured or simulated. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"back_surface_curvature": {
"additionalProperties": false,
"description": "An object describing the curvature of the measurement sample's back surface as inverse of the curvature radius. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the back surface curvature as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the back surface curvature as a string that can have values \"1/pm\", \"1/nm\", \"1/\u03bcm\", \"1/mm\", \"1/dm\", \"1/m\", \"1/km\", \"1/Mm\", \"1/Gm\" or \"pm^-1\", \"nm^-1\", \"\u03bcm^-1\", \"mm^-1\", \"dm^-1\", \"m^-1\", \"km^-1\", \"Mm^-1\", \"Gm^-1\" or \"%\".",
"oneOf": [
{
"enum": [
"1/pm",
"1/nm",
"1/\u03bcm",
"1/mm",
"1/dm",
"1/m",
"1/km",
"1/Mm",
"1/Gm",
"%"
]
},
{
"enum": [
"pm^-1",
"nm^-1",
"\u03bcm^-1",
"mm^-1",
"dm^-1",
"m^-1",
"km^-1",
"Mm^-1",
"Gm^-1",
"%"
]
}
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the inverse of the back surface curvature radius as a string that can have values \"1/pm\", \"1/nm\", \"1/\u03bcm\", \"1/mm\", \"1/dm\", \"1/m\", \"1/km\", \"1/Mm\", \"1/Gm\" or \"pm^-1\", \"nm^-1\", \"\u03bcm^-1\", \"mm^-1\", \"dm^-1\", \"m^-1\", \"km^-1\", \"Mm^-1\", \"Gm^-1\".",
"oneOf": [
{
"enum": [
"1/pm",
"1/nm",
"1/\u03bcm",
"1/mm",
"1/dm",
"1/m",
"1/km",
"1/Mm",
"1/Gm"
]
},
{
"enum": [
"pm^-1",
"nm^-1",
"\u03bcm^-1",
"mm^-1",
"dm^-1",
"m^-1",
"km^-1",
"Mm^-1",
"Gm^-1"
]
}
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the inverse of the back surface curvature radius as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "back_surface_curvature",
"type": "object"
},
"back_surface_finish": {
"description": "The field that allows to describe in text (i.e. string) form the peculiarities of sample's back surface finish. For example \"polished\", \"sand blasted\", \"hardened\" etc.",
"title": "back_surface_finish",
"type": "string"
},
"back_surface_roughness": {
"additionalProperties": false,
"description": "An object that describes back surface roughness as arithmetical mean deviation of surface height from its mean value usually denotes as Ra (see https://en.wikipedia.org/wiki/Surface_roughness for more information). It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the measurement sample's back surface roughness as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the measurement sample's back surface roughness as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"cm\", \"m\" \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"cm",
"m",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the measurement sample's back surface roughness as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"cm\" and \"m\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"cm",
"m"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the measurement sample's back surface roughness as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "front_surface_roughness",
"type": "object"
},
"cleaning_procedure": {
"description": "The field that allowing to briefly describe the peculiarities of any cleaning procedure that was applied to the sample before its BRDF measurement. s a text (i.e. string).",
"title": "cleaning_procedure",
"type": "string"
},
"comments": {
"description": "The section that allows to add any additional information in a text form regarding physical or virtual sample which BRDF was measured or simulated. Comments should be presented as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array allowing to provide links to external data regarding physical or virtual sample which BRDF was measured or simulated. For example to photos or 3D model of the sample, its roughness measurement data etc. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"description": "An object that allows to specify dimensions of the sample which BRDF was measured.",
"title": "dimensions",
"type": "object"
},
"front_surface_curvature": {
"additionalProperties": false,
"description": "An object describing the curvature of the measurement sample's front surface as inverse of the curvature radius. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the front surface curvature as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the front surface curvature as a string that can have values \"1/pm\", \"1/nm\", \"1/\u03bcm\", \"1/mm\", \"1/dm\", \"1/m\", \"1/km\", \"1/Mm\", \"1/Gm\" or \"pm^-1\", \"nm^-1\", \"\u03bcm^-1\", \"mm^-1\", \"dm^-1\", \"m^-1\", \"km^-1\", \"Mm^-1\", \"Gm^-1\" or \"%\".",
"oneOf": [
{
"enum": [
"1/pm",
"1/nm",
"1/\u03bcm",
"1/mm",
"1/dm",
"1/m",
"1/km",
"1/Mm",
"1/Gm",
"%"
]
},
{
"enum": [
"pm^-1",
"nm^-1",
"\u03bcm^-1",
"mm^-1",
"dm^-1",
"m^-1",
"km^-1",
"Mm^-1",
"Gm^-1",
"%"
]
}
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the inverse of the front surface curvature radius as a string that can have values \"1/pm\", \"1/nm\", \"1/\u03bcm\", \"1/mm\", \"1/dm\", \"1/m\", \"1/km\", \"1/Mm\", \"1/Gm\" or \"pm^-1\", \"nm^-1\", \"\u03bcm^-1\", \"mm^-1\", \"dm^-1\", \"m^-1\", \"km^-1\", \"Mm^-1\", \"Gm^-1\".",
"oneOf": [
{
"enum": [
"1/pm",
"1/nm",
"1/\u03bcm",
"1/mm",
"1/dm",
"1/m",
"1/km",
"1/Mm",
"1/Gm"
]
},
{
"enum": [
"pm^-1",
"nm^-1",
"\u03bcm^-1",
"mm^-1",
"dm^-1",
"m^-1",
"km^-1",
"Mm^-1",
"Gm^-1"
]
}
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the inverse of the front surface curvature radius as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "front_surface_curvature",
"type": "object"
},
"front_surface_finish": {
"description": "The field that allows to describe in text (i.e. string) form the peculiarities of sample's front surface finish. For example \"polished\", \"sand blasted\", \"hardened\" etc.",
"title": "front_surface_finish",
"type": "string"
},
"front_surface_roughness": {
"additionalProperties": false,
"description": "An object that describes front surface roughness as arithmetical mean deviation of surface height from its mean value usually denotes as Ra (see https://en.wikipedia.org/wiki/Surface_roughness for more information). It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the measurement sample's front surface roughness as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the measurement sample's front surface roughness as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"cm\", \"m\" \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"cm",
"m",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the measurement sample's front surface roughness as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"cm\" and \"m\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"cm",
"m"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the measurement sample's front surface roughness as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "front_surface_roughness",
"type": "object"
},
"manufacturer": {
"description": "Name of the company or person that produced the sample which BRDF was measured. As a text (i.e. string).",
"title": "manufacturer",
"type": "string"
},
"manufacturing_method": {
"description": "The field allowing to briefly describe the peculiarities of manufacturing method that was used to produce the sample which BRDF was measured. As a text (i.e. string).",
"title": "manufacturing_method",
"type": "string"
},
"materials": {
"description": "An array with unique \"material\" objects that describes different materials from which measurement sample was made.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/sample_material_schema_v1.0.json",
"description": "An object that describes a single material from which measurement sample was produced (either partially or fully).",
"title": "material",
"type": "object"
},
"title": "materials",
"type": "array",
"uniqueItems": true
},
"model": {
"description": "Model name or code given to the sample by the manufacturer. As a text (i.e. string).",
"title": "model"
},
"name": {
"description": "Name, laboratory marking or short description of the sample as a text (i.e. string).",
"title": "name",
"type": "string"
},
"origin_location": {
"description": "The field that allows to specify in the text (i.e. string) form the location of the origin of coordinate system associated with the sample which BRDF was measured. Usually it is the \"center of the sample\" or one of its corners like \"upper left corner\" in respect to marking on the sample.",
"title": "origin_location",
"type": "string"
},
"properties_symmetry": {
"description": "The field allowing to specify in the text (i.e. string) form known symmetry of the reflective properties of the sample. For example, sample's BRDF can be \"isotropic\" or \"bilaterally symmetric\" in respect to plane of incidence.",
"title": "properties_symmetry",
"type": "string"
},
"provenance": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/provenance_json_schema_v1.0.json",
"description": "An object describing the origin of the sample which BRDF was measured.",
"title": "provenance",
"type": "object"
},
"shape": {
"description": "The field that allows to describe shape of the sample which BRDF was measured in a text (i.e. string) form.",
"title": "shape",
"type": "string"
},
"specular_reflectance": {
"additionalProperties": false,
"description": "An object describing specular reflectance of the physical or virtual sample which BRDF was measured or simulated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the specular reflectance of the sample which BRDF was measured as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the specular reflectance of the sample which BRDF was measured as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the specular reflectance of the sample which BRDF was measured as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the specular reflectance of the sample which BRDF was measured as a positive number from 0 to 100.",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "specular_reflectance",
"type": "object"
},
"specular_transmittance": {
"additionalProperties": false,
"description": "An object describing specular transmittance of the physical or virtual sample which BRDF was measured or simulated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the specular transmittance of the sample which BRDF was measured as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the specular transmittance of the sample which BRDF was measured as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the specular transmittance of the sample which BRDF was measured as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the specular transmittance of the sample which BRDF was measured as a positive number from 0 to 100.",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "specular_transmittance",
"type": "object"
},
"temperature": {
"additionalProperties": false,
"description": "An object describing temperature of the sample which BRDF was measured. Note that in some cases it might be different from ambient room temperature since sample can be heated or cooled during BRDF measurement. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"else": {
"properties": {
"value": {
"minimum": 0
}
}
},
"if": {
"properties": {
"unit": {
"const": "\u00b0C"
}
}
},
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the temperature of the sample which BRDF was measured as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the temperature of the sample which BRDF was measured as a string that can have values \"K\", \"kK\", \"\u00b0C\" or \"%\".",
"enum": [
"K",
"kK",
"\u00b0C",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the temperature of the sample which BRDF was measured as a string that can have values \"K\", \"kK\" or \"\u00b0C\".",
"enum": [
"K",
"kK",
"\u00b0C"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the temperature of the sample which BRDF was measured as a number. In \"\u00b0C\" units the minimum allowed value is \u2212273.15 (i.e. x \u2265 -273.5), while in \"K\" and \"kK\" minimum allowed value is 0 (i.e. x \u2265 0).",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"then": {
"properties": {
"value": {
"minimum": -273.15
}
}
},
"title": "temperature",
"type": "object"
},
"total_reflectance": {
"additionalProperties": false,
"description": "An object describing total hemispherical reflectance of the physical or virtual sample which BRDF was measured or simulated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the total hemispherical reflectance of the sample which BRDF was measured as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the total hemispherical reflectance of the sample which BRDF was measured as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the total hemispherical reflectance of the sample which BRDF was measured as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the total hemispherical reflectance of the sample which BRDF was measured as a positive number from 0 to 100.",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "total_reflectance",
"type": "object"
},
"total_transmittance": {
"additionalProperties": false,
"description": "An object describing total hemispherical transmittance of the physical or virtual sample which BRDF was measured or simulated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the total hemispherical transmittance of the sample which BRDF was measured as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the total hemispherical transmittance of the sample which BRDF was measured as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the total hemispherical transmittance of the sample which BRDF was measured as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the total hemispherical transmittance of the sample which BRDF was measured as a positive number from 0 to 100.",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "total_transmittance",
"type": "object"
},
"treatment": {
"description": "The field that allowing to briefly describe the peculiarities of any special treatment or preparation procedure that was executed before the measurement of sample's BRDF. s a text (i.e. string).",
"title": "treatment",
"type": "string"
},
"type": {
"description": "Type of the physical or virtual sample according to its reflective properties as a string. For example \"diffuse reflectance sample\", \"specular reflectance sample\" etc.",
"title": "type",
"type": "string"
},
"zero_azimuth_location": {
"description": "The field that allows in the text (i.e. string) form to describe the reference point/direction/marking on the sample that helps to locate plane where illumination and viewing azimuthal angles equal to zero.",
"title": "zero_azimuth_location",
"type": "string"
}
},
"required": [
"name",
"type",
"dimensions",
"shape",
"zero_azimuth_location"
],
"title": "sample"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | 2021-11-26T20:30:56 | BRDF_JSON_schema/polarization_alterant_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/polarization_alterant_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing a single polarization altering element or an assembly that included to the set-up used for (usually polarimetric) BRDF measurements. Note that the same object describes polarization altering elements integrated to illumination or detection systems.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the polarization altering element included to the of the set-up used for (usually polarimetric) BRDF measurements that cannot be presented within \"polarization_alterant\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "A section that allows to provide in the form of text (i.e. string) any comments relevant to polarization altering element included to the set-up used for (usually polarimetric) BRDF measurements.",
"title": "comments",
"type": "string"
},
"damage_treshold": {
"additionalProperties": false,
"description": "The field describing maximum power at which polarization altering element can be operated. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the maximum optical power at which polarization altering element can be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\".",
"pattern": "^[pn\u03bcmkMG]?W$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the maximum power at which polarization altering element can be operated as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "damage_treshold",
"type": "object"
},
"data_links": {
"description": "An array with links to any relevant technical information regarding polarization altering element included to the set-up used for (usually polarimetric) BRDF measurements.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"design_wl": {
"additionalProperties": false,
"description": "An object describing wavelength at which polarization altering element is most effective by design.",
"properties": {
"unit": {
"description": "Unit of the wavelength at which polarization altering element is most effective as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[n\u03bc]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the wavelength at which polarization altering element is most effective as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "design_wl",
"type": "object"
},
"extinction_ratio": {
"additionalProperties": false,
"description": "The field to describe typical extinction ratio of polarizer used for altering polarization of illumination. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Polarizer's extinction ratio is unitless and unit property should be filled with empty string \"\".",
"pattern": "",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the polarizer's extinction ratio as a number. Note that extinction ratio is usually presented as X : 1, but since 1 is a constant only X is the value requested here.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "extinction_ratio",
"type": "object"
},
"manufacturer": {
"description": "Manufacturer of the polarization altering element as a text/string.",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Field describing the material of polarization altering element as a text/string.",
"title": "material",
"type": "string"
},
"model": {
"description": "Model name of the polarization altering element given by manufacturer. As a text/string.",
"title": "model",
"type": "string"
},
"name": {
"description": "Short name of an element used for alteration of illumination or detection polarization state. As a text/string.",
"title": "name",
"type": "string"
},
"type": {
"description": "Type of the polarization altering element. For example, \"linear polarizer\", \"quater-wave plate\", \"half-wave plate\", \"retarder\", \"depolarizer\" etc. As a text/string.",
"title": "type",
"type": "string"
},
"wl_range": {
"additionalProperties": false,
"description": "Wavelength range within which polarization altering element is designed to be operated.",
"properties": {
"max_value": {
"description": "Numerical value of the longest wavelength at which polarization altering element can be used as a number.",
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of shortest wavelength at which polarization altering element can be used as a number.",
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Unit of the shortest and longest wavelengths at which polarization altering element can be used as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[\u03bcn]?m$",
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "wl_range",
"type": "object"
}
},
"required": [
"name",
"type"
],
"title": "polarization_alterant",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | d866db6b4585ac22db103f3579b8ad04a756216b | 2021-11-26T18:53:57 | BRDF_JSON_schema/sample_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/sample_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing the physical or virtual sample which BRDF was measured or simulated.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"instrumentation\" object) describing any information relevant to the instrumentation used for BRDF measurement. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"back_surface_curvature": {},
"back_surface_finish": {},
"back_surface_roughness": {},
"cleaning_procedure": {},
"comments": {
"description": "",
"title": "name",
"type": "string"
},
"data_links": {
"description": "",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"dimensions": {},
"front_surface_curvature": {},
"front_surface_finish": {},
"front_surface_roughness": {},
"manufacturer": {
"description": "",
"title": "name",
"type": "string"
},
"manufacturing_method": {},
"materials": {
"description": "An array with objects that describes different materials from which measurement sample was made.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/sample_material_schema_v1.0.json",
"description": "An object that describes a single material from which measurement sample was produced (either partially or fully).",
"name": "material",
"type": "object"
},
"name": "materials",
"type": "array"
},
"model": {},
"name": {
"description": "",
"title": "name",
"type": "string"
},
"origin_location": {},
"photo_links": {},
"properties_symmetry": {},
"provenance": {},
"shape": {},
"specular_reflectance": {},
"specular_transmittance": {},
"temperature": {},
"total_reflectance": {},
"total_transmittance": {},
"treatment": {},
"type": {
"description": "",
"title": "name",
"type": "string"
},
"zero_azimuth_location": {}
},
"required": [
"name",
"type",
"dimensions",
"shape",
"zero_azimuth_location"
],
"title": "sample"
} | MIT | en |
BiRD-project/BiRD_view | d866db6b4585ac22db103f3579b8ad04a756216b | 2021-11-26T18:53:57 | BRDF_JSON_schema/sensor_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/sensor_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing single optical sensor of detection system of the instrument used for BRDF measurements.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the optical sensor used for BRDF measurements that cannot be presented within \"sensor\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"bias_voltage": {
"additionalProperties": false,
"description": "An object describing bias voltage applied applied to the optical sensor during BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the bias voltage applied applied to the optical sensor as a string that can have values \"pV\", \"nV\", \"\u03bcV\", \"mV\", \"V\", \"kV\", \"MV\" or \"GV\".",
"pattern": "^[pn\u03bcmkMG]?V$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the bias voltage applied applied to the optical sensor as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "bias_voltage",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding optical sensor used for BRDF measurements as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"damage_threshold": {
"additionalProperties": false,
"description": "Field describing maximal optical power at which optical sensor is designed to be operated. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the maximal optical power at which optical sensor is designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\".",
"pattern": "^[pn\u03bcmkMG]?W$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the maximal optical power at which optical sensor is designed to be operated as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "damage_threshold"
},
"dark_signal": {
"additionalProperties": false,
"description": "An object describing the level of signal when sensor is not exposed to any radiation (in Ampers (A) or Volts (V)). It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical sensor's dark current as a string that can have values \"pA\", \"nA\", \"\u03bcA\", \"mA\", \"A\", \"kA\", \"MA\", \"GA\" or \"pV\", \"nV\", \"\u03bcV\", \"mV\", \"V\", \"kV\", \"MV\" or \"GV\".",
"oneOf": [
{
"pattern": "^[pn\u03bcmkMG]?A$"
},
{
"pattern": "^[pn\u03bcmkMG]?V$"
}
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical sensor's dark current as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "dark_signal",
"type": "object"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding optical sensor used for BRDF measurements. Array of URL links as a text (i.e.string).",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/dimensions_json_schema_v1.0.json",
"description": "Dimensions of the photosensitive part of the sensor included in BRDF measurement set-up.",
"required": [
"area"
],
"title": "dimensions",
"type": "object"
},
"linearity": {
"additionalProperties": false,
"description": "An object describing the maximal ratio between responsivity around different optical powers that sensor can sense in case of fixed detection wavelength. It is defined as min_responsivity / max_responsivity for power range used for BRDF measurements. \"nonlinearity\" object has keys keys \"value\" and \"unit\"",
"properties": {
"unit": {
"description": "Unit of the optical sensor's linearity as a string that can have values \"%\" or unitless i.e. \"\".",
"pattern": "^%?$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical sensor's linearity as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "linearity",
"type": "object"
},
"manufacturer": {
"description": "Manufacturer of the optical sensor used in BRDF measurement set-up as text (i.e. string).",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Light sensing material used in optical sensor included in BRDF measurement set-up as text (i.e. string). For example \"Si\", \"InGaAs\" etc.",
"title": "material",
"type": "string"
},
"model": {
"description": "Model of the optical sensor used in BRDF measurement set-up as text (i.e. string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the optical sensor used in BRDF measurement set-up as text (i.e. string).",
"title": "name",
"type": "string"
},
"operating_temperature": {
"additionalProperties": false,
"description": "Field for providing the temperature at which light sensor was operated during BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the temperature at which light sensor was operated as a string that can have values \"K\", \"kK\" or \"\u00b0C\".",
"oneOf": [
{
"pattern": "^[k]?K$"
},
{
"pattern": "\u00b0C"
}
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the temperature at which light sensor was operated as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "operating_temperature",
"type": "object"
},
"power_range": {
"additionalProperties": false,
"description": "An object describing the optical power range in which optical sensor can be usually applied. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the highest optical power sensor can detect as a number.",
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the lowest optical power sensor can detect as a number.",
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Unit of the lowest and highest power that optical sensor can detect as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\"",
"pattern": "^[GMkm\u03bcnp]?W$",
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "power_range",
"type": "object"
},
"responsivity": {
"additionalProperties": false,
"description": "Typical or average responsivity of optical sensor in A/W. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the set typical or average responsivity of optical sensor as a string that can have values \"A/W\".",
"pattern": "A/W",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the typical or average responsivity of optical sensor as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "responsivity",
"type": "object"
},
"shape": {
"description": "Shape of the photosensitive area of optical sensor included in BRDF measurement set-up as text (i.e. string).",
"title": "shape",
"type": "string"
},
"spectral_response_range": {
"additionalProperties": false,
"description": "An object that specifies wavelength range for sensing of which optical sensor can be applied. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the longest wavelength that optical sensor can sense as a number.",
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the shortest wavelength that optical sensor can sense as a number.",
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Unit of the shortest and longest wavelengths that optical sensor can sense as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[\u03bcn]?m$",
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "spectral_response_range",
"type": "object"
},
"type": {
"description": "Type of the optical sensor used in BRDF measurement set-up as text (i.e. string). For example \"photodiod\", \"CCD-camera\", \"photomultiplyer\" etc.",
"title": "type",
"type": "string"
},
"uniformity": {
"additionalProperties": false,
"description": "An object describing the ratio of minimum and maximum response signals measured at different points of the detector area in case of fixed wavelength and power. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the uniformity of the optical sensor as a string that can have values \"%\" or unitless i.e. \"\".",
"pattern": "^%?$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the uniformity of the optical sensor as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uniformity",
"type": "object"
}
},
"required": [
"name",
"spectral_response_range"
],
"title": "sensor",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | 2021-11-26T20:30:56 | BRDF_JSON_schema/source_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/source_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object that describes illumination source that was used for BRDF measurements.",
"oneOf": [
{
"required": [
"name",
"type",
"power",
"wl_range"
]
},
{
"required": [
"name",
"type",
"power",
"central_wl"
]
}
],
"properties": {
"CIE_notation": {
"description": "Field that allows to classify light source according to CIE abbreviations for standard illuminants. It accommodates text (i.e.string) values corresponding only to CIE abbreviations. For information about values see https://en.wikipedia.org/wiki/Standard_illuminant.",
"enum": [
"A",
"B",
"C",
"D50",
"D55",
"D65",
"D75",
"D93",
"E",
"F1",
"F2",
"F3",
"F4",
"F5",
"F6",
"F7",
"F8",
"F9",
"F10",
"F11",
"F12",
"LED-B1",
"LED-B2",
"LED-B3",
"LED-B4",
"LED-B5",
"LED-B1",
"LED-BH1",
"LED-RGB1",
"LED-V2"
],
"title": "CIE_notation",
"type": "string"
},
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the illumination source of the instrument that cannot be presented within \"source\" object properties provided by schema. Adhoc section can contain all types of entries except new objects",
"title": "adhoc_section",
"type": "object"
},
"central_wl": {
"additionalProperties": false,
"description": "Property describing the central wavelength of illumination light source. It is most relevant for lasers and narrow-band LEDs. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the illumination source central wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[\u03bcn]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source central wavelength as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "central_wl",
"type": "object"
},
"color_temperature": {
"additionalProperties": false,
"description": "The field allowing to specify color temperature of black-body radiator if it was used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the illumination source color temperature as a string that can have values \"K\" or \"kK\".",
"pattern": "^[k]?K$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source color temperature as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "color_temperature",
"type": "object"
},
"comments": {
"description": "A section that allows to add any additional information regarding illumination source that was used for BRDF measurements. Comments should be presented as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An object that allows to refer to available external technical information regarding light source used for BRDF measurements. Array of string URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"manufacturer": {
"description": "The property that allows to specify the manufacturer of the light source that used for BRDF measurements. For example, company or workshop name written as a text (i.e.string)",
"title": "manufacturer",
"type": "string"
},
"model": {
"description": "The property that allows to specify the model of the illumination source that was used for BRDF measurements. It can be written as a text (i.e.string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the light source that was used for BRDF measurements. Can be written in a free form as a text (string).",
"title": "name",
"type": "string"
},
"operating_current": {
"additionalProperties": false,
"description": "An object describing the current at which illumination source was operated. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the illumination source operating current as a string that can have values \"pA\", \"nA\", \"\u03bcA\", \"mA\", \"A\", \"kA\", \"MA\" or \"GA\".",
"pattern": "^[pn\u03bcmkMG]?A$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source operating current as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "operating_current",
"type": "object"
},
"operating_temperature": {
"additionalProperties": false,
"description": "Field for providing the temperature at which light source was operated. Might be relevant in case of cooled light sources or lasers/LEDs which central wavelength can change with temperature. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the illumination source operating temperature as a string that can have values \"K\", \"kK\" or \"\u00b0C\".",
"enum": [
"K",
"kK",
"\u00b0C"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source operating temperature as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "operating_temperature",
"type": "object"
},
"operating_voltage": {
"additionalProperties": false,
"description": "An object describing the voltage at which illumination source was operated. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the illumination source operating voltage as a string that can have values \"pV\", \"nV\", \"\u03bcV\", \"mV\", \"V\", \"kV\", \"MV\" or \"GV\".",
"pattern": "^[pn\u03bcmkMG]?V$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source operating voltage as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "operating_voltage",
"type": "object"
},
"power": {
"additionalProperties": false,
"description": "The property describing integral power of the illumination source in power units like W, kW, mW etc. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the illumination source power as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\"",
"pattern": "^[GMkm\u03bcnp]?W$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source power as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "power",
"type": "object"
},
"type": {
"description": "The field that specifies what type of illumination source was used for BRDF measurements. For example it can be laser, incandescent lamp, black-body, LED etc. String values are allowed.",
"title": "type",
"type": "string"
},
"wl_range": {
"additionalProperties": false,
"description": "An object allowing to specify the wavelength range within which illumination source radiates. Most relevant for wide-band sources as incandescent lamps, fluorescent lamps, black-bodies etc. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the illumination source longest wavelength as a number.",
"title": "value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the illumination source shortest wavelength as a number.",
"title": "value",
"type": "number"
},
"unit": {
"description": "Unit of the illumination source shortest and longest wavelengths as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[\u03bcn]?m$",
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "wl_range",
"type": "object"
}
},
"title": "source",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | fb0320184ea19ac451738f8010e1d3a8138c5d6b | 2021-12-12T19:43:53 | BRDF_JSON_schema/data_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/data_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with properties/fields that allow to describe variables of BRDF function and provide their values alongside BRDF values themselves.",
"properties": {
"BRDF": {
"additionalProperties": false,
"description": "An object describing and providing the bidirectional reflectance distribution function \"BRDF\" values as defined by F. E. Nicodemus. I.e. BRDF values are measured in sr^\u22121 (1/sr) and can vary from 0 sr^\u22121 to inf. sr^\u22121.",
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to bidirectional reflectance distribution function \"BRDF\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Bidirectional reflectance distribution function.",
"description": "The field providing the short description of the \"BRDF\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "BRDF",
"description": "The field providing the short name of the bidirectional reflectance distribution function as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of \"BRDF\" values. It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of \"BRDF\" values as a string that can have values: \"1/sr\", \"sr^-1\" and \"%\".",
"enum": [
"1/sr",
"sr^-1",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of \"BRDF\" values as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the \"BRDF\" values. Allowed values are strings \"1/sr\" or \"sr^-1\".",
"enum": [
"1/sr",
"sr^-1"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of measured or simulated \"BRDF\" values corresponding to set of parameters stored in other properties of \"data\" object (i.e. objects under \"data\" object keys describing BRDF function parameters and their values). Array can contain only zero (0) inclusive positive numbers. Shortly: 0 \u2264 x < inf.",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"title": "BRDF",
"type": "object"
},
"adhoc_variables": {
"additionalProperties": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/adhoc_varible_json_schema_v1.0.json",
"description": "An object describing a single additional BRDF variable defined by the user. It should have at least \"description\", \"unit\" and \"values\" fields. It is also advised to place \"adhoc_variable\" object under such \"adhoc_variables\" key that would shortly describe the nature of the user defined variable.",
"title": "adhoc_variable",
"type": "object"
},
"description": "An object containing properties/fields describing user defined BRDF variables. For example, solid angle or illumination/observation spot spatial coordinates if they were varied during BRDF measurements. Most successful variable definitions might become standard definitions and will be included to default parameters of future versions of universal BRDF file format schema.",
"title": "adhoc_variables",
"type": "object"
},
"phi_i": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to illumination light incidence azimuthal angle \"phi_i\" and provide its values. By definition of BRDF function first presented by F. E. Nicodemus, the illumination incidence azimuthal angle \"phi_i\" can be varied from 0\u00b0 to 360\u00b0 (0 to \u03c0/2 rad) around the sample's normal starting from the direction defined by the user (mark on the sample) and ending at the direction. To avoid overlapping data present file format does not allow to illumination incidence azimuthal angle \"phi_i\" to have values equal or greater than 360\u00b0.",
"else": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 360
}
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to illumination light incidence azimuthal angle \"phi_i\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Illumination light/beam incidence azimuthal angle.",
"description": "The field providing the short description of the \"phi_i\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "phi_i",
"description": "The field providing the short name of the illumination light incidence azimuthal angle variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the illumination light incidence azimuthal angle \"phi_i\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the illumination light incidence azimuthal angle \"phi_i\" as a string that can have values: \"rad\", \"deg\", \"\u00b0\" and \"%\".",
"enum": [
"rad",
"deg",
"\u00b0",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the illumination light incidence azimuthal angle \"phi_i\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the illumination light incidence azimuthal angle \"phi_i\". Allowed values are strings \"rad\", \"deg\" or \"\u00b0\".",
"enum": [
"rad",
"deg",
"\u00b0"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the illumination light incidence azimuthal angle \"phi_i\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers up to maximal value of 360\u00b0 (i.e. up to 2\u03c0 radians) that is excluded. Shortly: 0 \u2264 x < 360\u00b0 (or 2\u03c0).",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 3.141593
}
}
}
},
"title": "phi_i",
"type": "object"
},
"phi_r": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to reflected light observation azimuthal angle \"phi_r\" and provide its values. By definition of BRDF function first presented by F. E. Nicodemus, the reflected light observation azimuthal angle \"phi_r\" can be varied from 0\u00b0 to 360\u00b0 (0 to \u03c0/2 rad) around the sample's normal starting from the direction defined by the user (mark on the sample) and ending at the direction. To avoid overlapping data present file format does not allow to reflected light observation azimuthal angle \"phi_r\" to have values equal or greater than 360\u00b0.",
"else": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 360
}
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to reflected light observation azimuthal angle \"phi_r\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Reflected light/beam observation azimuthal angle.",
"description": "The field providing the short description of the \"phi_r\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "phi_r",
"description": "The field providing the short name of the reflected light observation azimuthal angle variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the reflected light observation azimuthal angle \"phi_r\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the reflected light observation azimuthal angle \"phi_r\" as a string that can have values: \"rad\", \"deg\", \"\u00b0\" and \"%\".",
"enum": [
"rad",
"deg",
"\u00b0",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the reflected light observation azimuthal angle \"phi_r\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the reflected light observation azimuthal angle \"phi_r\". Allowed values are strings \"rad\", \"deg\" or \"\u00b0\".",
"enum": [
"rad",
"deg",
"\u00b0"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the reflected light observation azimuthal angle \"phi_r\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers up to maximal value of 360\u00b0 (i.e. up to 2\u03c0 radians) that is excluded. Shortly: 0 \u2264 x < 360\u00b0 (or 2\u03c0).",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"index",
"type",
"unit"
],
"then": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 3.141593
}
}
}
},
"title": "phi_r",
"type": "object"
},
"polarization_i": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to the illumination light polarization state \"polarization_i\" and provide its values. Polarization state can be presented using two different notations: sp-notation for the simplest (linear) cases of polarization state and intensity-normalized Stokes vector notation (https://en.wikipedia.org/wiki/Stokes_parameters) allowing to present arbitrary polarization state as well as degree of polarization. In both cases polarization coordinate frame is defined in respect to plane of incidence (https://en.wikipedia.org/wiki/Plane_of_incidence) where polarized light with its electric field along the plane of incidence is denoted as p-polarized and have Stokes's vector corresponding to vertical linear polarization state [1, -1, 0, 0] i.e. vertical polarization orientation changes with sample's normal orientation. S-polarized light electric field is normal to the plane of incidence and corresponding Stokes vector denotes horizontal linear polarization [1, 1, 0, 0]. If sample is illuminated under 0\u00b0 illumination zenith angle \"theta_i\", then it is advised to define plane of incidence using sample's normal and 0\u00b0 azimuthal angle direction (usually marked on the sample). Any specific coordinate frame definitions can be noted in the \"comments\" field of \"polarization_i\" object.",
"else": {
"properties": {
"values": {
"items": {
"items": false,
"prefixItems": [
{
"const": 1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
}
],
"type": "array"
}
}
}
},
"if": {
"properties": {
"notation": {
"const": "sp"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to illumination light polarization state \"polarization_i\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Illumination light polarization state.",
"description": "The field providing the short description of the \"polarization_i\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "polarization_i",
"description": "The field providing the short name of the illumination light polarization state variable as a string.",
"title": "name",
"type": "string"
},
"notation": {
"description": "The field that allows to specify the notation used to describe illumination light polarization state \"polarization_i\" as a string. Allowed values are strings \"sp\" and \"nStokes\" corresponding to sp-notation and intensity-normalized Stokes notation (i.e. Stokes vector first component denoting total intensity of the beam is always equal to 1 and all vector parameters are unitless).",
"enum": [
"sp",
"inStokes"
],
"title": "notation",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the illumination light polarization state \"polarization_i\" presented in intensity-normalized Stokes notation. It is an object with \"values\" and \"units\" keys.",
"properties": {
"units": {
"description": "An array that specifies measurement units of the non-varying uncertainties of each Stokes' vector components (4 in total) presented as a string that can have values: \"\" and \"%\".",
"items": false,
"prefixItems": [
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
}
],
"title": "units",
"type": "array"
},
"values": {
"description": "An array with numerical values of non-varying uncertainties of each Stokes' vector components (4 in total) presented as a zero (0) inclusive positive numbers (0 \u2264 x < inf).",
"items": false,
"prefixItems": [
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
}
],
"title": "values",
"type": "array"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"values": {
"description": "An array containing numerical values of the illumination light polarization state \"polarization_i\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain either strings with values of \"p\", \"s\" and \"u\" corresponding to p-, s-polarized and unpolarized states or arrays (Stokes vectors) that have 4 numerical components from which first is always 1 and 3 others can vary from -1 to 1 (see intensity-normalized Stokes vector definition https://en.wikipedia.org/wiki/Polarization_(waves)).",
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"enum": [
"s",
"p",
"u"
],
"type": "string"
}
}
}
},
"title": "polarization_i",
"type": "object"
},
"polarization_r": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to the reflected light observation polarization state \"polarization_r\" and provide its values. Polarization state can be presented using two different notations: sp-notation for the simplest (linear) cases of polarization state and intensity-normalized Stokes vector notation (https://en.wikipedia.org/wiki/Stokes_parameters) allowing to present arbitrary polarization state as well as degree of polarization. In both cases polarization coordinate frame is defined in respect to plane of reflectance (i.e. plane defined by the direction of reflectance observation and measurement sample's normal similarly to the plane of incidence - https://en.wikipedia.org/wiki/Plane_of_incidence) where polarized light with its electric field along the plane of reflectance is denoted as p-polarized and have Stokes's vector corresponding to vertical linear polarization state [1, -1, 0, 0] i.e. vertical polarization orientation changes with sample's normal orientation. S-polarized light electric field is normal to the plane of reflectance and corresponding Stokes vector denotes horizontal linear polarization [1, 1, 0, 0]. If sample is observed under 0\u00b0 reflectance observation zenith angle \"theta_r\", then it is advised to define plane of reflectance using sample's normal and 0\u00b0 azimuthal angle direction (usually marked on the sample). Any specific coordinate frame definitions can be noted in the \"comments\" field of \"polarization_r\" object.",
"else": {
"properties": {
"values": {
"items": {
"items": false,
"prefixItems": [
{
"const": 1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
}
],
"type": "array"
}
}
}
},
"if": {
"properties": {
"notation": {
"const": "sp"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to reflected light observation polarization state \"polarization_r\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Reflected light observation polarization state.",
"description": "The field providing the short description of the \"polarization_r\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "polarization_r",
"description": "The field providing the short name of the reflected light observation polarization state variable as a string.",
"title": "name",
"type": "string"
},
"notation": {
"description": "The field that allows to specify the notation used to describe reflected light observation polarization state \"polarization_r\" as a string. Allowed values are strings \"sp\" and \"nStokes\" corresponding to sp-notation and intensity-normalized Stokes notation (i.e. Stokes vector first component denoting total intensity of the beam is always equal to 1 and all vector parameters are unitless).",
"enum": [
"sp",
"inStokes"
],
"title": "notation",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the reflected light observation polarization state \"polarization_r\" presented in intensity-normalized Stokes notation. It is an object with \"values\" and \"units\" keys.",
"properties": {
"units": {
"description": "An array that specifies measurement units of the non-varying uncertainties of each Stokes' vector components (4 in total) presented as a string that can have values: \"\" and \"%\".",
"items": false,
"prefixItems": [
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
}
],
"title": "units",
"type": "array"
},
"values": {
"description": "An array with numerical values of non-varying uncertainties of each Stokes' vector components (4 in total) presented as a zero (0) inclusive positive numbers (0 \u2264 x < inf).",
"items": false,
"prefixItems": [
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
}
],
"title": "values",
"type": "array"
}
},
"required": [
"values",
"units"
],
"title": "uncertainty",
"type": "object"
},
"values": {
"description": "An array containing numerical values of the reflected light observation polarization state \"polarization_r\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain either strings with values of \"p\", \"s\" and \"u\" corresponding to p-, s-polarized and unpolarized states or arrays (Stokes vectors) that have 4 numerical components from which first is always 1 and 3 others can vary from -1 to 1 (see intensity-normalized Stokes vector definition https://en.wikipedia.org/wiki/Polarization_(waves)).",
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"enum": [
"s",
"p",
"u"
],
"type": "string"
}
}
}
},
"title": "polarization_r",
"type": "object"
},
"theta_i": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to illumination light incidence zenith angle \"theta_i\" and provide its values. By definition of BRDF function first presented by F. E. Nicodemus, the illumination incidence zenith angle \"theta_i\" can be varied from 0\u00b0 to 90\u00b0 (0 to \u03c0/2 rad) starting from the measurements sample's normal and ending at the surface parallel to sample's surface.",
"else": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 90
}
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to illumination light incidence zenith angle \"theta_i\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Illumination light/beam incidence zenith angle.",
"description": "The field providing the short description of the \"theta_i\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "theta_i",
"description": "The field providing the short name of the illumination light incidence zenith angle variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the illumination light incidence zenith angle \"theta_i\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the illumination light incidence zenith angle \"theta_i\" as a string that can have values: \"rad\", \"deg\", \"\u00b0\" and \"%\".",
"enum": [
"rad",
"deg",
"\u00b0",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the illumination light incidence zenith angle \"theta_i\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the illumination light incidence zenith angle \"theta_i\". Allowed values are strings \"rad\", \"deg\" or \"\u00b0\".",
"enum": [
"rad",
"deg",
"\u00b0"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the illumination light incidence zenith angle \"theta_i\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers up to maximal value of 90\u00b0 (i.e. up to 2/2 radians). Shortly: 0 \u2264 x \u2264 90\u00b0 (or \u03c0/2).",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 1.5708
}
}
}
},
"title": "theta_i",
"type": "object"
},
"theta_r": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to reflected light observation zenith angle \"theta_r\" and provide its values. By definition of BRDF function first presented by F. E. Nicodemus, the reflected light observation zenith angle \"theta_r\" can be varied from 0\u00b0 to 90\u00b0 (0 to \u03c0/2 rad) starting from the measurements sample's normal and ending at the surface parallel to sample's surface.",
"else": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 90
}
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to reflected light observation zenith angle \"theta_r\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Reflected light/beam observation zenith angle.",
"description": "The field providing the short description of the \"theta_r\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "theta_r",
"description": "The field providing the short name of the reflected light observation zenith angle variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the reflected light observation zenith angle \"theta_r\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the reflected light observation zenith angle \"theta_r\" as a string that can have values: \"rad\", \"deg\", \"\u00b0\" and \"%\".",
"enum": [
"rad",
"deg",
"\u00b0",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the reflected light observation zenith angle \"theta_r\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the reflected light observation zenith angle \"theta_r\". Allowed values are strings \"rad\", \"deg\" or \"\u00b0\".",
"enum": [
"rad",
"deg",
"\u00b0"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the reflected light observation zenith angle \"theta_r\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers up to maximal value of 90\u00b0 (i.e. up to 2/2 radians). Shortly: 0 \u2264 x \u2264 90\u00b0 (or \u03c0/2).",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 1.5708
}
}
}
},
"title": "theta_r",
"type": "object"
},
"uBRDF": {
"additionalProperties": false,
"description": "An object that describes the variable corresponding to non-constant uncertainty of bidirectional reflectance distribution function values \"uBRDF\". I.e. BRDF associated uncertainty that varies with BRDF function parameters/variables. It is a complex quantity that might be affected by the uncertainties of all the variables used for BRDF estimation and most probably is unique for different measurement instruments and simulation models. BRDF uncertainty should be presented in sr^-1 (1/sr) if it is absolute or in % if relative.",
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to uncertainty of the bidirectional reflectance distribution function \"BRDF\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Uncertainty of bidirectional reflectance distribution function.",
"description": "The field providing the short description of the \"uBRDF\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "BRDF",
"description": "The field providing the short name of the uncertainty of bidirectional reflectance distribution function as a string.",
"title": "name",
"type": "string"
},
"unit": {
"description": "The field that allows to specify measurement unit uncertainty of bidirectional reflectance distribution function values \"uBRDF\" as a string that can have values: \"1/sr\", \"sr^-1\" and \"%\".",
"enum": [
"1/sr",
"sr^-1",
"%"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the measured or simulated \"BRDF\" uncertainty estimated for each set of parameters stored in other properties of \"data\" object (i.e. objects under \"data\" object keys describing BRDF function parameters and their values). Array can contain only zero (0) inclusive positive numbers. Shortly: 0 \u2264 x < inf.",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"title": "uBRDF",
"type": "object"
},
"wavelength_i": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to illumination light wavelength \"wavelength_i\" and provide its values. This parameter is relevant for spectral BRDF measurements where monochromatic illumination is used and its wavelength is set before the light hits the sample. Wavelength can be presented in nanometers \"nm\" or micrometers \"\u03bcm\".",
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to illumination light wavelength \"wavelength_i\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Illumination light wavelength.",
"description": "The field providing the short description of the \"wavelength_i\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"cont": "wavelength_i",
"description": "The field providing the short name of the illumination light wavelength variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the illumination light wavelength \"wavelength_i\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the illumination light wavelength \"wavelength_i\" as a string that can have values: \"nm\", \"\u03bcm\" and \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the illumination light wavelength \"wavelength_i\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the illumination light wavelength \"wavelength_i\". Allowed values are strings \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the illumination light wavelength \"wavelength_i\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers. Shortly: 0 \u2264 x < inf.",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"title": "wavelength_i",
"type": "object"
},
"wavelength_r": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to the observed reflected light wavelength \"wavelength_r\" and provide its values. This parameter is relevant for spectral BRDF measurements where light reflected from the sample is spectrally resolved prior its detection by the sensor. Wavelength can be presented in nanometers \"nm\" or micrometers \"\u03bcm\".",
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to the observed reflected light wavelength \"wavelength_r\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Observed reflected light wavelength.",
"description": "The field providing the short description of the \"wavelength_r\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"cont": "wavelength_i",
"description": "The field providing the short name of the observed reflected light wavelength variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the observed reflected light wavelength \"wavelength_r\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the observed reflected light wavelength \"wavelength_r\" as a string that can have values: \"nm\", \"\u03bcm\" and \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the observed reflected light wavelength \"wavelength_r\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the observed reflected light wavelength \"wavelength_r\". Allowed values are strings \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the observed reflected light wavelength \"wavelength_r\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers. Shortly: 0 \u2264 x < inf.",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"title": "wavelength_r",
"type": "object"
}
},
"required": [
"theta_i",
"phi_i",
"theta_r",
"phi_r",
"BRDF"
],
"title": "data",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | 2021-12-02T01:06:05 | BRDF_JSON_schema/instrumentation_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/instrumentation_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing the setup or instrumentation as well as its parameters that were used to measure BRDF data presented in the file.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"instrumentation\" object) describing any information relevant to the instrumentation used for BRDF measurement. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "The field for providing in a text/string form any additional information relevant to instrumentation used for BRDF measurement.",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding setup or instrumentation used for BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"detection_system": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/detection_system_json_schema_v1.0.json",
"description": "An object with keys describing detector and its accompanying relevant optical components and and settings.",
"title": "detection",
"type": "object"
},
"firmware_version": {
"description": "Version of the firmware used to operate the instrument or system during the measurement of BRDF data presented within the file. As a text (i.e. string).",
"title": "firmware_version",
"type": "string"
},
"illumination_system": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/illumination_system_json_schema_v1.0.json",
"description": "An object with keys describing illumination source, relevant optical components and illumination beam properties.",
"title": "illumination",
"type": "object"
},
"manufacturer": {
"description": "Field for providing manufacturer of the instrument or system used for BRDF measurements as a text (i.e.string).",
"title": "manufacturer",
"type": "string"
},
"model": {
"description": "Model of the instrument or system that was used for the measurement of BRDF data presented within the file (if applicable).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the instrument or system that was used for the measurement of BRDF data presented within the file.",
"title": "name",
"type": "string"
},
"operation_type": {
"description": "The key describing whether instrument performs measurements absolutely or relatively. Can have string values \"absolute\" and \"relative\".",
"enum": [
"absolute",
"relative"
],
"title": "operation_type",
"type": "string"
},
"operator_name": {
"description": "Name of the person who performed BRDF measurements presented within file as a string.",
"title": "operator_name",
"type": "string"
},
"reference_info": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/reference_info_json_schema_v1.0.json",
"description": "An object describing reference sample and related data used for relative BRDF measurements.",
"title": "reference_info",
"type": "object"
},
"serial_number": {
"description": "Serial number of the instrument or system that was used for the measurement of BRDF data presented within the file. As a text (i.e. string).",
"title": "serial_number",
"type": "string"
}
},
"required": [
"name",
"illumination",
"detection"
],
"title": "instrumentation",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | 2021-11-26T20:30:56 | BRDF_JSON_schema/license_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/license_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object providing all relevant information regarding the license applicable for presented BRDF data.",
"properties": {
"email": {
"description": "E-mail of the natural or legal person who holds full rights for the presented data. String according to RFC 5321, section 4.1.2",
"format": "email",
"title": "email",
"type": "string"
},
"link": {
"description": "Link to the licence text applicable license as url string.",
"format": "uri",
"title": "link",
"type": "string"
},
"phone": {
"description": "Contact phone/mobile number of the natural or legal person who holds full rights for the presented data according to notation for international numbers suggested by ITU E.123 standard.",
"title": "phone",
"type": "string"
},
"proprietary": {
"description": "Text/string field allowing to provide text of the specific license or comments and additions to existing license template.",
"title": "proprietary",
"type": "string"
},
"rights_holder": {
"description": "Name of the natural or legal person who holds full rights for the presented data. As a string.",
"title": "rights_holder",
"type": "string"
},
"type": {
"description": "Field specifying license agreement applied to the presented datasets. This can be abbreviation according to \"Creative Commons\" license or short name of any other license. Information should be recorded as a string. Note that custom license text can be provided in \"proprietary\" field.",
"title": "type",
"type": "string"
}
},
"required": [
"type",
"rights_holder"
],
"title": "license",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 39b7642c5c06fe9bf62e87b61b4e2595b2584020 | 2021-12-12T19:15:53 | BRDF_JSON_schema/beam_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/beam_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with properties describing illumination beam parameters like size, shape, uniformity etc.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the illumination beam that cannot be presented within \"aperture\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding illumination beam as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding illumination beam used for BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"description": "An object describing physical dimensions of the beam at the surface of the measurement sample.",
"required": [
"area"
],
"title": "dimensions",
"type": "object"
},
"divergence": {
"additionalProperties": false,
"description": "An object describing divergence of the illumination beam that hits the surface of the measurement sample. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"else": {
"properties": {
"value": {
"exclusiveMaximum": 360
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the illumination beam divergence as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the illumination beam divergence as a string that can have values \"deg\", \"\u00b0\", \"rad\" or \"%\".",
"enum": [
"deg",
"\u00b0",
"rad",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the divergence of the illumination beam that hits the surface of the measurement sample as a string that can have values \"deg\", \"\u00b0\", \"rad\".",
"enum": [
"deg",
"\u00b0",
"rad"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the divergence of the illumination beam that hits the surface of the measurement sample as a positive number from 0 to 360 degrees (or 0 to 2\u03c0 radians). Shortly: 0 \u2264 x < 360\u00b0 (or 2\u03c0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"then": {
"properties": {
"value": {
"exclusiveMaximum": 3.141593
}
}
},
"title": "divergence",
"type": "object"
},
"shape": {
"description": "Shape of the illumination beam at the surface of the measurement sample as a text (i.e. string). For example \"circular\", \"square\", \"rectangular\", \"elliptical\" etc.",
"title": "shape",
"type": "string"
},
"uniformity": {
"additionalProperties": false,
"description": "An object describing uniformity of the illumination beam at the surface of the measurement sample. It is defined as a ratio of the minimum and maximum optical power values within illumination beam area. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of illumination beam uniformity at the surface of the measurement sample as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of illumination beam uniformity at the surface of the measurement sample as a string that can have values \"%\" or unitless i.e. \"\".",
"enum": [
"%",
""
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the uniformity of the illumination beam at the surface of the measurement sample as a string that can have values \"%\" or unitless i.e. \"\".",
"enum": [
"%",
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the uniformity of the illumination beam at the surface of the measurement sample as a positive number from 0 to 100 (0 \u2264 x \u2264 100).",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uniformity",
"type": "object"
}
},
"required": [
"shape",
"dimensions"
],
"title": "beam",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | 2021-11-26T20:30:56 | BRDF_JSON_schema/sensor_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/sensor_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing single optical sensor of detection system of the instrument used for BRDF measurements.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the optical sensor used for BRDF measurements that cannot be presented within \"sensor\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"bias_voltage": {
"additionalProperties": false,
"description": "An object describing bias voltage applied applied to the optical sensor during BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the bias voltage applied applied to the optical sensor as a string that can have values \"pV\", \"nV\", \"\u03bcV\", \"mV\", \"V\", \"kV\", \"MV\" or \"GV\".",
"pattern": "^[pn\u03bcmkMG]?V$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the bias voltage applied applied to the optical sensor as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "bias_voltage",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding optical sensor used for BRDF measurements as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"damage_threshold": {
"additionalProperties": false,
"description": "Field describing maximal optical power at which optical sensor is designed to be operated. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the maximal optical power at which optical sensor is designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\".",
"pattern": "^[pn\u03bcmkMG]?W$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the maximal optical power at which optical sensor is designed to be operated as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "damage_threshold"
},
"dark_signal": {
"additionalProperties": false,
"description": "An object describing the level of signal when sensor is not exposed to any radiation (in Ampers (A) or Volts (V)). It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical sensor's dark current as a string that can have values \"pA\", \"nA\", \"\u03bcA\", \"mA\", \"A\", \"kA\", \"MA\", \"GA\" or \"pV\", \"nV\", \"\u03bcV\", \"mV\", \"V\", \"kV\", \"MV\" or \"GV\".",
"oneOf": [
{
"pattern": "^[pn\u03bcmkMG]?A$"
},
{
"pattern": "^[pn\u03bcmkMG]?V$"
}
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical sensor's dark current as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "dark_signal",
"type": "object"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding optical sensor used for BRDF measurements. Array of URL links as a text (i.e.string).",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"description": "Dimensions of the photosensitive part of the sensor included in BRDF measurement set-up.",
"required": [
"area"
],
"title": "dimensions",
"type": "object"
},
"linearity": {
"additionalProperties": false,
"description": "An object describing the maximal ratio between responsivity around different optical powers that sensor can sense in case of fixed detection wavelength. It is defined as min_responsivity / max_responsivity for power range used for BRDF measurements. \"nonlinearity\" object has keys keys \"value\" and \"unit\"",
"properties": {
"unit": {
"description": "Unit of the optical sensor's linearity as a string that can have values \"%\" or unitless i.e. \"\".",
"pattern": "^%?$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical sensor's linearity as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "linearity",
"type": "object"
},
"manufacturer": {
"description": "Manufacturer of the optical sensor used in BRDF measurement set-up as text (i.e. string).",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Light sensing material used in optical sensor included in BRDF measurement set-up as text (i.e. string). For example \"Si\", \"InGaAs\" etc.",
"title": "material",
"type": "string"
},
"model": {
"description": "Model of the optical sensor used in BRDF measurement set-up as text (i.e. string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the optical sensor used in BRDF measurement set-up as text (i.e. string).",
"title": "name",
"type": "string"
},
"operating_temperature": {
"additionalProperties": false,
"description": "Field for providing the temperature at which light sensor was operated during BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the temperature at which light sensor was operated as a string that can have values \"K\", \"kK\" or \"\u00b0C\".",
"oneOf": [
{
"pattern": "^[k]?K$"
},
{
"pattern": "\u00b0C"
}
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the temperature at which light sensor was operated as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "operating_temperature",
"type": "object"
},
"power_range": {
"additionalProperties": false,
"description": "An object describing the optical power range in which optical sensor can be usually applied. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the highest optical power sensor can detect as a number.",
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the lowest optical power sensor can detect as a number.",
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Unit of the lowest and highest power that optical sensor can detect as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\"",
"pattern": "^[GMkm\u03bcnp]?W$",
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "power_range",
"type": "object"
},
"responsivity": {
"additionalProperties": false,
"description": "Typical or average responsivity of optical sensor in A/W. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the set typical or average responsivity of optical sensor as a string that can have values \"A/W\".",
"pattern": "A/W",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the typical or average responsivity of optical sensor as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "responsivity",
"type": "object"
},
"shape": {
"description": "Shape of the photosensitive area of optical sensor included in BRDF measurement set-up as text (i.e. string).",
"title": "shape",
"type": "string"
},
"spectral_response_range": {
"additionalProperties": false,
"description": "An object that specifies wavelength range for sensing of which optical sensor can be applied. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the longest wavelength that optical sensor can sense as a number.",
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the shortest wavelength that optical sensor can sense as a number.",
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Unit of the shortest and longest wavelengths that optical sensor can sense as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[\u03bcn]?m$",
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "spectral_response_range",
"type": "object"
},
"type": {
"description": "Type of the optical sensor used in BRDF measurement set-up as text (i.e. string). For example \"photodiod\", \"CCD-camera\", \"photomultiplyer\" etc.",
"title": "type",
"type": "string"
},
"uniformity": {
"additionalProperties": false,
"description": "An object describing the ratio of minimum and maximum response signals measured at different points of the detector area in case of fixed wavelength and power. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the uniformity of the optical sensor as a string that can have values \"%\" or unitless i.e. \"\".",
"pattern": "^%?$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the uniformity of the optical sensor as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uniformity",
"type": "object"
}
},
"required": [
"name",
"spectral_response_range"
],
"title": "sensor",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | 2021-12-02T01:06:05 | BRDF_JSON_schema/sample_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/sample_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing the physical or virtual sample which BRDF was measured or simulated.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"sample\" object) describing any information relevant to the sample which BRDF was measured or simulated. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"back_surface_curvature": {
"additionalProperties": false,
"description": "An object describing the curvature of the measurement sample's back surface as inverse of the curvature radius. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the back surface curvature as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the back surface curvature as a string that can have values \"1/pm\", \"1/nm\", \"1/\u03bcm\", \"1/mm\", \"1/dm\", \"1/m\", \"1/km\", \"1/Mm\", \"1/Gm\" or \"pm^-1\", \"nm^-1\", \"\u03bcm^-1\", \"mm^-1\", \"dm^-1\", \"m^-1\", \"km^-1\", \"Mm^-1\", \"Gm^-1\" or \"%\".",
"oneOf": [
{
"enum": [
"1/pm",
"1/nm",
"1/\u03bcm",
"1/mm",
"1/dm",
"1/m",
"1/km",
"1/Mm",
"1/Gm",
"%"
]
},
{
"enum": [
"pm^-1",
"nm^-1",
"\u03bcm^-1",
"mm^-1",
"dm^-1",
"m^-1",
"km^-1",
"Mm^-1",
"Gm^-1",
"%"
]
}
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the inverse of the back surface curvature radius as a string that can have values \"1/pm\", \"1/nm\", \"1/\u03bcm\", \"1/mm\", \"1/dm\", \"1/m\", \"1/km\", \"1/Mm\", \"1/Gm\" or \"pm^-1\", \"nm^-1\", \"\u03bcm^-1\", \"mm^-1\", \"dm^-1\", \"m^-1\", \"km^-1\", \"Mm^-1\", \"Gm^-1\".",
"oneOf": [
{
"enum": [
"1/pm",
"1/nm",
"1/\u03bcm",
"1/mm",
"1/dm",
"1/m",
"1/km",
"1/Mm",
"1/Gm"
]
},
{
"enum": [
"pm^-1",
"nm^-1",
"\u03bcm^-1",
"mm^-1",
"dm^-1",
"m^-1",
"km^-1",
"Mm^-1",
"Gm^-1"
]
}
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the inverse of the back surface curvature radius as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "back_surface_curvature",
"type": "object"
},
"back_surface_finish": {
"description": "The field that allows to describe in text (i.e. string) form the peculiarities of sample's back surface finish. For example \"polished\", \"sand blasted\", \"hardened\" etc.",
"title": "back_surface_finish",
"type": "string"
},
"back_surface_roughness": {
"additionalProperties": false,
"description": "An object that describes back surface roughness as arithmetical mean deviation of surface height from its mean value usually denotes as Ra (see https://en.wikipedia.org/wiki/Surface_roughness for more information). It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the measurement sample's back surface roughness as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the measurement sample's back surface roughness as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"cm\", \"m\" \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"cm",
"m",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the measurement sample's back surface roughness as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"cm\" and \"m\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"cm",
"m"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the measurement sample's back surface roughness as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "front_surface_roughness",
"type": "object"
},
"cleaning_procedure": {
"description": "The field that allowing to briefly describe the peculiarities of any cleaning procedure that was applied to the sample before its BRDF measurement. s a text (i.e. string).",
"title": "cleaning_procedure",
"type": "string"
},
"comments": {
"description": "The section that allows to add any additional information in a text form regarding physical or virtual sample which BRDF was measured or simulated. Comments should be presented as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array allowing to provide links to external data regarding physical or virtual sample which BRDF was measured or simulated. For example to photos or 3D model of the sample, its roughness measurement data etc. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"description": "An object that allows to specify dimensions of the sample which BRDF was measured.",
"title": "dimensions",
"type": "object"
},
"front_surface_curvature": {
"additionalProperties": false,
"description": "An object describing the curvature of the measurement sample's front surface as inverse of the curvature radius. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the front surface curvature as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the front surface curvature as a string that can have values \"1/pm\", \"1/nm\", \"1/\u03bcm\", \"1/mm\", \"1/dm\", \"1/m\", \"1/km\", \"1/Mm\", \"1/Gm\" or \"pm^-1\", \"nm^-1\", \"\u03bcm^-1\", \"mm^-1\", \"dm^-1\", \"m^-1\", \"km^-1\", \"Mm^-1\", \"Gm^-1\" or \"%\".",
"oneOf": [
{
"enum": [
"1/pm",
"1/nm",
"1/\u03bcm",
"1/mm",
"1/dm",
"1/m",
"1/km",
"1/Mm",
"1/Gm",
"%"
]
},
{
"enum": [
"pm^-1",
"nm^-1",
"\u03bcm^-1",
"mm^-1",
"dm^-1",
"m^-1",
"km^-1",
"Mm^-1",
"Gm^-1",
"%"
]
}
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the inverse of the front surface curvature radius as a string that can have values \"1/pm\", \"1/nm\", \"1/\u03bcm\", \"1/mm\", \"1/dm\", \"1/m\", \"1/km\", \"1/Mm\", \"1/Gm\" or \"pm^-1\", \"nm^-1\", \"\u03bcm^-1\", \"mm^-1\", \"dm^-1\", \"m^-1\", \"km^-1\", \"Mm^-1\", \"Gm^-1\".",
"oneOf": [
{
"enum": [
"1/pm",
"1/nm",
"1/\u03bcm",
"1/mm",
"1/dm",
"1/m",
"1/km",
"1/Mm",
"1/Gm"
]
},
{
"enum": [
"pm^-1",
"nm^-1",
"\u03bcm^-1",
"mm^-1",
"dm^-1",
"m^-1",
"km^-1",
"Mm^-1",
"Gm^-1"
]
}
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the inverse of the front surface curvature radius as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "front_surface_curvature",
"type": "object"
},
"front_surface_finish": {
"description": "The field that allows to describe in text (i.e. string) form the peculiarities of sample's front surface finish. For example \"polished\", \"sand blasted\", \"hardened\" etc.",
"title": "front_surface_finish",
"type": "string"
},
"front_surface_roughness": {
"additionalProperties": false,
"description": "An object that describes front surface roughness as arithmetical mean deviation of surface height from its mean value usually denotes as Ra (see https://en.wikipedia.org/wiki/Surface_roughness for more information). It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the measurement sample's front surface roughness as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the measurement sample's front surface roughness as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"cm\", \"m\" \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"cm",
"m",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the measurement sample's front surface roughness as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"cm\" and \"m\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"cm",
"m"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the measurement sample's front surface roughness as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "front_surface_roughness",
"type": "object"
},
"manufacturer": {
"description": "Name of the company or person that produced the sample which BRDF was measured. As a text (i.e. string).",
"title": "manufacturer",
"type": "string"
},
"manufacturing_method": {
"description": "The field allowing to briefly describe the peculiarities of manufacturing method that was used to produce the sample which BRDF was measured. As a text (i.e. string).",
"title": "manufacturing_method",
"type": "string"
},
"materials": {
"description": "An array with unique \"material\" objects that describes different materials from which measurement sample was made.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/sample_material_schema_v1.0.json",
"description": "An object that describes a single material from which measurement sample was produced (either partially or fully).",
"title": "material",
"type": "object"
},
"title": "materials",
"type": "array",
"uniqueItems": true
},
"model": {
"description": "Model name or code given to the sample by the manufacturer. As a text (i.e. string).",
"title": "model"
},
"name": {
"description": "Name, laboratory marking or short description of the sample as a text (i.e. string).",
"title": "name",
"type": "string"
},
"origin_location": {
"description": "The field that allows to specify in the text (i.e. string) form the location of the origin of coordinate system associated with the sample which BRDF was measured. Usually it is the \"center of the sample\" or one of its corners like \"upper left corner\" in respect to marking on the sample.",
"title": "origin_location",
"type": "string"
},
"properties_symmetry": {
"description": "The field allowing to specify in the text (i.e. string) form known symmetry of the reflective properties of the sample. For example, sample's BRDF can be \"isotropic\" or \"bilaterally symmetric\" in respect to plane of incidence.",
"title": "properties_symmetry",
"type": "string"
},
"provenance": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/provenance_json_schema_v1.0.json",
"description": "An object describing the origin of the sample which BRDF was measured.",
"title": "provenance",
"type": "object"
},
"shape": {
"description": "The field that allows to describe shape of the sample which BRDF was measured in a text (i.e. string) form.",
"title": "shape",
"type": "string"
},
"specular_reflectance": {
"additionalProperties": false,
"description": "An object describing specular reflectance of the physical or virtual sample which BRDF was measured or simulated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the specular reflectance of the sample which BRDF was measured as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the specular reflectance of the sample which BRDF was measured as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the specular reflectance of the sample which BRDF was measured as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the specular reflectance of the sample which BRDF was measured as a positive number from 0 to 100.",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "specular_reflectance",
"type": "object"
},
"specular_transmittance": {
"additionalProperties": false,
"description": "An object describing specular transmittance of the physical or virtual sample which BRDF was measured or simulated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the specular transmittance of the sample which BRDF was measured as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the specular transmittance of the sample which BRDF was measured as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the specular transmittance of the sample which BRDF was measured as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the specular transmittance of the sample which BRDF was measured as a positive number from 0 to 100.",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "specular_transmittance",
"type": "object"
},
"temperature": {
"additionalProperties": false,
"description": "An object describing temperature of the sample which BRDF was measured. Note that in some cases it might be different from ambient room temperature since sample can be heated or cooled during BRDF measurement. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the temperature of the sample which BRDF was measured as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the temperature of the sample which BRDF was measured as a string that can have values \"K\", \"kK\", \"\u00b0C\" or \"%\".",
"enum": [
"K",
"kK",
"\u00b0C",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the temperature of the sample which BRDF was measured as a string that can have values \"K\", \"kK\" or \"\u00b0C\".",
"enum": [
"K",
"kK",
"\u00b0C"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the temperature of the sample which BRDF was measured as a number. In allowed units the minimum allowed value is \u2212273.15 (if in \u00b0C).",
"minimum": -273.15,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "temperature",
"type": "object"
},
"total_reflectance": {
"additionalProperties": false,
"description": "An object describing total hemispherical reflectance of the physical or virtual sample which BRDF was measured or simulated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the total hemispherical reflectance of the sample which BRDF was measured as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the total hemispherical reflectance of the sample which BRDF was measured as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the total hemispherical reflectance of the sample which BRDF was measured as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the total hemispherical reflectance of the sample which BRDF was measured as a positive number from 0 to 100.",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "total_reflectance",
"type": "object"
},
"total_transmittance": {
"additionalProperties": false,
"description": "An object describing total hemispherical transmittance of the physical or virtual sample which BRDF was measured or simulated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the total hemispherical transmittance of the sample which BRDF was measured as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the total hemispherical transmittance of the sample which BRDF was measured as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the total hemispherical transmittance of the sample which BRDF was measured as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the total hemispherical transmittance of the sample which BRDF was measured as a positive number from 0 to 100.",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "total_transmittance",
"type": "object"
},
"treatment": {
"description": "The field that allowing to briefly describe the peculiarities of any special treatment or preparation procedure that was executed before the measurement of sample's BRDF. s a text (i.e. string).",
"title": "treatment",
"type": "string"
},
"type": {
"description": "Type of the physical or virtual sample according to its reflective properties as a string. For example \"diffuse reflectance sample\", \"specular reflectance sample\" etc.",
"title": "type",
"type": "string"
},
"zero_azimuth_location": {
"description": "The field that allows in the text (i.e. string) form to describe the reference point/direction/marking on the sample that helps to locate plane where illumination and viewing azimuthal angles equal to zero.",
"title": "zero_azimuth_location",
"type": "string"
}
},
"required": [
"name",
"type",
"dimensions",
"shape",
"zero_azimuth_location"
],
"title": "sample"
} | MIT | en |
BiRD-project/BiRD_view | 3ea1db7afa7841b2d56c04abc3bbc962619465a9 | 2021-12-07T15:41:51 | BRDF_JSON_schema/adhoc_varible_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/adhoc_varible_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing a single additional BRDF variable defined by the user. It should have at least \"description\", \"unit\" and \"values\" fields.",
"properties": {
"comments": {
"description": "The field allowing to provide any additional and occasional information relevant to user-defined variable as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"description": "The field that allows to describe user-defined variable and its definition in a text (i.e. string) form. This field should be always present.",
"title": "description",
"type": "string"
},
"maximum": {
"description": "The field allowing to specify maximal allowed value of the user-defined numerical variable.",
"title": "maximum",
"type": "number"
},
"maximum_excluded": {
"default": false,
"description": "The field that allows to specify whether provided maximal value of the numerical user-defined variable is excluded from available values range or not. I.e. whether x is \"<\" or \"\u2264\" than minimal value provided in \"maximum\" field. \"true\" boolean value means it is excluded and \"false\" means it is included that is also a default value for this field.",
"title": "maximum_excluded",
"type": "boolean"
},
"minimum": {
"description": "The field allowing to specify minimal allowed value of the user-defined numerical variable.",
"title": "minimum",
"type": "number"
},
"minimum_excluded": {
"default": false,
"description": "The field that allows to specify whether provided minimal value of the numerical user-defined variable is excluded from available values range or not. I.e. whether x is \">\" or \"\u2265\" than minimal value provided in \"minimum\" field. \"true\" boolean value means it is excluded and \"false\" means it is included that is also a default value for this field.",
"title": "minimum_excluded",
"type": "boolean"
},
"name": {
"description": "The field allowing to provide a short name as a string that would briefly describe the nature of the user-defined variable. This field is not demanded, but might be useful if key under which \"adhoc_variable\" object is stored is not sufficient for the same purpose.",
"title": "name",
"type": "string"
},
"type": {
"description": "The field allowing to specify user-defined variable values' presentation type as for, example \"string\", \"number\", \"integer\", \"array of strings\", \"array of numbers\", \"array of integers\" or \"array of arrays of string/number/integer\" etc.",
"title": "type",
"type": "string"
},
"uncertainty": {
"description": "An object that allows to define non-varying uncertainty of the user-defined variable. The field is optional. It can contain",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the user-defined variable as a string.",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the user-defined variable as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
]
},
{
"additionalProperties": false,
"properties": {
"units": {
"description": "Array of measurement units of the non-varying uncertainties of the vectorized user-defined variable as a number.",
"items": {
"description": "Measurement unit of the single vector element of the non-varying uncertainty of the vectorized user-defined variable as a number.",
"type": "number"
},
"title": "units",
"type": "array"
},
"values": {
"description": "Array of numerical values of the non-varying uncertainties of the vectorized user-defined variable as a number.",
"items": {
"description": "Numerical value of the single vector element of the non-varying uncertainty of the vectorized user-defined variable as a number.",
"type": "number"
},
"title": "value",
"type": "array"
}
},
"required": [
"values",
"units"
]
}
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the user-defined variable as a string.",
"title": "unit",
"type": "string"
},
"values": {
"description": "The field for storing array with values of user-defined variable. Array can have any type of entries except \"objects\". \"type\" of entry should be specified in the dedicated field.",
"items": {
"not": {
"type": "object"
}
},
"title": "values",
"type": "array"
}
},
"required": [
"description",
"unit",
"type",
"values"
],
"title": "adhoc_variable",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | bfe428497bd65f105229f65b0a9ff2380e0f36b2 | 2023-05-04T08:35:12 | packages/gcp-functions/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"id": "GcpFunctionsInit",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 71db7a8130f726fa654f1d7e6258e9567469cd07 | 2021-01-22T16:48:07 | packages/translations/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"generators": {
"init": {
"description": "init Traduora",
"factory": "./src/generators/init/generator",
"schema": "./src/generators/init/schema.json"
}
},
"name": "translations",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | ae88beccb9fc3e677bde7a7241db0f90fce88742 | 2023-07-30T10:15:25 | packages/pulumi/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/draft-07/schema",
"cli": "nx",
"id": "pulumi",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"provider": {
"description": "Your cloud provider",
"type": "string",
"x-prompt": {
"items": [
{
"label": "AWS",
"value": "aws"
},
{
"label": "Azure",
"value": "azure"
},
{
"label": "Google Cloud Platform",
"value": "gcp"
}
],
"message": "Please choose your provider",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | bfe428497bd65f105229f65b0a9ff2380e0f36b2 | 2023-05-04T08:35:12 | packages/vercel/src/generators/add/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"id": "Vercel",
"properties": {
"target": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Target to add Firebase Hosting to",
"type": "string",
"x-prompt": "To what target would you like to add Vercel?"
}
},
"required": [
"target",
"site"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | f97f2f2b187ff9aa9ed91c9cac4e71f14ac22164 | 2020-12-13T16:36:00 | packages/strapi/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"generators": {
"strapi": {
"description": "strapi generator",
"factory": "./src/generators/strapi/generator",
"schema": "./src/generators/strapi/schema.json"
}
},
"name": "strapi",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | 79325aa06e0251f45dbf295f6c19fc417a301fc7 | 2024-05-15T08:00:02 | packages/gcp-deployment-manager/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/schema",
"generators": {
"init": {
"description": "gcp-deployment-manager generator",
"factory": "./src/generators/init/init.impl",
"schema": "./src/generators/init/schema.json"
}
},
"name": "gcp-deployment-manager",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | 79325aa06e0251f45dbf295f6c19fc417a301fc7 | 2024-05-15T08:00:02 | packages/vercel/src/generators/add/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/schema",
"id": "Vercel",
"properties": {
"target": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Target to add Firebase Hosting to",
"type": "string",
"x-prompt": "To what target would you like to add Vercel?"
}
},
"required": [
"target",
"site"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 066a4671affd986347a382a000a4d3729cad289e | 2022-12-29T16:14:51 | packages/terraform/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"generators": {
"init": {
"description": "terraform generator",
"factory": "./src/generators/init/init.impl",
"schema": "./src/generators/init/schema.json"
}
},
"name": "terraform",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | bfe428497bd65f105229f65b0a9ff2380e0f36b2 | 2023-05-04T08:35:12 | packages/terraform/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/draft-07/schema",
"id": "terraform",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 066a4671affd986347a382a000a4d3729cad289e | 2022-12-29T16:14:51 | packages/terraform/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/draft-07/schema",
"cli": "nx",
"id": "terraform",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 680556ee72c94e581b023c8dfb98f464b8cbf520 | 2021-02-24T16:44:11 | packages/gcp-functions/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"cli": "nx",
"id": "GcpDeploymentManager",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 79325aa06e0251f45dbf295f6c19fc417a301fc7 | 2024-05-15T08:00:02 | packages/strapi/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/schema",
"id": "Strapi",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 488d54dc00a7ed25d9ab64e323be8decdffb3f75 | 2022-09-05T21:33:53 | packages/vercel/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"generators": {
"add": {
"description": "Vercel generator",
"factory": "./src/generators/add/add.impl",
"schema": "./src/generators/add/schema.json"
}
},
"name": "vercel",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | 488d54dc00a7ed25d9ab64e323be8decdffb3f75 | 2022-09-05T21:33:53 | packages/vercel/src/generators/add/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"id": "Vercel",
"properties": {
"target": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Target to add Firebase Hosting to",
"type": "string",
"x-prompt": "To what target would you like to add Vercel?"
}
},
"required": [
"target",
"site"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 79325aa06e0251f45dbf295f6c19fc417a301fc7 | 2024-05-15T08:00:02 | packages/vercel/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/schema",
"generators": {
"add": {
"description": "Vercel generator",
"factory": "./src/generators/add/add.impl",
"schema": "./src/generators/add/schema.json"
}
},
"name": "vercel",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | 79325aa06e0251f45dbf295f6c19fc417a301fc7 | 2024-05-15T08:00:02 | packages/gcp-storage/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/schema",
"generators": {},
"name": "gcp-storage",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | 79325aa06e0251f45dbf295f6c19fc417a301fc7 | 2024-05-15T08:00:02 | packages/terraform/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/schema",
"generators": {
"init": {
"description": "terraform generator",
"factory": "./src/generators/init/init.impl",
"schema": "./src/generators/init/schema.json"
}
},
"name": "terraform",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | 79325aa06e0251f45dbf295f6c19fc417a301fc7 | 2024-05-15T08:00:02 | packages/strapi/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/schema",
"generators": {
"init": {
"description": "strapi generator",
"factory": "./src/generators/init/init.impl",
"schema": "./src/generators/init/schema.json"
}
},
"name": "strapi",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | 362c7a37be7fe7f86994a7abeda993684b1e9838 | 2021-03-02T21:25:42 | packages/gcp-secrets/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/draft-07/schema",
"cli": "nx",
"id": "GcpDeploymentManager",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 798d02e1d9d77e6e3ba9d65490ab80ca9c2fdb46 | 2021-02-21T16:20:22 | packages/gcp-deployment-manager/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"generators": {
"init": {
"description": "gcp-deployment-manager generator",
"factory": "./src/generators/init/init.impl",
"schema": "./src/generators/init/schema.json"
}
},
"name": "gcp-deployment-manager",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | 5da84952b40debe9853fe00718e5053db5655b75 | 2021-10-14T14:28:49 | packages/gcp-secrets/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/draft-07/schema",
"cli": "nx",
"id": "GcpDeploymentManager",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 79325aa06e0251f45dbf295f6c19fc417a301fc7 | 2024-05-15T08:00:02 | packages/translations/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/schema",
"generators": {
"add": {
"description": "Add translations to an app",
"factory": "./src/generators/add/add.impl",
"schema": "./src/generators/add/schema.json"
}
},
"name": "translations",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | 79325aa06e0251f45dbf295f6c19fc417a301fc7 | 2024-05-15T08:00:02 | packages/pulumi/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"cli": "nx",
"id": "pulumi",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"provider": {
"description": "Your cloud provider",
"type": "string",
"x-prompt": {
"items": [
{
"label": "AWS",
"value": "aws"
},
{
"label": "Azure",
"value": "azure"
},
{
"label": "Google Cloud Platform",
"value": "gcp"
}
],
"message": "Please choose your provider",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 79325aa06e0251f45dbf295f6c19fc417a301fc7 | 2024-05-15T08:00:02 | packages/terraform/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"id": "terraform",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | bfe428497bd65f105229f65b0a9ff2380e0f36b2 | 2023-05-04T08:35:12 | packages/strapi/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"id": "Strapi",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 5da84952b40debe9853fe00718e5053db5655b75 | 2021-10-14T14:28:49 | packages/gcp-functions/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"cli": "nx",
"id": "GcpFunctionsInit",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | cef6c9662e1f71176d13493c62b9889a549ec699 | 2022-12-30T14:51:12 | packages/pulumi/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"generators": {
"init": {
"description": "pulumi generator",
"factory": "./src/generators/init/init.impl",
"schema": "./src/generators/init/schema.json"
}
},
"name": "pulumi",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | 79325aa06e0251f45dbf295f6c19fc417a301fc7 | 2024-05-15T08:00:02 | packages/playwright/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"id": "playwright-init",
"properties": {
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 6e639a3f45963d80be7c2f7a6f3ce75132912745 | 2022-09-14T16:21:31 | packages/playwright/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/draft-07/schema",
"cli": "nx",
"id": "playwright-init",
"properties": {
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | bfe428497bd65f105229f65b0a9ff2380e0f36b2 | 2023-05-04T08:35:12 | packages/playwright/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/draft-07/schema",
"id": "playwright-init",
"properties": {
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 949efaa403722de59f10332502f1d21be14bb809 | 2024-02-06T22:51:23 | packages/translations/src/generators/add/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/schema",
"id": "translations",
"properties": {
"addPlugin": {
"default": false,
"type": "boolean"
},
"target": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "To what app would you like to add translations?"
}
},
"required": [
"target"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | e5e64c8ce600176b5d40b6c5e6f11affb8349169 | 2023-12-19T17:10:28 | packages/react-email/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/schema",
"generators": {
"init": {
"description": "react email generator",
"factory": "./src/generators/init/init.impl",
"schema": "./src/generators/init/schema.json"
}
},
"name": "react-email",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | e5e64c8ce600176b5d40b6c5e6f11affb8349169 | 2023-12-19T17:10:28 | packages/react-email/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"id": "Strapi",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 1c7db003566aa589c0a9a5d2ce407d2a8976b525 | 2021-10-14T09:06:47 | packages/translations/src/generators/add/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"id": "translations",
"properties": {
"target": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "To what app would you like to add translations?"
}
},
"required": [
"target"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 6497d1ab086e86855532ee172585c76a8d360b5e | 2021-05-30T17:15:07 | packages/gcp-cloud-run/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"generators": {},
"name": "gcp-cloud-run",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | 79325aa06e0251f45dbf295f6c19fc417a301fc7 | 2024-05-15T08:00:02 | packages/github-pages/src/executors/deploy/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "",
"properties": {},
"required": [],
"title": "Build executor",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | e02082e53d59367b3c19af2345cb43b53066d5fe | 2021-02-28T16:26:21 | packages/gcp-cloud-run/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"generators": {
"gcp-cloud-run": {
"description": "gcp-cloud-run generator",
"factory": "./src/generators/gcp-cloud-run/generator",
"schema": "./src/generators/gcp-cloud-run/schema.json"
}
},
"name": "gcp-cloud-run",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | 954889dff1b7b618a002b6f38ba62f8254806232 | 2024-01-18T13:55:29 | packages/shadcn-ui/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"id": "Strapi",
"properties": {
"uiName": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use for the ui lib?"
},
"utilsName": {
"$default": {
"$source": "argv",
"index": 1
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use for the utils lib?"
}
},
"required": [
"uiName",
"utilsName"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 990ac5becbbd7421001f1d126fc2cc3ed7abd917 | 2022-05-26T16:08:30 | packages/github-pages/src/executors/deploy/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "",
"properties": {},
"required": [],
"title": "Build executor",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 139ac952c71fc0ef3a9b84f558dee1e2ec2010f3 | 2023-12-16T16:02:21 | packages/react-email/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/schema",
"generators": {},
"name": "react-email",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | bfe428497bd65f105229f65b0a9ff2380e0f36b2 | 2023-05-04T08:35:12 | packages/pulumi/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/draft-07/schema",
"id": "pulumi",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"provider": {
"description": "Your cloud provider",
"type": "string",
"x-prompt": {
"items": [
{
"label": "AWS",
"value": "aws"
},
{
"label": "Azure",
"value": "azure"
},
{
"label": "Google Cloud Platform",
"value": "gcp"
}
],
"message": "Please choose your provider",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 79325aa06e0251f45dbf295f6c19fc417a301fc7 | 2024-05-15T08:00:02 | packages/react-email/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/schema",
"id": "Strapi",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 9471b982de6f560349299fdb8ce9532eac085a10 | 2021-02-19T15:36:33 | packages/gcp-storage/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"generators": {},
"name": "gcp-storage",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | f05ccbbfa0141d9f9d94a26bd3e4b954da6824e7 | 2021-05-10T19:35:14 | packages/gcp-functions/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"cli": "nx",
"id": "GcpFunctionsInit",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 954889dff1b7b618a002b6f38ba62f8254806232 | 2024-01-18T13:55:29 | packages/shadcn-ui/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/schema",
"generators": {
"init": {
"description": "init generator",
"factory": "./src/generators/init/init.impl",
"schema": "./src/generators/init/schema.json"
}
},
"name": "shadcn-ui",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | 79325aa06e0251f45dbf295f6c19fc417a301fc7 | 2024-05-15T08:00:02 | packages/pulumi/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/schema",
"generators": {
"init": {
"description": "pulumi generator",
"factory": "./src/generators/init/init.impl",
"schema": "./src/generators/init/schema.json"
}
},
"name": "pulumi",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | 79325aa06e0251f45dbf295f6c19fc417a301fc7 | 2024-05-15T08:00:02 | packages/gcp-cloud-run/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/schema",
"generators": {},
"name": "gcp-cloud-run",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | dbcc0b207c5c27a3879f23e99753ac7276cbba95 | 2021-10-27T21:02:21 | packages/strapi/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"id": "Strapi",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 79325aa06e0251f45dbf295f6c19fc417a301fc7 | 2024-05-15T08:00:02 | packages/gcp-secrets/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/schema",
"generators": {
"init": {
"description": "gcp-secrets generator",
"factory": "./src/generators/init/init.impl",
"schema": "./src/generators/init/schema.json"
}
},
"name": "gcp-secrets",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | 79325aa06e0251f45dbf295f6c19fc417a301fc7 | 2024-05-15T08:00:02 | packages/shadcn-ui/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/schema",
"id": "Strapi",
"properties": {
"uiName": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use for the ui lib?"
},
"utilsName": {
"$default": {
"$source": "argv",
"index": 1
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use for the utils lib?"
}
},
"required": [
"uiName",
"utilsName"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | bfe428497bd65f105229f65b0a9ff2380e0f36b2 | 2023-05-04T08:35:12 | packages/gcp-secrets/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/draft-07/schema",
"id": "GcpDeploymentManager",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 362c7a37be7fe7f86994a7abeda993684b1e9838 | 2021-03-02T21:25:42 | packages/gcp-secrets/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"generators": {
"init": {
"description": "gcp-secrets generator",
"factory": "./src/generators/init/init.impl",
"schema": "./src/generators/init/schema.json"
}
},
"name": "gcp-secrets",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | bfe428497bd65f105229f65b0a9ff2380e0f36b2 | 2023-05-04T08:35:12 | packages/translations/src/generators/add/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"id": "translations",
"properties": {
"target": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "To what app would you like to add translations?"
}
},
"required": [
"target"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | c8f9953e01b62cf7687846c6068a5db666850980 | 2021-10-14T09:01:03 | packages/translations/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"generators": {
"add": {
"description": "Add translations to an app",
"factory": "./src/generators/add/add.impl",
"schema": "./src/generators/add/schema.json"
}
},
"name": "translations",
"version": "0.0.1"
} | MIT | en |
TriPSs/nx-extend | cef6c9662e1f71176d13493c62b9889a549ec699 | 2022-12-30T14:51:12 | packages/pulumi/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/draft-07/schema",
"cli": "nx",
"id": "pulumi",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"provider": {
"description": "Your cloud provider",
"type": "string",
"x-prompt": {
"items": [
{
"label": "AWS",
"value": "aws"
},
{
"label": "Azure",
"value": "azure"
},
{
"label": "Google Cloud Platform",
"value": "gcp"
}
],
"message": "Please choose your provider",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | 79325aa06e0251f45dbf295f6c19fc417a301fc7 | 2024-05-15T08:00:02 | packages/gcp-secrets/src/generators/init/schema.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"id": "GcpDeploymentManager",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
TriPSs/nx-extend | dbcc0b207c5c27a3879f23e99753ac7276cbba95 | 2021-10-27T21:02:21 | packages/strapi/generators.json | 139 | 2024-05-27T23:58:38.121755Z | {
"$schema": "http://json-schema.org/schema",
"generators": {
"init": {
"description": "strapi generator",
"factory": "./src/generators/init/init.impl",
"schema": "./src/generators/init/schema.json"
}
},
"name": "strapi",
"version": "0.0.1"
} | MIT | en |
center-for-threat-informed-defense/mappings-explorer | fa94ecb8c7e2f4672d9e937c6417a337b5fac376 | 2023-11-13T18:32:08 | schema/mapex-unified-data-schema.json | 17 | 2024-05-27T05:59:51.230021Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines the data elements and properties of Mappings Explorer projects",
"properties": {
"mapping_objects": {
"description": "A single mapping between framework object and ATT&CK object.",
"items": {
"additionalProperties": false,
"properties": {
"attack_object_id": {
"description": "The unique identifier of the ATT&CK object being mapped. (T1648)",
"type": "string"
},
"attack_object_name": {
"description": "The name of the ATT&CK object. (Serverless Execution)",
"type": "string"
},
"capability_description": {
"description": "Name or description of framework object",
"type": "string"
},
"capability_id": {
"description": "Unique identifier of the framework object being mapped.",
"type": "string"
},
"comments": {
"description": "Used to document assumptions, circumstances, or other information regarding the mapping",
"type": "string"
},
"group": {
"description": "This property describes which group this mapping falls into.",
"type": "string"
},
"mapping_type": {
"description": "Mapping type has framework-specific values. This property describes how the capability_id and attack_object_id are related.",
"type": "string"
},
"references": {
"description": "A list of links to documentation that provides additional detail in understanding the data contained in this mapping. (A link to the documentation for a security control.)",
"items": {
"type": "string"
},
"type": "array"
},
"related_score": {
"description": "When the ATT&CK object ID is a sub-technique, related score contains the parent technique ID.",
"type": "string"
},
"score_category": {
"description": "Assessment of the effectiveness of the mitigations provided. (Protect, Detect, Respond)",
"enum": [
"protect",
"detect",
"respond"
],
"type": "string"
},
"score_value": {
"description": "The score. (e.g. Minimal, Partial, Significant)",
"enum": [
"minimal",
"partial",
"significant"
],
"type": "string"
}
},
"required": [
"mapping_type",
"capability_id"
],
"type": "object"
},
"type": "array"
},
"metadata": {
"additionalProperties": false,
"description": "Properties that apply to all mappings in a project.",
"properties": {
"attack_version": {
"description": "The version of ATT&CK used to source the objects included in this mapping.",
"type": "string"
},
"author": {
"description": "The author of this mapping file.",
"type": "string"
},
"contact": {
"description": "The email address of the author.",
"type": "string"
},
"creation_date": {
"description": "Creation date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"groups": {
"description": "The groups that the mappings can be organized in.",
"items": {
"additionalProperties": false,
"properties": {
"id": {
"description": "The group's identifier.",
"type": "string"
},
"name": {
"description": "The group's name.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"type": "array"
},
"last_update": {
"description": "Last update date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"mapping_framework": {
"description": "The group of objects being mapped to ATT&CK.",
"enum": [
"veris",
"nist_800_53",
"cve",
"aws",
"gcp",
"azure"
],
"type": "string"
},
"mapping_framework_version": {
"description": "The Mapping Framework's version.",
"type": "string"
},
"mapping_framework_version_schema": {
"description": "How the Mapping Framework is versioned.",
"enum": [
"FRAMEWORK_VERSION",
"ACCESS_DATE"
],
"type": "string"
},
"mapping_types": {
"description": "The mappings types that are associated with each Framework.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "A description of the mapping type.",
"type": "string"
},
"id": {
"description": "The mapping type's identifier.",
"type": "string"
},
"name": {
"description": "The mapping type's name.",
"type": "string"
}
},
"required": [
"id",
"name",
"description"
],
"type": "object"
},
"type": "array"
},
"mapping_version": {
"description": "The version of the mapping project.",
"type": "string"
},
"organization": {
"description": "The organization associated with the author.",
"type": "string"
},
"technology_domain": {
"description": "ATT&CK Technology Domain (Enterprise, Mobile, ICS).",
"enum": [
"enterprise",
"mobile",
"ics"
],
"type": "string"
}
},
"required": [
"mapping_version",
"attack_version",
"technology_domain",
"creation_date",
"mapping_framework",
"mapping_framework_version",
"mapping_types",
"groups"
],
"type": "object"
}
},
"title": "ATT&CK Mappings Unified Schema",
"type": "object"
} | Apache-2.0 | en |
center-for-threat-informed-defense/mappings-explorer | f14f1a9a99dc0b1af119a1115160aa394a233554 | 2024-01-08T16:20:39 | schema/mapex-unified-data-schema.json | 17 | 2024-05-27T05:59:51.230021Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines the data elements and properties of Mappings Explorer projects",
"properties": {
"mapping_objects": {
"description": "A single mapping between framework object and ATT&CK object.",
"items": {
"additionalProperties": false,
"properties": {
"attack_object_id": {
"description": "The unique identifier of the ATT&CK object being mapped. (T1648)",
"type": [
"string",
"null"
]
},
"attack_object_name": {
"description": "The name of the ATT&CK object. (Serverless Execution)",
"type": [
"string",
"null"
]
},
"capability_description": {
"description": "Name or description of framework object",
"type": "string"
},
"capability_id": {
"description": "Unique identifier of the framework object being mapped.",
"type": "string"
},
"comments": {
"description": "Used to document assumptions, circumstances, or other information regarding the mapping",
"type": [
"string",
"null"
]
},
"group": {
"description": "This property describes which group this mapping falls into.",
"type": [
"string"
]
},
"mapping_type": {
"description": "Mapping type has framework-specific values. This property describes how the capability_id and attack_object_id are related.",
"type": [
"string",
"null"
]
},
"references": {
"description": "A list of links to documentation that provides additional detail in understanding the data contained in this mapping. (A link to the documentation for a security control.)",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"related_score": {
"description": "When the ATT&CK object ID is a sub-technique, related score contains the parent technique ID.",
"type": [
"string",
"null"
]
},
"score_category": {
"description": "Assessment of the effectiveness of the mitigations provided. (Protect, Detect, Respond)",
"enum": [
"protect",
"detect",
"respond",
null
],
"type": [
"string",
"null"
]
},
"score_value": {
"description": "The score. (e.g. Minimal, Partial, Significant)",
"enum": [
"minimal",
"partial",
"significant",
null
],
"type": [
"string",
"null"
]
},
"status": {
"description": "This property describes the status of the mapping, whether it is complete, in progress, or not mapable.",
"enum": [
"complete",
"in_progress",
"not_mappable"
],
"type": "string"
}
},
"required": [
"mapping_type"
],
"type": "object"
},
"type": "array"
},
"metadata": {
"additionalProperties": false,
"description": "Properties that apply to all mappings in a project.",
"properties": {
"attack_version": {
"description": "The version of ATT&CK used to source the objects included in this mapping.",
"type": "string"
},
"author": {
"description": "The author of this mapping file.",
"type": "string"
},
"contact": {
"description": "The email address of the author.",
"type": "string"
},
"creation_date": {
"description": "Creation date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"groups": {
"description": "The groups that the mappings can be organized in.",
"type": "object"
},
"last_update": {
"description": "Last update date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"mapping_framework": {
"description": "The group of objects being mapped to ATT&CK.",
"enum": [
"veris",
"nist_800_53",
"cve",
"aws",
"gcp",
"azure"
],
"type": "string"
},
"mapping_framework_version": {
"description": "The Mapping Framework's version.",
"type": "string"
},
"mapping_framework_version_schema": {
"description": "How the Mapping Framework is versioned.",
"enum": [
"FRAMEWORK_VERSION",
"ACCESS_DATE"
],
"type": "string"
},
"mapping_types": {
"description": "The mappings types that are associated with each Framework.",
"patternProperties": {
"[a-z]+": {
"additionalProperties": false,
"properties": {
"description": {
"description": "A description of the mapping type.",
"type": "string"
},
"name": {
"description": "The mapping type's name.",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
}
},
"type": "object"
},
"mapping_version": {
"description": "The version of the mapping project.",
"type": "string"
},
"organization": {
"description": "The organization associated with the author.",
"type": "string"
},
"technology_domain": {
"description": "ATT&CK Technology Domain (Enterprise, Mobile, ICS).",
"enum": [
"enterprise",
"mobile",
"ics"
],
"type": "string"
}
},
"required": [
"mapping_version",
"attack_version",
"technology_domain",
"creation_date",
"mapping_framework",
"mapping_framework_version",
"mapping_types",
"groups"
],
"type": "object"
}
},
"title": "ATT&CK Mappings Unified Schema",
"type": "object"
} | Apache-2.0 | en |
center-for-threat-informed-defense/mappings-explorer | 1b3c929bcd1c89daf73ba8fc2965154feef3a795 | 2024-03-12T16:17:08 | schema/mapex-unified-data-schema.json | 17 | 2024-05-27T05:59:51.230021Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines the data elements and properties of Mappings Explorer projects",
"properties": {
"mapping_objects": {
"description": "A single mapping between framework object and ATT&CK object.",
"items": {
"additionalProperties": false,
"properties": {
"attack_object_id": {
"description": "The unique identifier of the ATT&CK object being mapped. (T1648)",
"type": [
"string",
"null"
]
},
"attack_object_name": {
"description": "The name of the ATT&CK object. (Serverless Execution)",
"type": [
"string",
"null"
]
},
"attack_version": {
"description": "The version of ATT&CK used to source the objects included in this mapping.",
"type": "string"
},
"author": {
"description": "The author of the mapping",
"type": [
"string",
"null"
]
},
"author_contact": {
"description": "The author of the mapping's contact",
"type": [
"string",
"null"
]
},
"author_organization": {
"description": "The author of the mapping's organization",
"type": [
"string",
"null"
]
},
"capability_description": {
"description": "Name or description of framework object",
"type": [
"string",
"null"
]
},
"capability_group": {
"description": "This property describes which capability_group this mapping falls into.",
"type": [
"string",
"null"
]
},
"capability_id": {
"description": "Unique identifier of the framework object being mapped.",
"type": [
"string",
"null"
]
},
"comments": {
"description": "Used to document assumptions, circumstances, or other information regarding the mapping",
"type": [
"string",
"null"
]
},
"mapping_framework": {
"description": "The name of the mapping framework. (Veris)",
"type": "string"
},
"mapping_framework_version": {
"description": "The version of the mapping framework. (1.3.7)",
"type": "string"
},
"mapping_type": {
"description": "Mapping type has framework-specific values. This property describes how the capability_id and attack_object_id are related.",
"type": [
"string",
"null"
]
},
"references": {
"description": "A list of links to documentation that provides additional detail in understanding the data contained in this mapping. (A link to the documentation for a security control.)",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"related_score": {
"description": "When the ATT&CK object ID is a sub-technique, related score contains the parent technique ID.",
"type": [
"string",
"null"
]
},
"score_category": {
"description": "Assessment of the effectiveness of the mitigations provided. (Protect, Detect, Respond)",
"enum": [
"protect",
"detect",
"respond",
null
],
"type": [
"string",
"null"
]
},
"score_value": {
"description": "The score. (e.g. Minimal, Partial, Significant)",
"enum": [
"minimal",
"partial",
"significant",
null
],
"type": [
"string",
"null"
]
},
"status": {
"description": "This property describes the status of the mapping, whether it is complete, in progress, or not mapable.",
"enum": [
"complete",
"in_progress",
"non_mappable"
],
"type": "string"
},
"technology_domain": {
"description": "ATT&CK Technology Domain (Enterprise, Mobile, ICS).",
"type": "string"
}
},
"required": [
"mapping_type",
"capability_group"
],
"type": "object"
},
"type": "array"
},
"metadata": {
"additionalProperties": false,
"description": "Properties that apply to all mappings in a project.",
"properties": {
"attack_version": {
"description": "The version of ATT&CK used to source the objects included in this mapping.",
"type": "string"
},
"author": {
"description": "The author of this mapping file.",
"type": [
"string",
"null"
]
},
"capability_groups": {
"description": "The groups that the mappings can be organized in.",
"type": "object"
},
"contact": {
"description": "The email address of the author.",
"type": [
"string",
"null"
]
},
"creation_date": {
"description": "Creation date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"last_update": {
"description": "Last update date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"mapping_framework": {
"description": "The group of objects being mapped to ATT&CK.",
"type": "string"
},
"mapping_framework_version": {
"description": "The Mapping Framework's version.",
"type": "string"
},
"mapping_framework_version_schema": {
"description": "How the Mapping Framework is versioned.",
"enum": [
"FRAMEWORK_VERSION",
"ACCESS_DATE"
],
"type": "string"
},
"mapping_types": {
"description": "The mappings types that are associated with each Framework.",
"patternProperties": {
"[a-z]+": {
"additionalProperties": false,
"properties": {
"description": {
"description": "A description of the mapping type.",
"type": "string"
},
"name": {
"description": "The mapping type's name.",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
}
},
"type": "object"
},
"mapping_version": {
"description": "The version of the mapping project.",
"type": "string"
},
"organization": {
"description": "The organization associated with the author.",
"type": [
"string",
"null"
]
},
"technology_domain": {
"description": "ATT&CK Technology Domain (Enterprise, Mobile, ICS).",
"enum": [
"enterprise",
"mobile",
"ics"
],
"type": "string"
}
},
"required": [
"mapping_version",
"attack_version",
"technology_domain",
"creation_date",
"mapping_framework",
"mapping_framework_version",
"mapping_types",
"capability_groups"
],
"type": "object"
}
},
"title": "ATT&CK Mappings Unified Schema",
"type": "object"
} | Apache-2.0 | en |
center-for-threat-informed-defense/mappings-explorer | 068d15ab22e77be6398e570bca2c00a3d80ab2f1 | 2024-01-10T20:39:18 | schema/mapex-unified-data-schema.json | 17 | 2024-05-27T05:59:51.230021Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines the data elements and properties of Mappings Explorer projects",
"properties": {
"mapping_objects": {
"description": "A single mapping between framework object and ATT&CK object.",
"items": {
"additionalProperties": false,
"properties": {
"attack_object_id": {
"description": "The unique identifier of the ATT&CK object being mapped. (T1648)",
"type": [
"string",
"null"
]
},
"attack_object_name": {
"description": "The name of the ATT&CK object. (Serverless Execution)",
"type": [
"string",
"null"
]
},
"author": {
"description": "The author of the mapping",
"type": [
"string",
"null"
]
},
"author_contact": {
"description": "The author of the mapping's contact",
"type": [
"string",
"null"
]
},
"author_organization": {
"description": "The author of the mapping's organization",
"type": [
"string",
"null"
]
},
"capability_description": {
"description": "Name or description of framework object",
"type": "string"
},
"capability_id": {
"description": "Unique identifier of the framework object being mapped.",
"type": "string"
},
"comments": {
"description": "Used to document assumptions, circumstances, or other information regarding the mapping",
"type": [
"string",
"null"
]
},
"group": {
"description": "This property describes which group this mapping falls into.",
"type": [
"string"
]
},
"mapping_type": {
"description": "Mapping type has framework-specific values. This property describes how the capability_id and attack_object_id are related.",
"type": [
"string",
"null"
]
},
"references": {
"description": "A list of links to documentation that provides additional detail in understanding the data contained in this mapping. (A link to the documentation for a security control.)",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"related_score": {
"description": "When the ATT&CK object ID is a sub-technique, related score contains the parent technique ID.",
"type": [
"string",
"null"
]
},
"score_category": {
"description": "Assessment of the effectiveness of the mitigations provided. (Protect, Detect, Respond)",
"enum": [
"protect",
"detect",
"respond",
null
],
"type": [
"string",
"null"
]
},
"score_value": {
"description": "The score. (e.g. Minimal, Partial, Significant)",
"enum": [
"minimal",
"partial",
"significant",
null
],
"type": [
"string",
"null"
]
},
"status": {
"description": "This property describes the status of the mapping, whether it is complete, in progress, or not mapable.",
"enum": [
"complete",
"in_progress",
"not_mappable"
],
"type": "string"
}
},
"required": [
"mapping_type"
],
"type": "object"
},
"type": "array"
},
"metadata": {
"additionalProperties": false,
"description": "Properties that apply to all mappings in a project.",
"properties": {
"attack_version": {
"description": "The version of ATT&CK used to source the objects included in this mapping.",
"type": "string"
},
"author": {
"description": "The author of this mapping file.",
"type": [
"string",
"null"
]
},
"contact": {
"description": "The email address of the author.",
"type": [
"string",
"null"
]
},
"creation_date": {
"description": "Creation date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"groups": {
"description": "The groups that the mappings can be organized in.",
"type": "object"
},
"last_update": {
"description": "Last update date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"mapping_framework": {
"description": "The group of objects being mapped to ATT&CK.",
"type": "string"
},
"mapping_framework_version": {
"description": "The Mapping Framework's version.",
"type": "string"
},
"mapping_framework_version_schema": {
"description": "How the Mapping Framework is versioned.",
"enum": [
"FRAMEWORK_VERSION",
"ACCESS_DATE"
],
"type": "string"
},
"mapping_types": {
"description": "The mappings types that are associated with each Framework.",
"patternProperties": {
"[a-z]+": {
"additionalProperties": false,
"properties": {
"description": {
"description": "A description of the mapping type.",
"type": "string"
},
"name": {
"description": "The mapping type's name.",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
}
},
"type": "object"
},
"mapping_version": {
"description": "The version of the mapping project.",
"type": "string"
},
"organization": {
"description": "The organization associated with the author.",
"type": [
"string",
"null"
]
},
"technology_domain": {
"description": "ATT&CK Technology Domain (Enterprise, Mobile, ICS).",
"enum": [
"enterprise",
"mobile",
"ics"
],
"type": "string"
}
},
"required": [
"mapping_version",
"attack_version",
"technology_domain",
"creation_date",
"mapping_framework",
"mapping_framework_version",
"mapping_types",
"groups"
],
"type": "object"
}
},
"title": "ATT&CK Mappings Unified Schema",
"type": "object"
} | Apache-2.0 | en |
center-for-threat-informed-defense/mappings-explorer | aed807876a4c0da00275f3d2b4756c191622fccc | 2024-02-09T19:48:45 | schema/mapex-unified-data-schema.json | 17 | 2024-05-27T05:59:51.230021Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines the data elements and properties of Mappings Explorer projects",
"properties": {
"mapping_objects": {
"description": "A single mapping between framework object and ATT&CK object.",
"items": {
"additionalProperties": false,
"properties": {
"attack_object_id": {
"description": "The unique identifier of the ATT&CK object being mapped. (T1648)",
"type": [
"string",
"null"
]
},
"attack_object_name": {
"description": "The name of the ATT&CK object. (Serverless Execution)",
"type": [
"string",
"null"
]
},
"attack_version": {
"description": "The version of ATT&CK used to source the objects included in this mapping.",
"type": "string"
},
"author": {
"description": "The author of the mapping",
"type": [
"string",
"null"
]
},
"author_contact": {
"description": "The author of the mapping's contact",
"type": [
"string",
"null"
]
},
"author_organization": {
"description": "The author of the mapping's organization",
"type": [
"string",
"null"
]
},
"capability_description": {
"description": "Name or description of framework object",
"type": [
"string",
"null"
]
},
"capability_group": {
"description": "This property describes which capability_group this mapping falls into.",
"type": [
"string",
"null"
]
},
"capability_id": {
"description": "Unique identifier of the framework object being mapped.",
"type": [
"string",
"null"
]
},
"comments": {
"description": "Used to document assumptions, circumstances, or other information regarding the mapping",
"type": [
"string",
"null"
]
},
"mapping_framework": {
"description": "The name of the mapping framework. (Veris)",
"type": "string"
},
"mapping_framework_version": {
"description": "The version of the mapping framework. (1.3.7)",
"type": "string"
},
"mapping_type": {
"description": "Mapping type has framework-specific values. This property describes how the capability_id and attack_object_id are related.",
"type": [
"string",
"null"
]
},
"references": {
"description": "A list of links to documentation that provides additional detail in understanding the data contained in this mapping. (A link to the documentation for a security control.)",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"related_score": {
"description": "When the ATT&CK object ID is a sub-technique, related score contains the parent technique ID.",
"type": [
"string",
"null"
]
},
"score_category": {
"description": "Assessment of the effectiveness of the mitigations provided. (Protect, Detect, Respond)",
"enum": [
"protect",
"detect",
"respond",
null
],
"type": [
"string",
"null"
]
},
"score_value": {
"description": "The score. (e.g. Minimal, Partial, Significant)",
"enum": [
"minimal",
"partial",
"significant",
null
],
"type": [
"string",
"null"
]
},
"status": {
"description": "This property describes the status of the mapping, whether it is complete, in progress, or not mapable.",
"enum": [
"complete",
"in_progress",
"non_mappable"
],
"type": "string"
},
"technology_domain": {
"description": "ATT&CK Technology Domain (Enterprise, Mobile, ICS).",
"type": "string"
}
},
"required": [
"mapping_type"
],
"type": "object"
},
"type": "array"
},
"metadata": {
"additionalProperties": false,
"description": "Properties that apply to all mappings in a project.",
"properties": {
"attack_version": {
"description": "The version of ATT&CK used to source the objects included in this mapping.",
"type": "string"
},
"author": {
"description": "The author of this mapping file.",
"type": [
"string",
"null"
]
},
"capability_groups": {
"description": "The groups that the mappings can be organized in.",
"type": "object"
},
"contact": {
"description": "The email address of the author.",
"type": [
"string",
"null"
]
},
"creation_date": {
"description": "Creation date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"last_update": {
"description": "Last update date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"mapping_framework": {
"description": "The group of objects being mapped to ATT&CK.",
"type": "string"
},
"mapping_framework_version": {
"description": "The Mapping Framework's version.",
"type": "string"
},
"mapping_framework_version_schema": {
"description": "How the Mapping Framework is versioned.",
"enum": [
"FRAMEWORK_VERSION",
"ACCESS_DATE"
],
"type": "string"
},
"mapping_types": {
"description": "The mappings types that are associated with each Framework.",
"patternProperties": {
"[a-z]+": {
"additionalProperties": false,
"properties": {
"description": {
"description": "A description of the mapping type.",
"type": "string"
},
"name": {
"description": "The mapping type's name.",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
}
},
"type": "object"
},
"mapping_version": {
"description": "The version of the mapping project.",
"type": "string"
},
"organization": {
"description": "The organization associated with the author.",
"type": [
"string",
"null"
]
},
"technology_domain": {
"description": "ATT&CK Technology Domain (Enterprise, Mobile, ICS).",
"enum": [
"enterprise",
"mobile",
"ics"
],
"type": "string"
}
},
"required": [
"mapping_version",
"attack_version",
"technology_domain",
"creation_date",
"mapping_framework",
"mapping_framework_version",
"mapping_types",
"capability_groups"
],
"type": "object"
}
},
"title": "ATT&CK Mappings Unified Schema",
"type": "object"
} | Apache-2.0 | en |
center-for-threat-informed-defense/mappings-explorer | bde1f68db1d5069eac65708768594ac07eb3ec9b | 2023-10-18T17:23:22 | schema/mapex-unified-data-schema.json | 17 | 2024-05-27T05:59:51.230021Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Defines the data elements and properties of Mappings Explorer projects",
"properties": {
"mapping_object": {
"description": "A single mapping between framework object and ATT&CK object.",
"items": {
"dependentRequired": {
"mapping_type": [
"valid_mapping_types"
]
},
"properties": {
"attack_object_id": {
"description": "The unique identifier of the ATT&CK object being mapped. (T1648)",
"type": "string"
},
"attack_object_name": {
"description": "The name of the ATT&CK object. (Serverless Execution)",
"type": "string"
},
"capability_description": {
"description": "Name or description of framework object",
"type": "string"
},
"capability_id": {
"description": "Unique identifier of the framework object being mapped.",
"type": "string"
},
"comments": {
"description": "Used to document assumptions, circumstances, or other information regarding the mapping",
"type": "string"
},
"else": {},
"if": {
"properties": {
"mapping_type": {
"const": "technique_scores"
}
}
},
"mapping_type": {
"description": "Mapping type has framework-specific values. This property describes how the capability_id and attack_object_id are related.",
"type": "string"
},
"references": {
"description": "A list of links to documentation that provides additional detail in understanding the data contained in this mapping. (A link to the documentation for a security control.)",
"type": "string"
},
"then": {
"properties": {
"related_score": {
"description": "When the ATT&CK object ID is a sub-technique, related score contains the parent technique ID.",
"type": "string"
},
"score_category": {
"description": "Assessment of the effectiveness of the mitigations provided. (Protect, Detect, Respond)",
"items": {
"enum": [
"protect",
"detect",
"respond"
]
},
"type": "array"
},
"score_value": {
"description": "The score. (e.g. Minimal, Partial, Significant)",
"items": {
"enum": [
"minimal",
"partial",
"significant"
]
},
"type": "array"
}
}
}
},
"required": [
"mapping_type",
"capability_id"
],
"type": "object"
},
"type": "array"
},
"metadata": {
"description": "Properties that apply to all mappings in a project.",
"properties": {
"attack_version": {
"description": "The version of ATT&CK used to source the objects included in this mapping.",
"type": "string"
},
"author": {
"description": "The author of this mapping file.",
"type": "string"
},
"contact": {
"description": "The email address of the author.",
"type": "string"
},
"creation_date": {
"description": "Creation date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"last_update": {
"description": "Last update date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"mapping_framework": {
"description": "The group of objects being mapped to ATT&CK.",
"items": {
"enum": [
"veris",
"nist_800_53",
"cve",
"aws",
"gcp",
"azure"
]
},
"type": "array"
},
"mapping_framework_version": {
"description": "The Mapping Framework's version.",
"type": "string"
},
"mapping_framework_version_scheme": {
"description": "How the Mapping Framework is versioned.",
"items": {
"enum": [
"framework",
"date_accessed"
]
},
"type": "array"
},
"mapping_types": {
"description": "The mappings types that are associated with each Framework.",
"items": {
"properties": {
"description": {
"description": "A description of the mapping type.",
"type": "string"
},
"id": {
"description": "The mapping type's identifier.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"mapping_version": {
"description": "The version of the mapping project.",
"type": "string"
},
"organization": {
"description": "The organization associated with the author.",
"type": "string"
},
"technology_domain": {
"description": "ATT&CK Technology Domain (Enterprise, Mobile, ICS).",
"items": {
"enum": [
"enterprise",
"mobile",
"ics"
]
},
"type": "array"
}
},
"required": [
"mapping_version",
"attack_version",
"technology_domain",
"creation_date",
"mapping_framework",
"mapping_framework_version",
"mappings_types"
],
"type": "object"
}
},
"title": "ATT&CK Mappings Unified Schema",
"type": "object"
} | Apache-2.0 | en |
center-for-threat-informed-defense/mappings-explorer | 8739e39aa6a1c680b295508bf7fc7f191e808881 | 2023-11-08T16:02:00 | schema/mapex-unified-data-schema.json | 17 | 2024-05-27T05:59:51.230021Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Defines the data elements and properties of Mappings Explorer projects",
"properties": {
"additionalProperties": false,
"mapping_object": {
"description": "A single mapping between framework object and ATT&CK object.",
"items": {
"dependentRequired": {
"mapping_type": [
"valid_mapping_types"
]
},
"properties": {
"attack_object_id": {
"description": "The unique identifier of the ATT&CK object being mapped. (T1648)",
"type": "string"
},
"attack_object_name": {
"description": "The name of the ATT&CK object. (Serverless Execution)",
"type": "string"
},
"capability_description": {
"description": "Name or description of framework object",
"type": "string"
},
"capability_id": {
"description": "Unique identifier of the framework object being mapped.",
"type": "string"
},
"comments": {
"description": "Used to document assumptions, circumstances, or other information regarding the mapping",
"type": "string"
},
"else": {},
"if": {
"properties": {
"mapping_type": {
"const": "technique_scores"
}
}
},
"mapping_type": {
"description": "Mapping type has framework-specific values. This property describes how the capability_id and attack_object_id are related.",
"type": "string"
},
"references": {
"description": "A list of links to documentation that provides additional detail in understanding the data contained in this mapping. (A link to the documentation for a security control.)",
"type": "string"
},
"then": {
"properties": {
"related_score": {
"description": "When the ATT&CK object ID is a sub-technique, related score contains the parent technique ID.",
"type": "string"
},
"score_category": {
"description": "Assessment of the effectiveness of the mitigations provided. (Protect, Detect, Respond)",
"items": {
"enum": [
"protect",
"detect",
"respond"
]
},
"type": "array"
},
"score_value": {
"description": "The score. (e.g. Minimal, Partial, Significant)",
"items": {
"enum": [
"minimal",
"partial",
"significant"
]
},
"type": "array"
}
}
}
},
"required": [
"mapping_type",
"capability_id"
],
"type": "object"
},
"type": "array"
},
"metadata": {
"description": "Properties that apply to all mappings in a project.",
"properties": {
"attack_version": {
"description": "The version of ATT&CK used to source the objects included in this mapping.",
"type": "string"
},
"author": {
"description": "The author of this mapping file.",
"type": "string"
},
"contact": {
"description": "The email address of the author.",
"type": "string"
},
"creation_date": {
"description": "Creation date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"last_update": {
"description": "Last update date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"mapping_framework": {
"description": "The group of objects being mapped to ATT&CK.",
"items": {
"enum": [
"veris",
"nist_800_53",
"cve",
"aws",
"gcp",
"azure"
]
},
"type": "string"
},
"mapping_framework_version": {
"description": "The Mapping Framework's version.",
"type": "string"
},
"mapping_framework_version_scheme": {
"description": "How the Mapping Framework is versioned.",
"items": {
"enum": [
"framework",
"date_accessed"
]
},
"type": "array"
},
"mapping_types": {
"description": "The mappings types that are associated with each Framework.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "A description of the mapping type.",
"type": "string"
},
"id": {
"description": "The mapping type's identifier.",
"type": "string"
},
"name": {
"description": "The mapping type's name.",
"type": "string"
}
},
"required": [
"id",
"name",
"description"
],
"type": "object"
},
"type": "array"
},
"mapping_version": {
"description": "The version of the mapping project.",
"type": "string"
},
"organization": {
"description": "The organization associated with the author.",
"type": "string"
},
"technology_domain": {
"description": "ATT&CK Technology Domain (Enterprise, Mobile, ICS).",
"items": {
"enum": [
"enterprise",
"mobile",
"ics"
]
},
"type": "string"
}
},
"required": [
"mapping_version",
"attack_version",
"technology_domain",
"creation_date",
"mapping_framework",
"mapping_framework_version",
"mapping_types"
],
"type": "object"
}
},
"title": "ATT&CK Mappings Unified Schema",
"type": "object"
} | Apache-2.0 | en |
center-for-threat-informed-defense/mappings-explorer | 6e684176156ba39f1a3cb131c9c08085b0d02a3c | 2024-01-17T16:53:55 | schema/mapex-unified-data-schema.json | 17 | 2024-05-27T05:59:51.230021Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines the data elements and properties of Mappings Explorer projects",
"properties": {
"mapping_objects": {
"description": "A single mapping between framework object and ATT&CK object.",
"items": {
"additionalProperties": false,
"properties": {
"attack_object_id": {
"description": "The unique identifier of the ATT&CK object being mapped. (T1648)",
"type": [
"string",
"null"
]
},
"attack_object_name": {
"description": "The name of the ATT&CK object. (Serverless Execution)",
"type": [
"string",
"null"
]
},
"author": {
"description": "The author of the mapping",
"type": [
"string",
"null"
]
},
"author_contact": {
"description": "The author of the mapping's contact",
"type": [
"string",
"null"
]
},
"author_organization": {
"description": "The author of the mapping's organization",
"type": [
"string",
"null"
]
},
"capability_description": {
"description": "Name or description of framework object",
"type": "string"
},
"capability_id": {
"description": "Unique identifier of the framework object being mapped.",
"type": "string"
},
"comments": {
"description": "Used to document assumptions, circumstances, or other information regarding the mapping",
"type": [
"string",
"null"
]
},
"group": {
"description": "This property describes which group this mapping falls into.",
"type": [
"string"
]
},
"mapping_type": {
"description": "Mapping type has framework-specific values. This property describes how the capability_id and attack_object_id are related.",
"type": [
"string",
"null"
]
},
"references": {
"description": "A list of links to documentation that provides additional detail in understanding the data contained in this mapping. (A link to the documentation for a security control.)",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"related_score": {
"description": "When the ATT&CK object ID is a sub-technique, related score contains the parent technique ID.",
"type": [
"string",
"null"
]
},
"score_category": {
"description": "Assessment of the effectiveness of the mitigations provided. (Protect, Detect, Respond)",
"enum": [
"protect",
"detect",
"respond",
null
],
"type": [
"string",
"null"
]
},
"score_value": {
"description": "The score. (e.g. Minimal, Partial, Significant)",
"enum": [
"minimal",
"partial",
"significant",
null
],
"type": [
"string",
"null"
]
},
"status": {
"description": "This property describes the status of the mapping, whether it is complete, in progress, or not mapable.",
"enum": [
"complete",
"in_progress",
"non_mappable"
],
"type": "string"
}
},
"required": [
"mapping_type"
],
"type": "object"
},
"type": "array"
},
"metadata": {
"additionalProperties": false,
"description": "Properties that apply to all mappings in a project.",
"properties": {
"attack_version": {
"description": "The version of ATT&CK used to source the objects included in this mapping.",
"type": "string"
},
"author": {
"description": "The author of this mapping file.",
"type": [
"string",
"null"
]
},
"contact": {
"description": "The email address of the author.",
"type": [
"string",
"null"
]
},
"creation_date": {
"description": "Creation date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"groups": {
"description": "The groups that the mappings can be organized in.",
"type": "object"
},
"last_update": {
"description": "Last update date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"mapping_framework": {
"description": "The group of objects being mapped to ATT&CK.",
"type": "string"
},
"mapping_framework_version": {
"description": "The Mapping Framework's version.",
"type": "string"
},
"mapping_framework_version_schema": {
"description": "How the Mapping Framework is versioned.",
"enum": [
"FRAMEWORK_VERSION",
"ACCESS_DATE"
],
"type": "string"
},
"mapping_types": {
"description": "The mappings types that are associated with each Framework.",
"patternProperties": {
"[a-z]+": {
"additionalProperties": false,
"properties": {
"description": {
"description": "A description of the mapping type.",
"type": "string"
},
"name": {
"description": "The mapping type's name.",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
}
},
"type": "object"
},
"mapping_version": {
"description": "The version of the mapping project.",
"type": "string"
},
"organization": {
"description": "The organization associated with the author.",
"type": [
"string",
"null"
]
},
"technology_domain": {
"description": "ATT&CK Technology Domain (Enterprise, Mobile, ICS).",
"enum": [
"enterprise",
"mobile",
"ics"
],
"type": "string"
}
},
"required": [
"mapping_version",
"attack_version",
"technology_domain",
"creation_date",
"mapping_framework",
"mapping_framework_version",
"mapping_types",
"groups"
],
"type": "object"
}
},
"title": "ATT&CK Mappings Unified Schema",
"type": "object"
} | Apache-2.0 | en |
center-for-threat-informed-defense/mappings-explorer | 7d9bab5cb0ea09e23c04c17612ea0851355d9e43 | 2023-10-24T17:35:22 | schema/mapex-unified-data-schema.json | 17 | 2024-05-27T05:59:51.230021Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Defines the data elements and properties of Mappings Explorer projects",
"properties": {
"mapping_object": {
"description": "A single mapping between framework object and ATT&CK object.",
"items": {
"dependentRequired": {
"mapping_type": [
"valid_mapping_types"
]
},
"properties": {
"attack_object_id": {
"description": "The unique identifier of the ATT&CK object being mapped. (T1648)",
"type": "string"
},
"attack_object_name": {
"description": "The name of the ATT&CK object. (Serverless Execution)",
"type": "string"
},
"capability_description": {
"description": "Name or description of framework object",
"type": "string"
},
"capability_id": {
"description": "Unique identifier of the framework object being mapped.",
"type": "string"
},
"comments": {
"description": "Used to document assumptions, circumstances, or other information regarding the mapping",
"type": "string"
},
"else": {},
"if": {
"properties": {
"mapping_type": {
"const": "technique_scores"
}
}
},
"mapping_type": {
"description": "Mapping type has framework-specific values. This property describes how the capability_id and attack_object_id are related.",
"type": "string"
},
"references": {
"description": "A list of links to documentation that provides additional detail in understanding the data contained in this mapping. (A link to the documentation for a security control.)",
"type": "string"
},
"then": {
"properties": {
"related_score": {
"description": "When the ATT&CK object ID is a sub-technique, related score contains the parent technique ID.",
"type": "string"
},
"score_category": {
"description": "Assessment of the effectiveness of the mitigations provided. (Protect, Detect, Respond)",
"items": {
"enum": [
"protect",
"detect",
"respond"
]
},
"type": "array"
},
"score_value": {
"description": "The score. (e.g. Minimal, Partial, Significant)",
"items": {
"enum": [
"minimal",
"partial",
"significant"
]
},
"type": "array"
}
}
}
},
"required": [
"mapping_type",
"capability_id"
],
"type": "object"
},
"type": "array"
},
"metadata": {
"description": "Properties that apply to all mappings in a project.",
"properties": {
"attack_version": {
"description": "The version of ATT&CK used to source the objects included in this mapping.",
"type": "string"
},
"author": {
"description": "The author of this mapping file.",
"type": "string"
},
"contact": {
"description": "The email address of the author.",
"type": "string"
},
"creation_date": {
"description": "Creation date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"last_update": {
"description": "Last update date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"mapping_framework": {
"description": "The group of objects being mapped to ATT&CK.",
"items": {
"enum": [
"veris",
"nist_800_53",
"cve",
"aws",
"gcp",
"azure"
]
},
"type": "string"
},
"mapping_framework_version": {
"description": "The Mapping Framework's version.",
"type": "string"
},
"mapping_framework_version_scheme": {
"description": "How the Mapping Framework is versioned.",
"items": {
"enum": [
"framework",
"date_accessed"
]
},
"type": "array"
},
"mapping_types": {
"description": "The mappings types that are associated with each Framework.",
"items": {
"properties": {
"description": {
"description": "A description of the mapping type.",
"type": "string"
},
"id": {
"description": "The mapping type's identifier.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"mapping_version": {
"description": "The version of the mapping project.",
"type": "string"
},
"organization": {
"description": "The organization associated with the author.",
"type": "string"
},
"technology_domain": {
"description": "ATT&CK Technology Domain (Enterprise, Mobile, ICS).",
"items": {
"enum": [
"enterprise",
"mobile",
"ics"
]
},
"type": "string"
}
},
"required": [
"mapping_version",
"attack_version",
"technology_domain",
"creation_date",
"mapping_framework",
"mapping_framework_version",
"mappings_types"
],
"type": "object"
}
},
"title": "ATT&CK Mappings Unified Schema",
"type": "object"
} | Apache-2.0 | en |
center-for-threat-informed-defense/mappings-explorer | 19d24bbb4b064f184d7b2bcfc6a0cc9e707ff2dd | 2024-01-19T17:36:02 | schema/mapex-unified-data-schema.json | 17 | 2024-05-27T05:59:51.230021Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines the data elements and properties of Mappings Explorer projects",
"properties": {
"mapping_objects": {
"description": "A single mapping between framework object and ATT&CK object.",
"items": {
"additionalProperties": false,
"properties": {
"attack_object_id": {
"description": "The unique identifier of the ATT&CK object being mapped. (T1648)",
"type": [
"string",
"null"
]
},
"attack_object_name": {
"description": "The name of the ATT&CK object. (Serverless Execution)",
"type": [
"string",
"null"
]
},
"author": {
"description": "The author of the mapping",
"type": [
"string",
"null"
]
},
"author_contact": {
"description": "The author of the mapping's contact",
"type": [
"string",
"null"
]
},
"author_organization": {
"description": "The author of the mapping's organization",
"type": [
"string",
"null"
]
},
"capability_description": {
"description": "Name or description of framework object",
"type": "string"
},
"capability_group": {
"description": "This property describes which capability_group this mapping falls into.",
"type": [
"string"
]
},
"capability_id": {
"description": "Unique identifier of the framework object being mapped.",
"type": "string"
},
"comments": {
"description": "Used to document assumptions, circumstances, or other information regarding the mapping",
"type": [
"string",
"null"
]
},
"mapping_type": {
"description": "Mapping type has framework-specific values. This property describes how the capability_id and attack_object_id are related.",
"type": [
"string",
"null"
]
},
"references": {
"description": "A list of links to documentation that provides additional detail in understanding the data contained in this mapping. (A link to the documentation for a security control.)",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"related_score": {
"description": "When the ATT&CK object ID is a sub-technique, related score contains the parent technique ID.",
"type": [
"string",
"null"
]
},
"score_category": {
"description": "Assessment of the effectiveness of the mitigations provided. (Protect, Detect, Respond)",
"enum": [
"protect",
"detect",
"respond",
null
],
"type": [
"string",
"null"
]
},
"score_value": {
"description": "The score. (e.g. Minimal, Partial, Significant)",
"enum": [
"minimal",
"partial",
"significant",
null
],
"type": [
"string",
"null"
]
},
"status": {
"description": "This property describes the status of the mapping, whether it is complete, in progress, or not mapable.",
"enum": [
"complete",
"in_progress",
"non_mappable"
],
"type": "string"
}
},
"required": [
"mapping_type"
],
"type": "object"
},
"type": "array"
},
"metadata": {
"additionalProperties": false,
"description": "Properties that apply to all mappings in a project.",
"properties": {
"attack_version": {
"description": "The version of ATT&CK used to source the objects included in this mapping.",
"type": "string"
},
"author": {
"description": "The author of this mapping file.",
"type": [
"string",
"null"
]
},
"capability_groups": {
"description": "The groups that the mappings can be organized in.",
"type": "object"
},
"contact": {
"description": "The email address of the author.",
"type": [
"string",
"null"
]
},
"creation_date": {
"description": "Creation date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"last_update": {
"description": "Last update date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"mapping_framework": {
"description": "The group of objects being mapped to ATT&CK.",
"type": "string"
},
"mapping_framework_version": {
"description": "The Mapping Framework's version.",
"type": "string"
},
"mapping_framework_version_schema": {
"description": "How the Mapping Framework is versioned.",
"enum": [
"FRAMEWORK_VERSION",
"ACCESS_DATE"
],
"type": "string"
},
"mapping_types": {
"description": "The mappings types that are associated with each Framework.",
"patternProperties": {
"[a-z]+": {
"additionalProperties": false,
"properties": {
"description": {
"description": "A description of the mapping type.",
"type": "string"
},
"name": {
"description": "The mapping type's name.",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
}
},
"type": "object"
},
"mapping_version": {
"description": "The version of the mapping project.",
"type": "string"
},
"organization": {
"description": "The organization associated with the author.",
"type": [
"string",
"null"
]
},
"technology_domain": {
"description": "ATT&CK Technology Domain (Enterprise, Mobile, ICS).",
"enum": [
"enterprise",
"mobile",
"ics"
],
"type": "string"
}
},
"required": [
"mapping_version",
"attack_version",
"technology_domain",
"creation_date",
"mapping_framework",
"mapping_framework_version",
"mapping_types",
"capability_groups"
],
"type": "object"
}
},
"title": "ATT&CK Mappings Unified Schema",
"type": "object"
} | Apache-2.0 | en |
center-for-threat-informed-defense/mappings-explorer | 7a4566e1fa27c7f60469aa3dcf6cb2e8477b698c | 2023-12-12T14:39:41 | schema/mapex-unified-data-schema.json | 17 | 2024-05-27T05:59:51.230021Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines the data elements and properties of Mappings Explorer projects",
"properties": {
"mapping_objects": {
"description": "A single mapping between framework object and ATT&CK object.",
"items": {
"additionalProperties": false,
"properties": {
"attack_object_id": {
"description": "The unique identifier of the ATT&CK object being mapped. (T1648)",
"type": [
"string",
"null"
]
},
"attack_object_name": {
"description": "The name of the ATT&CK object. (Serverless Execution)",
"type": [
"string",
"null"
]
},
"capability_description": {
"description": "Name or description of framework object",
"type": "string"
},
"capability_id": {
"description": "Unique identifier of the framework object being mapped.",
"type": "string"
},
"comments": {
"description": "Used to document assumptions, circumstances, or other information regarding the mapping",
"type": [
"string",
"null"
]
},
"group": {
"description": "This property describes which group this mapping falls into.",
"type": [
"string"
]
},
"mapping_type": {
"description": "Mapping type has framework-specific values. This property describes how the capability_id and attack_object_id are related.",
"type": [
"string",
"null"
]
},
"references": {
"description": "A list of links to documentation that provides additional detail in understanding the data contained in this mapping. (A link to the documentation for a security control.)",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"related_score": {
"description": "When the ATT&CK object ID is a sub-technique, related score contains the parent technique ID.",
"type": [
"string",
"null"
]
},
"score_category": {
"description": "Assessment of the effectiveness of the mitigations provided. (Protect, Detect, Respond)",
"enum": [
"protect",
"detect",
"respond",
null
],
"type": [
"string",
"null"
]
},
"score_value": {
"description": "The score. (e.g. Minimal, Partial, Significant)",
"enum": [
"minimal",
"partial",
"significant",
null
],
"type": [
"string",
"null"
]
},
"status": {
"description": "This property describes the status of the mapping, whether it is complete, in progress, or not mapable.",
"enum": [
"complete",
"in_progress",
"not_mappable"
],
"type": "string"
}
},
"required": [
"mapping_type",
"capability_id"
],
"type": "object"
},
"type": "array"
},
"metadata": {
"additionalProperties": false,
"description": "Properties that apply to all mappings in a project.",
"properties": {
"attack_version": {
"description": "The version of ATT&CK used to source the objects included in this mapping.",
"type": "string"
},
"author": {
"description": "The author of this mapping file.",
"type": "string"
},
"contact": {
"description": "The email address of the author.",
"type": "string"
},
"creation_date": {
"description": "Creation date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"groups": {
"description": "The groups that the mappings can be organized in.",
"type": "object"
},
"last_update": {
"description": "Last update date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"mapping_framework": {
"description": "The group of objects being mapped to ATT&CK.",
"enum": [
"veris",
"nist_800_53",
"cve",
"aws",
"gcp",
"azure"
],
"type": "string"
},
"mapping_framework_version": {
"description": "The Mapping Framework's version.",
"type": "string"
},
"mapping_framework_version_schema": {
"description": "How the Mapping Framework is versioned.",
"enum": [
"FRAMEWORK_VERSION",
"ACCESS_DATE"
],
"type": "string"
},
"mapping_types": {
"description": "The mappings types that are associated with each Framework.",
"patternProperties": {
"[a-z]+": {
"additionalProperties": false,
"properties": {
"description": {
"description": "A description of the mapping type.",
"type": "string"
},
"name": {
"description": "The mapping type's name.",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
}
},
"type": "object"
},
"mapping_version": {
"description": "The version of the mapping project.",
"type": "string"
},
"organization": {
"description": "The organization associated with the author.",
"type": "string"
},
"technology_domain": {
"description": "ATT&CK Technology Domain (Enterprise, Mobile, ICS).",
"enum": [
"enterprise",
"mobile",
"ics"
],
"type": "string"
}
},
"required": [
"mapping_version",
"attack_version",
"technology_domain",
"creation_date",
"mapping_framework",
"mapping_framework_version",
"mapping_types",
"groups"
],
"type": "object"
}
},
"title": "ATT&CK Mappings Unified Schema",
"type": "object"
} | Apache-2.0 | en |
center-for-threat-informed-defense/mappings-explorer | cb16bb098f4ae9ead0f2c47871c8a53f6e6ae22e | 2024-02-14T04:25:39 | schema/mapex-unified-data-schema.json | 17 | 2024-05-27T05:59:51.230021Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines the data elements and properties of Mappings Explorer projects",
"properties": {
"mapping_objects": {
"description": "A single mapping between framework object and ATT&CK object.",
"items": {
"additionalProperties": false,
"properties": {
"attack_object_id": {
"description": "The unique identifier of the ATT&CK object being mapped. (T1648)",
"type": [
"string",
"null"
]
},
"attack_object_name": {
"description": "The name of the ATT&CK object. (Serverless Execution)",
"type": [
"string",
"null"
]
},
"attack_version": {
"description": "The version of ATT&CK used to source the objects included in this mapping.",
"type": "string"
},
"author": {
"description": "The author of the mapping",
"type": [
"string",
"null"
]
},
"author_contact": {
"description": "The author of the mapping's contact",
"type": [
"string",
"null"
]
},
"author_organization": {
"description": "The author of the mapping's organization",
"type": [
"string",
"null"
]
},
"capability_description": {
"description": "Name or description of framework object",
"type": [
"string",
"null"
]
},
"capability_group": {
"description": "This property describes which capability_group this mapping falls into.",
"type": [
"string",
"null"
]
},
"capability_id": {
"description": "Unique identifier of the framework object being mapped.",
"type": [
"string",
"null"
]
},
"comments": {
"description": "Used to document assumptions, circumstances, or other information regarding the mapping",
"type": [
"string",
"null"
]
},
"mapping_framework": {
"description": "The name of the mapping framework. (Veris)",
"type": "string"
},
"mapping_framework_version": {
"description": "The version of the mapping framework. (1.3.7)",
"type": "string"
},
"mapping_type": {
"description": "Mapping type has framework-specific values. This property describes how the capability_id and attack_object_id are related.",
"type": [
"string",
"null"
]
},
"references": {
"description": "A list of links to documentation that provides additional detail in understanding the data contained in this mapping. (A link to the documentation for a security control.)",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"related_score": {
"description": "When the ATT&CK object ID is a sub-technique, related score contains the parent technique ID.",
"type": [
"string",
"null"
]
},
"score_category": {
"description": "Assessment of the effectiveness of the mitigations provided. (Protect, Detect, Respond)",
"enum": [
"protect",
"detect",
"respond",
null
],
"type": [
"string",
"null"
]
},
"score_value": {
"description": "The score. (e.g. Minimal, Partial, Significant)",
"enum": [
"minimal",
"partial",
"significant",
null
],
"type": [
"string",
"null"
]
},
"status": {
"description": "This property describes the status of the mapping, whether it is complete, in progress, or not mapable.",
"enum": [
"complete",
"in_progress",
"non_mappable"
],
"type": "string"
},
"technology_domain": {
"description": "ATT&CK Technology Domain (Enterprise, Mobile, ICS).",
"type": "string"
}
},
"required": [
"mapping_type"
],
"type": "object"
},
"type": "array"
},
"metadata": {
"additionalProperties": false,
"description": "Properties that apply to all mappings in a project.",
"properties": {
"attack_version": {
"description": "The version of ATT&CK used to source the objects included in this mapping.",
"type": "string"
},
"author": {
"description": "The author of this mapping file.",
"type": [
"string",
"null"
]
},
"capability_groups": {
"description": "The groups that the mappings can be organized in.",
"type": "object"
},
"contact": {
"description": "The email address of the author.",
"type": [
"string",
"null"
]
},
"creation_date": {
"description": "Creation date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"last_update": {
"description": "Last update date of this mapping file. Format: (MM/DD/YYYY) 1/21/2021",
"pattern": "^[0-9]{2}/[0-9]{2}/[0-9]{4}$",
"type": "string"
},
"mapping_framework": {
"description": "The group of objects being mapped to ATT&CK.",
"type": "string"
},
"mapping_framework_version": {
"description": "The Mapping Framework's version.",
"type": "string"
},
"mapping_framework_version_schema": {
"description": "How the Mapping Framework is versioned.",
"enum": [
"FRAMEWORK_VERSION",
"ACCESS_DATE"
],
"type": "string"
},
"mapping_types": {
"description": "The mappings types that are associated with each Framework.",
"patternProperties": {
"[a-z]+": {
"additionalProperties": false,
"properties": {
"description": {
"description": "A description of the mapping type.",
"type": "string"
},
"name": {
"description": "The mapping type's name.",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
}
},
"type": "object"
},
"mapping_version": {
"description": "The version of the mapping project.",
"type": "string"
},
"organization": {
"description": "The organization associated with the author.",
"type": [
"string",
"null"
]
},
"technology_domain": {
"description": "ATT&CK Technology Domain (Enterprise, Mobile, ICS).",
"enum": [
"enterprise",
"mobile",
"ics"
],
"type": "string"
}
},
"required": [
"mapping_version",
"attack_version",
"technology_domain",
"creation_date",
"mapping_framework",
"mapping_framework_version",
"mapping_types",
"capability_groups"
],
"type": "object"
}
},
"title": "ATT&CK Mappings Unified Schema",
"type": "object"
} | Apache-2.0 | en |
center-for-threat-informed-defense/attack-flow | 912089dafcf796718c7df74dfc4ab865d72b077a | 2022-09-07T17:55:28 | stix/attack-flow-schema-2.0.0.json | 512 | 2024-05-28T03:30:05.859353Z | {
"$defs": {
"attack-action": {
"description": "An ``attack-action`` object represents the execution of a particular technique, i.e. a discrete unit of adverary behavior.",
"properties": {
"asset_refs": {
"description": "The assets involved in this action, i.e. where this action modifies or depends on the state of the asset.",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-asset)--"
}
]
},
"minItems": 1,
"type": "array"
},
"command_ref": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^process--"
}
],
"description": "Describe tools or commands executed by the attacker by referring to a STIX Process object, which can represent commands, environment variables, process image, etc."
},
"description": {
"description": "A description of the adversary behavior, e.g. what they did, how they did it, and why. This field may contain prose as well as technical information, but consider using ``command_ref`` for providing technical details about technique execution.",
"type": "string"
},
"effect_refs": {
"description": "The potential effects that result from executing this action. (See: :ref:`effects`.)",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-action|attack-operator|attack-condition)--"
}
]
},
"minItems": 1,
"type": "array"
},
"spec_version": {
"const": "2.1",
"description": "The version **MUST** be ``2.1``.",
"type": "string"
},
"technique_id": {
"description": "A technique identifier or shortname that may reference an authoritative collection of techniques, e.g. ATT&CK.",
"type": "string"
},
"technique_name": {
"description": "The name of the technique.",
"type": "string"
},
"technique_ref": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^attack-pattern--"
}
],
"description": "A reference to the technique's STIX representation."
},
"type": {
"const": "attack-action",
"description": "The type **MUST** be ``attack-action``.",
"type": "string"
}
},
"required": [
"type",
"spec_version",
"technique_name"
],
"type": "object",
"x-exampleObject": "attack-action--37345417-3ee0-4e11-b421-1d4be68e6f15"
},
"attack-asset": {
"description": "An asset is any object that is the subject or target of an action. Assets can be technical assets (such as machines and data) or non-technical assets such as people and physical systems. Actions typically either modify or depend upon the *state* of an asset in some way.\n\nNote that assets are not applicable in all contexts. For example, public threat reports may not include enough detail to represent the assets in a flow, or the flow might represent aggregate behavior (at the campaign or actor level) for which it does not make sense to specify an asset. Assets should be used to add context to a flow when the underlying intelligence contains sufficient detail to do so.",
"properties": {
"description": {
"description": "A description of the asset.",
"type": "string"
},
"name": {
"description": "An name for the asset.",
"type": "string"
},
"object_ref": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"description": "A reference to any STIX data object (i.e. SDO) or observable (i.e. SCO) that contains structured data about this asset."
},
"spec_version": {
"const": "2.1",
"description": "The version **MUST** be ``2.1``.",
"type": "string"
},
"type": {
"const": "attack-asset",
"description": "The type **MUST** be ``attack-asset``.",
"type": "string"
}
},
"required": [
"type",
"spec_version",
"name"
],
"type": "object",
"x-exampleObject": "attack-asset--f7edf4aa-29ec-47aa-b4f6-c42dfbe2ac20"
},
"attack-condition": {
"description": "An ``attack-condition`` object represents some possible condition, outcome, or state that could occur. Conditions can be used to split flows based on the success or failure of an action, or to provide further description of an action's results.",
"properties": {
"description": {
"description": "The condition that is evaluated, usually based on the success or failure of the preceding action.",
"type": "string"
},
"on_false_refs": {
"description": "When the condition is ``false``, the flow continues to these objects. (If there are no objects, then the flow halts at this node.)",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-action|attack-operator|attack-condition)--"
}
]
},
"minItems": 1,
"type": "array"
},
"on_true_refs": {
"description": "When the condition is ``true``, the flow continues to these objects.",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-action|attack-operator|attack-condition)--"
}
]
},
"minItems": 1,
"type": "array"
},
"pattern": {
"description": "*(This is an experimental feature.)* The detection pattern for this condition may be expressed as a STIX Pattern or another appropriate language such as SNORT, YARA, etc.",
"type": "string"
},
"pattern_type": {
"description": "*(This is an experimental feature.)* The pattern langauge used in this condition. The value for this property should come from the STIX ``pattern-type-ov`` open vocabulary.",
"type": "string"
},
"pattern_version": {
"description": "*(This is an experimental feature.)* The version of the pattern language used for the data in the ``pattern`` property. For the STIX Pattern language, the default value is determined by the ``spec_version`` of the condition object.",
"type": "string"
},
"spec_version": {
"const": "2.1",
"description": "The version **MUST** be ``2.1``.",
"type": "string"
},
"type": {
"const": "attack-condition",
"description": "The type **MUST** be ``attack-condition``.",
"type": "string"
}
},
"required": [
"type",
"spec_version",
"description"
],
"type": "object",
"x-exampleObject": "attack-condition--7e809f5b-319a-4b3f-82fe-e4dc09af5088"
},
"attack-flow": {
"description": "An ``attack-flow`` object represents the Attack Flow overall. It provides metadata for name and description; it provides starting points for the flow of actions; and it is an object that can be referenced from other STIX objects.",
"properties": {
"description": {
"description": "A description of the overall Attack Flow.",
"type": "string"
},
"name": {
"description": "The name of the Attack Flow.",
"type": "string"
},
"scope": {
"description": "Indicates what type of behavior the Attack Flow describes: a specific incident, a campaign, etc.",
"enum": [
"incident",
"campaign",
"threat-actor",
"malware",
"other"
],
"type": "string"
},
"spec_version": {
"const": "2.1",
"description": "The version **MUST** be ``2.1``.",
"type": "string"
},
"start_refs": {
"description": "A list of objects that start the flow.",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-action|attack-condition)--"
}
]
},
"minItems": 1,
"type": "array"
},
"type": {
"const": "attack-flow",
"description": "The type **MUST** be ``attack-flow``.",
"type": "string"
}
},
"required": [
"type",
"spec_version",
"name",
"start_refs",
"scope"
],
"type": "object",
"x-exampleObject": "attack-flow--e9ec3a4b-f787-4e81-a3d9-4cfe017ebc2f"
},
"attack-operator": {
"description": "An ``attack-operator`` object joins multiple attack paths together using boolean logic.",
"properties": {
"effect_refs": {
"description": "The effects, outcomes, or states that result when this operator evaluates to ``true``. If the operator evaluates to ``false``, then the flow halts. (See: :ref:`effects`.)",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-action|attack-operator|attack-condition)--"
}
]
},
"minItems": 1,
"type": "array"
},
"operator": {
"description": "The logical operator to apply to the input effects.",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"spec_version": {
"const": "2.1",
"description": "The version **MUST** be ``2.1``.",
"type": "string"
},
"type": {
"const": "attack-operator",
"description": "The type **MUST** be ``attack-operator``.",
"type": "string"
}
},
"required": [
"type",
"spec_version",
"operator"
],
"type": "object",
"x-exampleObject": "attack-operator--609d7adf-a3d2-44e8-82de-4b30e3fb97be"
}
},
"$id": "https://center-for-threat-informed-defense.github.io/attack-flow/schema/attack-flow-schema-2.0.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$comment": "All Attack Flow SDOs implement the required common properties.",
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/core.json"
},
{
"$comment": "Attack Flow SDOs must reference the extension definition.",
"properties": {
"extensions": {
"properties": {
"extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4": {
"properties": {
"extension_type": {
"const": "new-sdo",
"type": "string"
}
},
"required": [
"extension_type"
],
"type": "object"
}
},
"required": [
"extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4"
],
"type": "object"
}
},
"required": [
"extensions"
],
"type": "object"
},
{
"$comment": "Link to the Attack Flow SDO subschemas.",
"oneOf": [
{
"$ref": "#/$defs/attack-action"
},
{
"$ref": "#/$defs/attack-asset"
},
{
"$ref": "#/$defs/attack-condition"
},
{
"$ref": "#/$defs/attack-flow"
},
{
"$ref": "#/$defs/attack-operator"
}
]
}
],
"description": "This schema is the normative definition of the STIX 2.1 extension `extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4`. It extends STIX with additional STIX Data Objects (SDOs) that model Attack Flow concepts.",
"title": "Attack Flow STIX 2.1 Extension",
"type": "object",
"unevaluatedProperties": false
} | Apache-2.0 | en |
center-for-threat-informed-defense/attack-flow | 99350f25ab1a8f6ffa8dd6e641acedfa8fe336b8 | 2022-08-15T20:06:26 | stix/attack-flow-schema-2.0.0.json | 512 | 2024-05-28T03:30:05.859353Z | {
"$defs": {
"attack-action": {
"description": "An ``attack-action`` object represents the execution of a particular technique, i.e. a discrete unit of adverary behavior.",
"properties": {
"description": {
"description": "A description of the adversary behavior.",
"type": "string"
},
"effect_refs": {
"description": "The potential effects that result from executing this action. (See: :ref:`effects`.)",
"items": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"x-referenceType": [
"attack-action",
"attack-operator",
"attack-condition"
]
},
"minItems": 1,
"type": "array"
},
"technique_id": {
"description": "A technique identifier or shortname that may reference an authoritative collection of techniques, e.g. ATT&CK.",
"type": "string"
},
"technique_name": {
"description": "The name of the technique.",
"type": "string"
},
"technique_ref": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"description": "A reference to the technique's STIX representation."
}
},
"required": [
"technique_name"
],
"type": "object",
"x-exampleObject": "attack-action--37345417-3ee0-4e11-b421-1d4be68e6f15"
},
"attack-condition": {
"description": "An ``attack-condition`` object represents some possible condition, outcome, or state that could occur. Conditions can be used to split flows based on the success or failure of an action, or to provide further description of an action's results.",
"properties": {
"description": {
"description": "The condition that is evaluated, usually based on the success or failure of the preceding action.",
"type": "string"
},
"on_false_refs": {
"description": "When the condition is ``false``, the flow continues to these objects. (If there are no objects, then the flow halts at this node.)",
"items": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"x-referenceType": [
"attack-action",
"attack-operator",
"attack-condition"
]
},
"minItems": 1,
"type": "array"
},
"on_true_refs": {
"description": "When the condition is ``true``, the flow continues to these objects.",
"items": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"x-referenceType": [
"attack-action",
"attack-operator",
"attack-condition"
]
},
"minItems": 1,
"type": "array"
}
},
"required": [
"description"
],
"type": "object",
"x-exampleObject": "attack-condition--7e809f5b-319a-4b3f-82fe-e4dc09af5088"
},
"attack-flow": {
"description": "An ``attack-flow`` object represents the Attack Flow overall. It provides metadata for name and description; it provides starting points for the flow of actions; and it is an object that can be referenced from other STIX objects.",
"properties": {
"description": {
"description": "A description of the overall Attack Flow.",
"type": "string"
},
"name": {
"description": "The name of the Attack Flow.",
"type": "string"
},
"scope": {
"description": "Indicates what type of behavior the Attack Flow describes: a specific incident, a campaign, etc.",
"enum": [
"incident",
"campaign",
"threat-actor",
"malware",
"other"
],
"type": "string"
},
"start_refs": {
"description": "A list of objects that start the flow.",
"items": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"x-referenceType": [
"attack-action",
"attack-condition"
]
},
"minItems": 1,
"type": "array"
}
},
"required": [
"name",
"start_refs",
"scope"
],
"type": "object",
"x-exampleObject": "attack-flow--e9ec3a4b-f787-4e81-a3d9-4cfe017ebc2f"
},
"attack-operator": {
"description": "An ``attack-operator`` object joins multiple attack paths together using boolean logic.",
"properties": {
"effect_refs": {
"description": "The effects, outcomes, or states that result when this operator evaluates to ``true``. If the operator evaluates to ``false``, then the flow halts. (See: :ref:`effects`.)",
"items": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"x-referenceType": [
"attack-action",
"attack-operator",
"attack-condition"
]
},
"minItems": 1,
"type": "array"
},
"operator": {
"description": "The logical operator to apply to the input effects.",
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"required": [
"operator"
],
"type": "object",
"x-exampleObject": "attack-operator--609d7adf-a3d2-44e8-82de-4b30e3fb97be"
}
},
"$id": "https://center-for-threat-informed-defense.github.io/attack-flow/schema/attack-flow-schema-2.0.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$comment": "All Attack Flow SDOs implement the required common properties.",
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/core.json"
},
{
"$comment": "Attack Flow SDOs must reference the extension definition.",
"properties": {
"extensions": {
"properties": {
"extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4": {
"properties": {
"extension_type": {
"const": "new-sdo",
"type": "string"
}
},
"required": [
"extension_type"
],
"type": "object"
}
},
"required": [
"extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4"
],
"type": "object"
}
},
"required": [
"extensions"
],
"type": "object"
},
{
"$comment": "Link to the Attack Flow SDO subschemas based on object type.",
"else": {
"else": {
"else": {
"else": true,
"if": {
"properties": {
"type": {
"const": "attack-operator",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-operator"
}
},
"if": {
"properties": {
"type": {
"const": "attack-condition",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-condition"
}
},
"if": {
"properties": {
"type": {
"const": "attack-action",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-action"
}
},
"if": {
"properties": {
"type": {
"const": "attack-flow",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-flow"
}
}
],
"description": "This schema is the normative definition of the STIX 2.1 extension `extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4`. It extends STIX with additional STIX Data Objects (SDOs) and SDO properties to implement Attack Flow concepts, i.e. generalized graphs of adversary behaviors.",
"title": "Attack Flow STIX 2.1 Extension",
"type": "object"
} | Apache-2.0 | en |
center-for-threat-informed-defense/attack-flow | 79d21070a2f4bd47dbb75a077fb21b2bd58b5bf9 | 2022-10-21T20:39:07 | stix/attack-flow-schema-2.0.0.json | 512 | 2024-05-28T03:30:05.859353Z | {
"$defs": {
"attack-action": {
"description": "An ``attack-action`` object represents the execution of a particular technique, i.e. a discrete unit of adverary behavior.",
"properties": {
"asset_refs": {
"description": "The assets involved in this action, i.e. where this action modifies or depends on the state of the asset.",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-asset)--"
}
]
},
"minItems": 1,
"type": "array"
},
"command_ref": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^process--"
}
],
"description": "Describe tools or commands executed by the attacker by referring to a STIX Process object, which can represent commands, environment variables, process image, etc."
},
"description": {
"description": "A description of the adversary behavior, e.g. what they did, how they did it, and why. This field may contain prose as well as technical information, but consider using ``command_ref`` for providing technical details about technique execution.",
"type": "string"
},
"effect_refs": {
"description": "The potential effects that result from executing this action. (See: :ref:`effects`.)",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-action|attack-operator|attack-condition)--"
}
]
},
"minItems": 1,
"type": "array"
},
"execution_end": {
"$ref": "https://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/master/schemas/common/timestamp.json",
"description": "Timestamp indicating when the execution of this action ended."
},
"execution_start": {
"$ref": "https://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/master/schemas/common/timestamp.json",
"description": "Timestamp indicating when the execution of this action began."
},
"name": {
"description": "The name of the technique, or if a specific technique is not known, then the name of the tactic.",
"type": "string"
},
"spec_version": {
"const": "2.1",
"description": "The version **MUST** be ``2.1``.",
"type": "string"
},
"tactic_id": {
"description": "A tactic identifier or shortname that may reference an authoritative collection of tactics, e.g. ATT&CK.",
"type": "string"
},
"tactic_ref": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
}
],
"description": "A reference to the tactic's STIX representation. For ATT&CK, this should be an ``x-mitre-tactic`` object."
},
"technique_id": {
"description": "A technique identifier or shortname that may reference an authoritative collection of techniques, e.g. ATT&CK.",
"type": "string"
},
"technique_ref": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^attack-pattern--"
}
],
"description": "A reference to the technique's STIX representation."
},
"type": {
"const": "attack-action",
"description": "The type **MUST** be ``attack-action``.",
"type": "string"
}
},
"required": [
"type",
"spec_version",
"name"
],
"type": "object",
"x-exampleObject": "attack-action--37345417-3ee0-4e11-b421-1d4be68e6f15"
},
"attack-asset": {
"description": "An asset is any object that is the subject or target of an action. Assets can be technical assets (such as machines and data) or non-technical assets such as people and physical systems. Actions typically either modify or depend upon the *state* of an asset in some way.\n\nNote that assets are not applicable in all contexts. For example, public threat reports may not include enough detail to represent the assets in a flow, or the flow might represent aggregate behavior (at the campaign or actor level) for which it does not make sense to specify an asset. Assets should be used to add context to a flow when the underlying intelligence contains sufficient detail to do so.",
"properties": {
"description": {
"description": "A description of the asset.",
"type": "string"
},
"name": {
"description": "An name for the asset.",
"type": "string"
},
"object_ref": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"description": "A reference to any STIX data object (i.e. SDO) or observable (i.e. SCO) that contains structured data about this asset."
},
"spec_version": {
"const": "2.1",
"description": "The version **MUST** be ``2.1``.",
"type": "string"
},
"type": {
"const": "attack-asset",
"description": "The type **MUST** be ``attack-asset``.",
"type": "string"
}
},
"required": [
"type",
"spec_version",
"name"
],
"type": "object",
"x-exampleObject": "attack-asset--f7edf4aa-29ec-47aa-b4f6-c42dfbe2ac20"
},
"attack-condition": {
"description": "An ``attack-condition`` object represents some possible condition, outcome, or state that could occur. Conditions can be used to split flows based on the success or failure of an action, or to provide further description of an action's results.",
"properties": {
"description": {
"description": "The condition that is evaluated, usually based on the success or failure of the preceding action.",
"type": "string"
},
"on_false_refs": {
"description": "When the condition is ``false``, the flow continues to these objects. (If there are no objects, then the flow halts at this node.)",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-action|attack-operator|attack-condition)--"
}
]
},
"minItems": 1,
"type": "array"
},
"on_true_refs": {
"description": "When the condition is ``true``, the flow continues to these objects.",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-action|attack-operator|attack-condition)--"
}
]
},
"minItems": 1,
"type": "array"
},
"pattern": {
"description": "*(This is an experimental feature.)* The detection pattern for this condition may be expressed as a STIX Pattern or another appropriate language such as SNORT, YARA, etc.",
"type": "string"
},
"pattern_type": {
"description": "*(This is an experimental feature.)* The pattern langauge used in this condition. The value for this property should come from the STIX ``pattern-type-ov`` open vocabulary.",
"type": "string"
},
"pattern_version": {
"description": "*(This is an experimental feature.)* The version of the pattern language used for the data in the ``pattern`` property. For the STIX Pattern language, the default value is determined by the ``spec_version`` of the condition object.",
"type": "string"
},
"spec_version": {
"const": "2.1",
"description": "The version **MUST** be ``2.1``.",
"type": "string"
},
"type": {
"const": "attack-condition",
"description": "The type **MUST** be ``attack-condition``.",
"type": "string"
}
},
"required": [
"type",
"spec_version",
"description"
],
"type": "object",
"x-exampleObject": "attack-condition--7e809f5b-319a-4b3f-82fe-e4dc09af5088"
},
"attack-flow": {
"description": "Every Attack Flow document **MUST** contain exactly one ``attack-flow`` object. It provides metadata for name and description, starting points for the flow of actions, and can be referenced from other STIX objects.",
"properties": {
"description": {
"description": "A description of the overall Attack Flow.",
"type": "string"
},
"name": {
"description": "The name of the Attack Flow.",
"type": "string"
},
"scope": {
"description": "Indicates what type of behavior the Attack Flow describes: a specific incident, a campaign, etc.",
"enum": [
"incident",
"campaign",
"threat-actor",
"malware",
"other"
],
"type": "string"
},
"spec_version": {
"const": "2.1",
"description": "The version **MUST** be ``2.1``.",
"type": "string"
},
"start_refs": {
"description": "A list of objects that start the flow.",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-action|attack-condition)--"
}
]
},
"minItems": 1,
"type": "array"
},
"type": {
"const": "attack-flow",
"description": "The type **MUST** be ``attack-flow``.",
"type": "string"
}
},
"required": [
"type",
"spec_version",
"name",
"start_refs",
"scope"
],
"type": "object",
"x-exampleObject": "attack-flow--e9ec3a4b-f787-4e81-a3d9-4cfe017ebc2f"
},
"attack-operator": {
"description": "An ``attack-operator`` object joins multiple attack paths together using boolean logic.",
"properties": {
"effect_refs": {
"description": "The effects, outcomes, or states that result when this operator evaluates to ``true``. If the operator evaluates to ``false``, then the flow halts. (See: :ref:`effects`.)",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-action|attack-operator|attack-condition)--"
}
]
},
"minItems": 1,
"type": "array"
},
"operator": {
"description": "The logical operator to apply to the input effects.",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"spec_version": {
"const": "2.1",
"description": "The version **MUST** be ``2.1``.",
"type": "string"
},
"type": {
"const": "attack-operator",
"description": "The type **MUST** be ``attack-operator``.",
"type": "string"
}
},
"required": [
"type",
"spec_version",
"operator"
],
"type": "object",
"x-exampleObject": "attack-operator--609d7adf-a3d2-44e8-82de-4b30e3fb97be"
}
},
"$id": "https://center-for-threat-informed-defense.github.io/attack-flow/schema/attack-flow-schema-2.0.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$comment": "All Attack Flow SDOs implement the required common properties.",
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/core.json"
},
{
"$comment": "Attack Flow SDOs must reference the extension definition.",
"properties": {
"extensions": {
"properties": {
"extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4": {
"properties": {
"extension_type": {
"const": "new-sdo",
"type": "string"
}
},
"required": [
"extension_type"
],
"type": "object"
}
},
"required": [
"extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4"
],
"type": "object"
}
},
"required": [
"extensions"
],
"type": "object"
},
{
"$comment": "Link to the Attack Flow SDO subschemas based on object type. Note: this nested if-else construction is difficult to maintain. We weighed several different structures here, e.g. using a oneOf, but selected this structure because it produces better validation messages than a oneOf and make it easy to forward-reference the Attack Flow SDO subschemas from the main Attack Flow schema.",
"else": {
"else": {
"else": {
"else": {
"else": true,
"if": {
"properties": {
"type": {
"const": "attack-asset",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-asset"
}
},
"if": {
"properties": {
"type": {
"const": "attack-operator",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-operator"
}
},
"if": {
"properties": {
"type": {
"const": "attack-condition",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-condition"
}
},
"if": {
"properties": {
"type": {
"const": "attack-action",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-action"
}
},
"if": {
"properties": {
"type": {
"const": "attack-flow",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-flow"
}
}
],
"description": "This schema is the normative definition of the STIX 2.1 extension `extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4`. It extends STIX with additional STIX Data Objects (SDOs) that model Attack Flow concepts.",
"title": "Attack Flow STIX 2.1 Extension",
"type": "object",
"unevaluatedProperties": false
} | Apache-2.0 | en |
center-for-threat-informed-defense/attack-flow | 1c39a763b4f663b3374dd2f771c5f2cbd3522f4d | 2022-08-30T15:34:42 | stix/attack-flow-schema-2.0.0.json | 512 | 2024-05-28T03:30:05.859353Z | {
"$defs": {
"attack-action": {
"description": "An ``attack-action`` object represents the execution of a particular technique, i.e. a discrete unit of adverary behavior.",
"properties": {
"asset_refs": {
"description": "The assets involved in this action, i.e. where this action modifies or depends on the state of the asset.",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-asset)--"
}
]
},
"minItems": 1,
"type": "array"
},
"command_ref": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^process--"
}
],
"description": "Describe tools or commands executed by the attacker by referring to a STIX Process object, which can represent commands, environment variables, process image, etc."
},
"description": {
"description": "A description of the adversary behavior, e.g. what they did, how they did it, and why. This field may contain prose as well as technical information, but consider using ``command_ref`` for providing technical details about technique execution.",
"type": "string"
},
"effect_refs": {
"description": "The potential effects that result from executing this action. (See: :ref:`effects`.)",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-action|attack-operator|attack-condition)--"
}
]
},
"minItems": 1,
"type": "array"
},
"spec_version": {
"const": "2.1",
"description": "The version must be ``2.1``.",
"type": "string"
},
"technique_id": {
"description": "A technique identifier or shortname that may reference an authoritative collection of techniques, e.g. ATT&CK.",
"type": "string"
},
"technique_name": {
"description": "The name of the technique.",
"type": "string"
},
"technique_ref": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^attack-pattern--"
}
],
"description": "A reference to the technique's STIX representation."
},
"type": {
"const": "attack-action",
"description": "The type must be ``attack-action``.",
"type": "string"
}
},
"required": [
"type",
"spec_version",
"technique_name"
],
"type": "object",
"x-exampleObject": "attack-action--37345417-3ee0-4e11-b421-1d4be68e6f15"
},
"attack-asset": {
"description": "An asset is any object that is the subject or target of an action. Assets can be technical assets (such as machines and data) or non-technical assets such as people and physical systems. Actions typically either modify or depend upon the *state* of an asset in some way.\n\nNote that assets are not applicable in all contexts. For example, public threat reports may not include enough detail to represent the assets in a flow, or the flow might represent aggregate behavior (at the campaign or actor level) for which it does not make sense to specify an asset. Assets should be used to add context to a flow when the underlying intelligence contains sufficient detail to do so.",
"properties": {
"description": {
"description": "A description of the asset.",
"type": "string"
},
"name": {
"description": "An name for the asset.",
"type": "string"
},
"object_ref": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"description": "A reference to any STIX data object (i.e. SDO) or observable (i.e. SCO) that contains structured data about this asset."
},
"spec_version": {
"const": "2.1",
"description": "The version must be ``2.1``.",
"type": "string"
},
"type": {
"const": "attack-asset",
"description": "The type must be ``attack-asset``.",
"type": "string"
}
},
"required": [
"type",
"spec_version",
"name"
],
"type": "object",
"x-exampleObject": "attack-asset--f7edf4aa-29ec-47aa-b4f6-c42dfbe2ac20"
},
"attack-condition": {
"description": "An ``attack-condition`` object represents some possible condition, outcome, or state that could occur. Conditions can be used to split flows based on the success or failure of an action, or to provide further description of an action's results.",
"properties": {
"description": {
"description": "The condition that is evaluated, usually based on the success or failure of the preceding action.",
"type": "string"
},
"on_false_refs": {
"description": "When the condition is ``false``, the flow continues to these objects. (If there are no objects, then the flow halts at this node.)",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-action|attack-operator|attack-condition)--"
}
]
},
"minItems": 1,
"type": "array"
},
"on_true_refs": {
"description": "When the condition is ``true``, the flow continues to these objects.",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-action|attack-operator|attack-condition)--"
}
]
},
"minItems": 1,
"type": "array"
},
"pattern": {
"description": "*(This is an experimental feature.)* The detection pattern for this condition may be expressed as a STIX Pattern or another appropriate language such as SNORT, YARA, etc.",
"type": "string"
},
"pattern_type": {
"description": "*(This is an experimental feature.)* The pattern langauge used in this condition. The value for this property should come from the STIX ``pattern-type-ov`` open vocabulary.",
"type": "string"
},
"pattern_version": {
"description": "*(This is an experimental feature.)* The version of the pattern language used for the data in the ``pattern`` property. For the STIX Pattern language, the default value is determined by the ``spec_version`` of the condition object.",
"type": "string"
},
"spec_version": {
"const": "2.1",
"description": "The version must be ``2.1``.",
"type": "string"
},
"type": {
"const": "attack-condition",
"description": "The type must be ``attack-condition``.",
"type": "string"
}
},
"required": [
"type",
"spec_version",
"description"
],
"type": "object",
"x-exampleObject": "attack-condition--7e809f5b-319a-4b3f-82fe-e4dc09af5088"
},
"attack-flow": {
"description": "An ``attack-flow`` object represents the Attack Flow overall. It provides metadata for name and description; it provides starting points for the flow of actions; and it is an object that can be referenced from other STIX objects.",
"properties": {
"description": {
"description": "A description of the overall Attack Flow.",
"type": "string"
},
"name": {
"description": "The name of the Attack Flow.",
"type": "string"
},
"scope": {
"description": "Indicates what type of behavior the Attack Flow describes: a specific incident, a campaign, etc.",
"enum": [
"incident",
"campaign",
"threat-actor",
"malware",
"other"
],
"type": "string"
},
"spec_version": {
"const": "2.1",
"description": "The version must be ``2.1``.",
"type": "string"
},
"start_refs": {
"description": "A list of objects that start the flow.",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-action|attack-condition)--"
}
]
},
"minItems": 1,
"type": "array"
},
"type": {
"const": "attack-flow",
"description": "The type must be ``attack-flow``.",
"type": "string"
}
},
"required": [
"type",
"spec_version",
"name",
"start_refs",
"scope"
],
"type": "object",
"x-exampleObject": "attack-flow--e9ec3a4b-f787-4e81-a3d9-4cfe017ebc2f"
},
"attack-operator": {
"description": "An ``attack-operator`` object joins multiple attack paths together using boolean logic.",
"properties": {
"effect_refs": {
"description": "The effects, outcomes, or states that result when this operator evaluates to ``true``. If the operator evaluates to ``false``, then the flow halts. (See: :ref:`effects`.)",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-action|attack-operator|attack-condition)--"
}
]
},
"minItems": 1,
"type": "array"
},
"operator": {
"description": "The logical operator to apply to the input effects.",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"spec_version": {
"const": "2.1",
"description": "The version must be ``2.1``.",
"type": "string"
},
"type": {
"const": "attack-operator",
"description": "The type must be ``attack-operator``.",
"type": "string"
}
},
"required": [
"type",
"spec_version",
"operator"
],
"type": "object",
"x-exampleObject": "attack-operator--609d7adf-a3d2-44e8-82de-4b30e3fb97be"
}
},
"$id": "https://center-for-threat-informed-defense.github.io/attack-flow/schema/attack-flow-schema-2.0.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$comment": "All Attack Flow SDOs implement the required common properties.",
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/core.json"
},
{
"$comment": "Attack Flow SDOs must reference the extension definition.",
"properties": {
"extensions": {
"properties": {
"extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4": {
"properties": {
"extension_type": {
"const": "new-sdo",
"type": "string"
}
},
"required": [
"extension_type"
],
"type": "object"
}
},
"required": [
"extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4"
],
"type": "object"
}
},
"required": [
"extensions"
],
"type": "object"
},
{
"$comment": "Link to the Attack Flow SDO subschemas.",
"oneOf": [
{
"$ref": "#/$defs/attack-action"
},
{
"$ref": "#/$defs/attack-asset"
},
{
"$ref": "#/$defs/attack-condition"
},
{
"$ref": "#/$defs/attack-flow"
},
{
"$ref": "#/$defs/attack-operator"
}
]
}
],
"description": "This schema is the normative definition of the STIX 2.1 extension `extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4`. It extends STIX with additional STIX Data Objects (SDOs) that model Attack Flow concepts.",
"title": "Attack Flow STIX 2.1 Extension",
"type": "object",
"unevaluatedProperties": false
} | Apache-2.0 | en |
center-for-threat-informed-defense/attack-flow | 713442dfac4cc11d212dcd5c5b6dd7363cf07db7 | 2022-08-26T01:39:37 | stix/attack-flow-schema-2.0.0.json | 512 | 2024-05-28T03:30:05.859353Z | {
"$defs": {
"attack-action": {
"description": "An ``attack-action`` object represents the execution of a particular technique, i.e. a discrete unit of adverary behavior.",
"properties": {
"description": {
"description": "A description of the adversary behavior.",
"type": "string"
},
"effect_refs": {
"description": "The potential effects that result from executing this action. (See: :ref:`effects`.)",
"items": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"x-referenceType": [
"attack-action",
"attack-operator",
"attack-condition"
]
},
"minItems": 1,
"type": "array"
},
"technique_id": {
"description": "A technique identifier or shortname that may reference an authoritative collection of techniques, e.g. ATT&CK.",
"type": "string"
},
"technique_name": {
"description": "The name of the technique.",
"type": "string"
},
"technique_ref": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"description": "A reference to the technique's STIX representation.",
"x-referenceType": "attack-pattern"
}
},
"required": [
"technique_name"
],
"type": "object",
"x-exampleObject": "attack-action--37345417-3ee0-4e11-b421-1d4be68e6f15"
},
"attack-condition": {
"description": "An ``attack-condition`` object represents some possible condition, outcome, or state that could occur. Conditions can be used to split flows based on the success or failure of an action, or to provide further description of an action's results.",
"properties": {
"description": {
"description": "The condition that is evaluated, usually based on the success or failure of the preceding action.",
"type": "string"
},
"on_false_refs": {
"description": "When the condition is ``false``, the flow continues to these objects. (If there are no objects, then the flow halts at this node.)",
"items": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"x-referenceType": [
"attack-action",
"attack-operator",
"attack-condition"
]
},
"minItems": 1,
"type": "array"
},
"on_true_refs": {
"description": "When the condition is ``true``, the flow continues to these objects.",
"items": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"x-referenceType": [
"attack-action",
"attack-operator",
"attack-condition"
]
},
"minItems": 1,
"type": "array"
}
},
"required": [
"description"
],
"type": "object",
"x-exampleObject": "attack-condition--7e809f5b-319a-4b3f-82fe-e4dc09af5088"
},
"attack-flow": {
"description": "An ``attack-flow`` object represents the Attack Flow overall. It provides metadata for name and description; it provides starting points for the flow of actions; and it is an object that can be referenced from other STIX objects.",
"properties": {
"description": {
"description": "A description of the overall Attack Flow.",
"type": "string"
},
"name": {
"description": "The name of the Attack Flow.",
"type": "string"
},
"scope": {
"description": "Indicates what type of behavior the Attack Flow describes: a specific incident, a campaign, etc.",
"enum": [
"incident",
"campaign",
"threat-actor",
"malware",
"other"
],
"type": "string"
},
"start_refs": {
"description": "A list of objects that start the flow.",
"items": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"x-referenceType": [
"attack-action",
"attack-condition"
]
},
"minItems": 1,
"type": "array"
}
},
"required": [
"name",
"start_refs",
"scope"
],
"type": "object",
"x-exampleObject": "attack-flow--e9ec3a4b-f787-4e81-a3d9-4cfe017ebc2f"
},
"attack-operator": {
"description": "An ``attack-operator`` object joins multiple attack paths together using boolean logic.",
"properties": {
"effect_refs": {
"description": "The effects, outcomes, or states that result when this operator evaluates to ``true``. If the operator evaluates to ``false``, then the flow halts. (See: :ref:`effects`.)",
"items": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"x-referenceType": [
"attack-action",
"attack-operator",
"attack-condition"
]
},
"minItems": 1,
"type": "array"
},
"operator": {
"description": "The logical operator to apply to the input effects.",
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"required": [
"operator"
],
"type": "object",
"x-exampleObject": "attack-operator--609d7adf-a3d2-44e8-82de-4b30e3fb97be"
}
},
"$id": "https://center-for-threat-informed-defense.github.io/attack-flow/schema/attack-flow-schema-2.0.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$comment": "All Attack Flow SDOs implement the required common properties.",
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/core.json"
},
{
"$comment": "Attack Flow SDOs must reference the extension definition.",
"properties": {
"extensions": {
"properties": {
"extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4": {
"properties": {
"extension_type": {
"const": "new-sdo",
"type": "string"
}
},
"required": [
"extension_type"
],
"type": "object"
}
},
"required": [
"extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4"
],
"type": "object"
}
},
"required": [
"extensions"
],
"type": "object"
},
{
"$comment": "Link to the Attack Flow SDO subschemas based on object type.",
"else": {
"else": {
"else": {
"else": true,
"if": {
"properties": {
"type": {
"const": "attack-operator",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-operator"
}
},
"if": {
"properties": {
"type": {
"const": "attack-condition",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-condition"
}
},
"if": {
"properties": {
"type": {
"const": "attack-action",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-action"
}
},
"if": {
"properties": {
"type": {
"const": "attack-flow",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-flow"
}
}
],
"description": "This schema is the normative definition of the STIX 2.1 extension `extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4`. It extends STIX with additional STIX Data Objects (SDOs) and SDO properties to implement Attack Flow concepts, i.e. generalized graphs of adversary behaviors.",
"title": "Attack Flow STIX 2.1 Extension",
"type": "object"
} | Apache-2.0 | en |
center-for-threat-informed-defense/attack-flow | 66bb52f20b50130a9118dae6b89b7666d6873b70 | 2022-08-11T20:34:10 | stix/attack-flow-schema-2.0.0.json | 512 | 2024-05-28T03:30:05.859353Z | {
"$defs": {
"attack-action": {
"description": "An ``attack-action`` object represents the execution of a particular technique, i.e. a discrete unit of adverary behavior.",
"properties": {
"description": {
"description": "A description of the adversary behavior.",
"type": "string"
},
"effect_refs": {
"description": "The effects, outcomes, or states that result successful execution of this action. If the execution fails, then the flow halts. (See: :ref:`effects`.)",
"items": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"xRefType": [
"attack-action",
"attack-operator",
"attack-state"
]
},
"minItems": 1,
"type": "array"
},
"technique_id": {
"description": "A technique identifier or shortname that may reference an authoritative collection of techniques, e.g. ATT&CK.",
"type": "string"
},
"technique_name": {
"description": "The name of the technique.",
"type": "string"
},
"technique_ref": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"description": "A reference to the technique's STIX representation."
}
},
"required": [
"technique_name"
],
"type": "object"
},
"attack-flow": {
"description": "An ``attack-flow`` object represents the Attack Flow overall. It provides metadata for name and description; it provides starting points for the flow of actions; and it is an object that can be referenced from other STIX objects.",
"properties": {
"description": {
"description": "A description of the overall Attack Flow.",
"type": "string"
},
"name": {
"description": "The name of the Attack Flow.",
"type": "string"
},
"scope": {
"description": "Indicates what type of behavior the Attack Flow describes: a specific incident, a campaign, etc.",
"enum": [
"incident",
"campaign",
"threat-actor",
"malware",
"other"
],
"type": "string"
},
"start_refs": {
"description": "A list of objects that start the flow.",
"items": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"xRefType": [
"attack-action",
"attack-state"
]
},
"minItems": 1,
"type": "array"
}
},
"required": [
"name",
"start_refs",
"scope"
],
"type": "object"
},
"attack-operator": {
"description": "An ``attack-operator`` object aggregates multiple effects into a single effect using boolean logic.",
"properties": {
"effect_refs": {
"description": "The effects, outcomes, or states that result when this operator evaluates to ``true``. If the operator evaluates to ``false``, then the flow halts. (See: :ref:`effects`.)",
"items": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"xRefType": [
"attack-action",
"attack-operator",
"attack-state"
]
},
"minItems": 1,
"type": "array"
},
"operator": {
"description": "The logical operator to apply to the input effects.",
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"attack-state": {
"description": "An ``attack-state`` object represents some state (i.e. effect, outcome, etc.) that results from successful execution of one or more techniques.",
"properties": {
"description": {
"description": "A description of the state that results from successful execution of a technique.",
"type": "string"
},
"effect_refs": {
"description": "The effects, outcomes, or states that result when this state exists. If the state does not exist, then the flow halts. (See: :ref:`effects`.)",
"items": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"xRefType": [
"attack-action",
"attack-operator",
"attack-state"
]
},
"minItems": 1,
"type": "array"
}
},
"required": [
"description"
],
"type": "object"
}
},
"$id": "https://center-for-threat-informed-defense.github.io/attack-flow/schema/attack-flow-schema-2.0.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$comment": "All Attack Flow SDOs implement the required common properties.",
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/core.json"
},
{
"$comment": "Attack Flow SDOs must reference the extension definition.",
"properties": {
"extensions": {
"properties": {
"extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4": {
"properties": {
"extension_type": {
"const": "new-sdo",
"type": "string"
}
},
"required": [
"extension_type"
],
"type": "object"
}
},
"required": [
"extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4"
],
"type": "object"
}
},
"required": [
"extensions"
],
"type": "object"
},
{
"$comment": "Link to the Attack Flow SDO subschemas based on object type.",
"else": {
"else": {
"else": {
"else": true,
"if": {
"properties": {
"type": {
"const": "attack-operator",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-operator"
}
},
"if": {
"properties": {
"type": {
"const": "attack-state",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-state"
}
},
"if": {
"properties": {
"type": {
"const": "attack-action",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-action"
}
},
"if": {
"properties": {
"type": {
"const": "attack-flow",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-flow"
}
}
],
"description": "This schema is the normative definition of the STIX 2.1 extension `extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4`. It extends STIX with additional STIX Data Objects (SDOs) and SDO properties to implement Attack Flow concepts, i.e. generalized graphs of adversary behaviors.",
"title": "Attack Flow STIX 2.1 Extension",
"type": "object"
} | Apache-2.0 | en |
center-for-threat-informed-defense/attack-flow | e33f481bab8554601081e447c2a17492b326fe7f | 2022-08-08T18:55:36 | stix/attack-flow-schema-2.0.0.json | 512 | 2024-05-28T03:30:05.859353Z | {
"$defs": {
"attack-action": {
"description": "An `attack-action` object represents a discrete unit of adverary behavior.",
"properties": {
"description": {
"type": "string"
},
"effect_refs": {
"description": "a list of `attack-action` objects that are enabled when this technique is executed successfully, or a list of `attack-state` objects that become true when this technique is executed successfully.",
"items": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
"minItems": 1,
"type": "array",
"x-refTypes": [
"attack-action",
"attack-state"
]
},
"technique_id": {
"description": "A technique identifier or shortname that may reference an authoritative collection of techniques, e.g. ATT&CK.",
"type": "string"
},
"technique_name": {
"description": "The name of the technique.",
"type": "string"
},
"technique_ref": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"description": "A reference to the technique's STIX representation."
}
},
"required": [
"technique_name"
],
"type": "object"
},
"attack-flow": {
"description": "An `attack-flow` object represents the Attack Flow overall. It provides metadata such as name and description; it provides starting points for the flow of actions to begin; and it is an object that can be referenced from other STIX objects.",
"properties": {
"description": {
"description": "A description of the overall Attack Flow.",
"type": "string"
},
"name": {
"description": "The name of the Attack Flow.",
"type": "string"
},
"scope": {
"description": "Indicates what type of behavior the Attack Flow describes: a specific incident, a campaign, etc.",
"enum": [
"incident",
"campaign",
"threat-actor",
"malware",
"other"
],
"type": "string"
},
"start_refs": {
"description": "A list of `attack-action` or `attack-state` objects that start the flow.",
"items": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
"minItems": 1,
"type": "array",
"x-refTypes": [
"attack-action",
"attack-state"
]
}
},
"required": [
"name",
"start_refs",
"scope"
],
"type": "object"
},
"attack-operator": {
"description": "An `attack-operator` object aggregates multiple effects into a single effect using boolean logic.",
"properties": {
"effect_refs": {
"description": "A list of `attack-action` objects that are enabled when this operator evaluates to true, or list of `attack-state` objects that become true when this operator evaluates to true.",
"items": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
"minItems": 1,
"type": "array",
"x-refTypes": [
"attack-action",
"attack-state"
]
},
"operator": {
"description": "The logical operator to apply to the input effects.",
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"attack-state": {
"description": "An `attack-state` object represents some state (i.e. outcome, condition, effect, etc.) that results from successful execution of a technique.",
"properties": {
"description": {
"description": "A description of the state that results from successful execution of a technique.",
"type": "string"
},
"effect_refs": {
"description": "A list of `attack-action` objects that are enabled when this state is true, or list of `attack-state` objects that become true when this state is true.",
"items": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
"minItems": 1,
"type": "array",
"x-refTypes": [
"attack-action",
"attack-state"
]
}
},
"required": [
"description"
],
"type": "object"
}
},
"$id": "https://center-for-threat-informed-defense.github.io/attack-flow/schema/attack-flow-schema-2.0.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$comment": "All Attack Flow SDOs implement the required common properties.",
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/core.json"
},
{
"$comment": "Attack Flow SDOs must reference the extension definition.",
"properties": {
"extensions": {
"properties": {
"extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4": {
"properties": {
"extension_type": {
"const": "new-sdo",
"type": "string"
}
},
"required": [
"extension_type"
],
"type": "object"
}
},
"required": [
"extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4"
],
"type": "object"
}
},
"required": [
"extensions"
],
"type": "object"
},
{
"$comment": "Link to the Attack Flow SDO subschemas based on object type.",
"else": {
"else": {
"else": {
"else": true,
"if": {
"properties": {
"type": {
"const": "attack-operator",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-operator"
}
},
"if": {
"properties": {
"type": {
"const": "attack-state",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-state"
}
},
"if": {
"properties": {
"type": {
"const": "attack-action",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-action"
}
},
"if": {
"properties": {
"type": {
"const": "attack-flow",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-flow"
}
}
],
"description": "This schema is the normative definition of the STIX 2.1 extension `extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4`. It extends STIX with additional STIX Data Objects (SDOs) and SDO properties to implement Attack Flow concepts, i.e. generalized graphs of adversary behaviors.",
"title": "Attack Flow STIX 2.1 Extension",
"type": "object"
} | Apache-2.0 | en |