138 lines
6.8 KiB
JSON
138 lines
6.8 KiB
JSON
{
|
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
"$id": "schema:Schedule",
|
|
"title": "Schedule",
|
|
"description": "A schedule defines a repeating time period used to describe a regularly occurring [[Event]]. At a minimum a schedule will specify [[repeatFrequency]] which describes the interval between occurrences of the event. Additional information can be provided to specify the schedule more precisely.\n This includes identifying the day(s) of the week or month when the recurring event will take place, in addition to its start and end time. Schedules may also\n have start and end dates to indicate when they are active, e.g. to define a limited calendar of events.",
|
|
"type": "object",
|
|
"allOf": [
|
|
{
|
|
"description": "A utility class that serves as the umbrella for a number of 'intangible' things such as quantities, structured values, etc.",
|
|
"$ref": "schema:Intangible"
|
|
}
|
|
],
|
|
"properties": {
|
|
"byDay": {
|
|
"description": "Defines the day(s) of the week on which a recurring [[Event]] takes place. May be specified using either [[DayOfWeek]], or alternatively [[Text]] conforming to iCal's syntax for byDay recurrence rules.",
|
|
"oneOf": [
|
|
{ "anyOf": [{ "type": "string" }, { "$ref": "schema:DayOfWeek" }] },
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [{ "type": "string" }, { "$ref": "schema:DayOfWeek" }]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"byMonth": {
|
|
"description": "Defines the month(s) of the year on which a recurring [[Event]] takes place. Specified as an [[Integer]] between 1-12. January is 1.",
|
|
"oneOf": [
|
|
{ "type": "integer" },
|
|
{ "type": "array", "items": { "type": "integer" } }
|
|
]
|
|
},
|
|
"byMonthDay": {
|
|
"description": "Defines the day(s) of the month on which a recurring [[Event]] takes place. Specified as an [[Integer]] between 1-31.",
|
|
"oneOf": [
|
|
{ "type": "integer" },
|
|
{ "type": "array", "items": { "type": "integer" } }
|
|
]
|
|
},
|
|
"byMonthWeek": {
|
|
"description": "Defines the week(s) of the month on which a recurring Event takes place. Specified as an Integer between 1-5. For clarity, byMonthWeek is best used in conjunction with byDay to indicate concepts like the first and third Mondays of a month.",
|
|
"oneOf": [
|
|
{ "type": "integer" },
|
|
{ "type": "array", "items": { "type": "integer" } }
|
|
]
|
|
},
|
|
"duration": {
|
|
"description": "The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 duration format](http://en.wikipedia.org/wiki/ISO_8601).",
|
|
"anyOf": [
|
|
{ "type": "string", "$comment": "https://schema.org/Duration" },
|
|
{ "$ref": "schema:QuantitativeValue" }
|
|
]
|
|
},
|
|
"endDate": {
|
|
"description": "The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).",
|
|
"anyOf": [
|
|
{ "type": "string", "format": "date" },
|
|
{ "type": "string", "format": "date-time" }
|
|
]
|
|
},
|
|
"endTime": {
|
|
"description": "The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to *December*. For media, including audio and video, it's the time offset of the end of a clip within a larger file.\\n\\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.",
|
|
"anyOf": [
|
|
{ "type": "string", "format": "date-time" },
|
|
{ "type": "string", "format": "time" }
|
|
]
|
|
},
|
|
"exceptDate": {
|
|
"description": "Defines a [[Date]] or [[DateTime]] during which a scheduled [[Event]] will not take place. The property allows exceptions to\n a [[Schedule]] to be specified. If an exception is specified as a [[DateTime]] then only the event that would have started at that specific date and time\n should be excluded from the schedule. If an exception is specified as a [[Date]] then any event that is scheduled for that 24 hour period should be\n excluded from the schedule. This allows a whole day to be excluded from the schedule without having to itemise every scheduled event.",
|
|
"oneOf": [
|
|
{
|
|
"anyOf": [
|
|
{ "type": "string", "format": "date" },
|
|
{ "type": "string", "format": "date-time" }
|
|
]
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{ "type": "string", "format": "date" },
|
|
{ "type": "string", "format": "date-time" }
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"repeatCount": {
|
|
"description": "Defines the number of times a recurring [[Event]] will take place.",
|
|
"oneOf": [
|
|
{ "type": "integer" },
|
|
{ "type": "array", "items": { "type": "integer" } }
|
|
]
|
|
},
|
|
"repeatFrequency": {
|
|
"description": "Defines the frequency at which [[Event]]s will occur according to a schedule [[Schedule]]. The intervals between\n events should be defined as a [[Duration]] of time.",
|
|
"oneOf": [
|
|
{
|
|
"anyOf": [
|
|
{ "type": "string", "$comment": "https://schema.org/Duration" },
|
|
{ "type": "string" }
|
|
]
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{ "type": "string", "$comment": "https://schema.org/Duration" },
|
|
{ "type": "string" }
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"scheduleTimezone": {
|
|
"description": "Indicates the timezone for which the time(s) indicated in the [[Schedule]] are given. The value provided should be among those listed in the IANA Time Zone Database.",
|
|
"oneOf": [
|
|
{ "type": "string" },
|
|
{ "type": "array", "items": { "type": "string" } }
|
|
]
|
|
},
|
|
"startDate": {
|
|
"description": "The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).",
|
|
"anyOf": [
|
|
{ "type": "string", "format": "date" },
|
|
{ "type": "string", "format": "date-time" }
|
|
]
|
|
},
|
|
"startTime": {
|
|
"description": "The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from *January* to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.\\n\\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.",
|
|
"anyOf": [
|
|
{ "type": "string", "format": "date-time" },
|
|
{ "type": "string", "format": "time" }
|
|
]
|
|
}
|
|
}
|
|
}
|