Validation
A description of the types/properties relevant to a
validation.json
.
Orcfax utilizes the following Schema.org types and properties in its Validation records. The description provided by Schema.org follows each; if Orcfax maintains a more nuanced understanding, an additional definition will be provided. If the term appears in its own definition, it will be replaced when possible with a [synonym] in order to aid understanding.
Schema.org Types
Type | Schema.org description | Orcfax description |
---|---|---|
CreativeWork | The most generic kind of creative work, including books, movies, photographs, software programs, etc. | A generic term to encompass a broad spectrum of creative works, including text, images, software programs, their outputs, etc. |
Event | An [entity] such as a school, NGO, corporation, club, etc. | |
MediaObject | An object such as an image, video, audio, or text object embedded in a web page or a downloadable dataset. | |
Observation | Used to specify observations about an entity at a particular time | Information pertaining to a subject resulting from monitoring. |
Organization | An [entity] such as a school, NGO, corporation, club, etc. | |
PostalAddress | The price asked for a given offer by the respective organization or person. | |
PropertyValue | Used to represent a feature of a product or place. | |
StatisticalVariable | represents any type of statistical metric that can be measured at a place and time. | |
TextObject | A text file. The text can be unformatted or contain markup, html, etc. |
Schema.org Properties
Property | Type | Schema.org description | Orcfax definition |
---|---|---|---|
about | Event | The subject matter of the content. | |
additionalType | MediaObject | Used to add more specific types from external vocabularies when a schema.org equivalent is not available. | |
address | Organization | Physical address of the item. | The physical address of the entity which has executed the validation process. |
addressLocality | PostalAddress | The locality in which the street address is, and which is in the region. | |
addressRegion | PostalAddress | The region in which the locality is, and which is in the country. | |
comment | TextObject | Comments, typically from users. | Used to give users additional context regarding the record. |
contributor | MediaObject | A secondary contributor to the CreativeWork or Event . | The entity which has executed the validation process. |
description | CreativeWork, Event | A description of the item. | |
geo | PostalAddress | The geo coordinates of the place. | The geographical coordinates of the place where the validation process was executed. |
hasPart | CreativeWork | Indicates an item or CreativeWork that is part of this item, or CreativeWork. | |
identifier | MediaObject | Used to represent any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. | |
isBasedOn | MediaObject | A resource from which this work is derived or from which it is a modification or adaptation. | |
locationCreated | Organization | The location where the CreativeWork was created. | |
measurementMethod | Observation, StatisticalVariable | A subproperty of measurementTechnique that can be used for specifying specific methods. | |
measurementTechnique | StatisticalVariable | A technique, method or technology used in an Observation , StatisticalVariable or Dataset , corresponding to the method used for measuring the corresponding variable(s). | |
name | MediaObject, Organization, PropertyValue | The name of the item. | |
recordedIn | Event | The CreativeWork that captured all or part of this Event . | |
sha256 | TextObject | The SHA-2 SHA256 hash of the content of the item | |
startDate | Event | The start date and time of the item. | |
text | CreativeWork | The textual content of this CreativeWork . | |
value | Observation, PropertyValue | The value of a QuantitativeValue (including Observation ) or property value. | |
valueReference | Observation | A secondary value that provides additional information on the original value . | |
variableMeasured | StatisticalVariable | The variable(s) measured in some dataset, either described as text or more explicitly as a StatisticalVariable . |
Validation example
{
"@context": "https://schema.org",
"type": "MediaObject",
"identifier": "urn:orcfax:11ceadf4-69d6-4b96-9401-c0a1e7e5d3eb",
"isBasedOn": {
"@type": "MediaObject",
"name": "the raw information sent to an Orcfax validator by an Orcfax node",
"identifier": "urn:orcfax:node:2a531a7e-4961-4895-985d-1fa9aaaf50a2"
},
"contributor": {
"@type": "Organization",
"name": "AS14061 DigitalOcean, LLC",
"locationCreated": {
"address": {
"@type": "PostalAddress",
"addressLocality": "London",
"addressRegion": "England, GB,",
"geo": "51.5085,-0.1257"
}
}
},
"additionalType": [
{
"@type": "Event",
"description": "successful content signature generation for Orcfax node data",
"startDate": "2024-08-28T16:20:35Z",
"recordedIn": {
"@type": "CreativeWork",
"description": {
"@type": "TextObject",
"comment": "an Orcfax content signature is a sha256 digest of a node's 'collected timestamp', 'data-points' in-order and the 'node identifier' (uuid)",
"sha256": "33ac6c61317e8909871a759e025c82f8155a1739d7e4128f9231e527e1584572"
},
"hasPart": [
{
"@type": "CreativeWork",
"description": "collecting timestamp",
"text": "2024-08-28T16:20:26Z"
},
{
"@type": "CreativeWork",
"description": "data points for ADA-USD",
"text": [
"0.34541",
"0.3423",
"0.342465",
"0.3420342",
"0.34335"
]
},
{
"@type": "CreativeWork",
"description": "node identifier (uuid)",
"text": "2a531a7e-4961-4895-985d-1fa9aaaf50a2"
}
]
}
},
{
"@type": "Event",
"description": "selection of median value from collected node data",
"startDate": "2024-08-28T16:20:35Z",
"about": {
"@type": "StatisticalVariable",
"measurementMethod": "median calculation of a minimum of three data sources from the selected collector node",
"measurementTechnique": [
{
"@type": "PropertyValue",
"name": "SoftwareApplication",
"value": "Python 3.11.6 (main, Apr 10 2024, 17:26:07) [GCC 13.2.0] on Linux-6.5.0-44-generic-x86_64-with-glibc2.38"
},
{
"@type": "PropertyValue",
"name": "SoftwarePackage",
"value": "statistics"
}
],
"variableMeasured": {
"@type": "Observation",
"measurementMethod": "median value",
"value": 0.342465,
"valueReference": [
"0.34541",
"0.3423",
"0.342465",
"0.3420342",
"0.34335"
]
}
}
}
]
}