schema.v3.0.manifest.json Maven / Gradle / Ivy

Go to download
{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$id": "https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#manifestjson",
  "description": "An index of gbfs.json URLs for each GBFS data set produced by a publisher. A single instance of this file should be published at a single stable URL, for example: https://example.com/gbfs/manifest.json.",
  "type": "object",
  "properties": {
    "last_updated": {
      "description": "Last time the data in the feed was updated in RFC3339 format.",
      "type": "string",
      "format": "date-time"
    },
    "ttl": {
      "description": "Number of seconds before the data in the feed will be updated again (0 if the data should always be refreshed).",
      "type": "integer",
      "minimum": 0
    },
    "version": {
      "description": "GBFS version number to which the feed conforms, according to the versioning framework (added in v1.1).",
      "type": "string",
      "const": "3.0"
    },
    "data": {
      "type": "object",
      "properties": {
        "datasets": {
          "description": "An array of objects, each containing the keys below.",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "system_id": {
                "description": "The system_id from system_information.json for the corresponding data set(s).",
                "type": "string"
              },
              "versions": {
                "description": "Contains one object, as defined below, for each of the available versions of a feed. The array MUST be sorted by increasing MAJOR and MINOR version number.",
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "version": {
                      "description": "The semantic version of the feed in the form X.Y",
                      "type": "string",
                      "enum": [
                        "1.0",
                        "1.1",
                        "2.0",
                        "2.1",
                        "2.2",
                        "2.3",
                        "3.0"
                      ]
                    },
                    "url": {
                      "description": "URL of the corresponding gbfs.json endpoint",
                      "type": "string",
                      "format": "uri"
                    }
                  },
                  "required": [
                    "version",
                    "url"
                  ]
                }
              }
            },
            "required": [
              "system_id",
              "versions"
            ]
          }
        }
      },
      "required": ["datasets"],
      "additionalProperties": false
    }
  },
  "required": ["last_updated", "ttl", "version", "data"]
}