Settings

• Description
• Examples
• Schema

Settings contains information about data like version, validity, etc. In addition to that, there are settings for default language, default transfer times between trips, links for realtime data, etc.

Description

schemaVersion
required

string

Version of the schema in X.Y.Z format.

dataVersion
required

string

Version of the data in X.Y.Z format.

name

string

Name of the data.

language
required

string

Default language of the data

validity
required

object

Validity of the data.

{
  "validity": {
    "from": "2023-01-01",
    "to": "2023-12-31"
  }
}

from
required

string

to
required

string

sameStopTransferTime
required

integer

Default transfer time on the same stop

childStopTransferTime
required

integer

Default transfer time between child stops

Examples

#1

{
  "schemaVersion": "0.1.0",
  "dataVersion": "0.1.0",
  "language": "en",
  "validity": {
    "from": "2023-01-01",
    "to": "2023-12-31"
  },
  "sameStopTransferTime": 120,
  "childStopTransferTime": 240
}

Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/vchezganov/cityvehiclespec/schema/settings.json",
  "title": "Settings",
  "type": "object",
  "properties": {
    "schemaVersion": {
      "description": "Version of the schema in X.Y.Z format.",
      "type": "string"
    },
    "dataVersion": {
      "description": "Version of the data in X.Y.Z format.",
      "type": "string"
    },
    "name": {
      "description": "Name of the data.",
      "type": "string"
    },
    "language": {
      "description": "Default language of the data",
      "type": "string"
    },
    "validity": {
      "description": "Validity of the data.",
      "type": "object",
      "properties": {
        "from": {
          "type": "string",
          "format": "date"
        },
        "to": {
          "type": "string",
          "format": "date"
        }
      },
      "required": [
        "from",
        "to"
      ]
    },
    "sameStopTransferTime": {
      "description": "Default transfer time on the same stop",
      "type": "integer"
    },
    "childStopTransferTime": {
      "description": "Default transfer time between child stops",
      "type": "integer"
    }
  },
  "required": [
    "schemaVersion",
    "dataVersion",
    "language",
    "validity",
    "sameStopTransferTime",
    "childStopTransferTime"
  ]
}