109 lines
3.8 KiB
JSON
109 lines
3.8 KiB
JSON
{
|
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
"$id": "schema:HowTo",
|
|
"title": "HowTo",
|
|
"description": "Instructions that explain how to achieve a result by performing a sequence of steps.",
|
|
"type": "object",
|
|
"allOf": [
|
|
{
|
|
"description": "The most generic kind of creative work, including books, movies, photographs, software programs, etc.",
|
|
"$ref": "schema:CreativeWork"
|
|
}
|
|
],
|
|
"properties": {
|
|
"estimatedCost": {
|
|
"description": "The estimated cost of the supply or supplies consumed when performing instructions.",
|
|
"anyOf": [{ "type": "string" }, { "$ref": "schema:MonetaryAmount" }]
|
|
},
|
|
"performTime": {
|
|
"description": "The length of time it takes to perform instructions or a direction (not including time to prepare the supplies), in [ISO 8601 duration format](http://en.wikipedia.org/wiki/ISO_8601).",
|
|
"type": "string",
|
|
"$comment": "https://schema.org/Duration"
|
|
},
|
|
"prepTime": {
|
|
"description": "The length of time it takes to prepare the items to be used in instructions or a direction, in [ISO 8601 duration format](http://en.wikipedia.org/wiki/ISO_8601).",
|
|
"type": "string",
|
|
"$comment": "https://schema.org/Duration"
|
|
},
|
|
"step": {
|
|
"description": "A single step item (as HowToStep, text, document, video, etc.) or a HowToSection.",
|
|
"oneOf": [
|
|
{
|
|
"anyOf": [
|
|
{ "type": "string" },
|
|
{ "$ref": "schema:CreativeWork" },
|
|
{ "$ref": "schema:HowToSection" },
|
|
{ "$ref": "schema:HowToStep" }
|
|
]
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{ "type": "string" },
|
|
{ "$ref": "schema:CreativeWork" },
|
|
{ "$ref": "schema:HowToSection" },
|
|
{ "$ref": "schema:HowToStep" }
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"steps": {
|
|
"description": "A single step item (as HowToStep, text, document, video, etc.) or a HowToSection (originally misnamed 'steps'; 'step' is preferred).",
|
|
"oneOf": [
|
|
{
|
|
"anyOf": [
|
|
{ "type": "string" },
|
|
{ "$ref": "schema:CreativeWork" },
|
|
{ "$ref": "schema:ItemList" }
|
|
]
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{ "type": "string" },
|
|
{ "$ref": "schema:CreativeWork" },
|
|
{ "$ref": "schema:ItemList" }
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"supply": {
|
|
"description": "A sub-property of instrument. A supply consumed when performing instructions or a direction.",
|
|
"oneOf": [
|
|
{ "anyOf": [{ "type": "string" }, { "$ref": "schema:HowToSupply" }] },
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [{ "type": "string" }, { "$ref": "schema:HowToSupply" }]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"tool": {
|
|
"description": "A sub property of instrument. An object used (but not consumed) when performing instructions or a direction.",
|
|
"oneOf": [
|
|
{ "anyOf": [{ "type": "string" }, { "$ref": "schema:HowToTool" }] },
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [{ "type": "string" }, { "$ref": "schema:HowToTool" }]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"totalTime": {
|
|
"description": "The total time required to perform instructions or a direction (including time to prepare the supplies), in [ISO 8601 duration format](http://en.wikipedia.org/wiki/ISO_8601).",
|
|
"type": "string",
|
|
"$comment": "https://schema.org/Duration"
|
|
},
|
|
"yield": {
|
|
"description": "The quantity that results by performing instructions. For example, a paper airplane, 10 personalized candles.",
|
|
"anyOf": [{ "type": "string" }, { "$ref": "schema:QuantitativeValue" }]
|
|
}
|
|
}
|
|
}
|