Schemas / I/O

rig.calendar.span

v0.31.0 · draft 2 fields 2 required

Fields

FieldTypeMeaning
startDate string required Inclusive start day (YYYY-MM-DD)
endDate string required Inclusive end day (YYYY-MM-DD)

Dated run - show, offer window, or agreement term. Format when present.

Dates are local calendar days in the document's timeZone (see rig.document).

Compose with rig.calendar.weekly for opening hours inside the span, and rig.calendar.exception for dark or special-hour days. Hosts that only speak weekly hours may ignore this component but must preserve it on round trip.

An offer's validity and an agreement's term reuse this schema. A timed happening on one day is rig.calendar.event - do not copy that day's clock onto the span.

JSON Schema

Resolves at https://rig.works/schemas/rig.calendar.span.schema.json — raw file. 

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.calendar.span.schema.json",
  "title": "rig.calendar.span",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "startDate": {
      "type": "string",
      "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
      "description": "ISO 8601 calendar date."
    },
    "endDate": {
      "type": "string",
      "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
      "description": "ISO 8601 calendar date."
    }
  },
  "required": [
    "startDate",
    "endDate"
  ]
}

Seen in

calendar-event.json · commerce-offer.json · legal-agreement.json