Modify schemas for v1.1 (#32)

Adds versions + changes to system_information
MobilityData · Oct 22, 2020 · cbc7c85 · cbc7c85
1 parent 754e502
commit cbc7c85
Show file tree

Hide file tree

Showing 11 changed files with 319 additions and 26 deletions.
diff --git a/free_bike_status.json b/free_bike_status.json
@@ -14,6 +14,14 @@
       "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",
+      "enum": [
+        "1.1-RC",
+        "1.1"
+      ]
+    },
     "data": {
       "description": "Array that contains one object per bike as defined below.",
       "type": "object",
@@ -49,24 +57,46 @@
               "minimum": 0,
               "maximum": 1
             },
-            "required": [
-              "bike_id",
-              "lat",
-              "lon",
-              "is_reserved",
-              "is_disabled"
-            ]
+            "rental_uris": {
+              "description": "Contains rental uris for Android, iOS, and web in the android, ios, and web fields (added in v1.1).",
+              "type": "object",
+              "properties": {
+                "android": {
+                  "description": "URI that can be passed to an Android app with an intent (added in v1.1).",
+                  "type": "string",
+                  "format": "uri"
+                },
+                "ios": {
+                  "description": "URI that can be used on iOS to launch the rental app for this vehicle (added in v1.1).",
+                  "type": "string",
+                  "format": "uri"
+                },
+                "web": {
+                  "description": "URL that can be used by a web browser to show more information about renting this vehicle (added in v1.1).",
+                  "type": "string",
+                  "format": "uri"
+                }
+              }
+            }
           },
           "required": [
-            "bikes"
+            "bike_id",
+            "lat",
+            "lon",
+            "is_reserved",
+            "is_disabled"
           ]
         }
       },
       "required": [
-        "last_updated",
-        "ttl",
-        "data"
+        "bikes"
       ]
     }
-  }
+  },
+  "required": [
+    "last_updated",
+    "ttl",
+    "version",
+    "data"
+  ]
 }
diff --git a/gbfs.json b/gbfs.json
@@ -14,6 +14,16 @@
       "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",
+      "enum": [
+        "1.1-RC",
+        "1.1",
+        "2.0-RC",
+        "2.0"
+      ]
+    },
     "data": {
       "description": "Response data in the form of name:value pairs.",
       "type": "object",
@@ -32,6 +42,7 @@
                     "type": "string",
                     "enum": [
                       "gbfs",
+                      "gbfs_versions",
                       "system_information",
                       "station_information",
                       "station_status",
@@ -66,6 +77,7 @@
   "required": [
     "last_updated",
     "ttl",
+    "version",
     "data"
   ]
 }
diff --git a/gbfs_versions.json b/gbfs_versions.json
@@ -0,0 +1,78 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://github.com/NABSA/gbfs/blob/master/gbfs.md#gbfs_versionsjson-added-in-v11",
+  "description": "Lists all feed endpoints published according to version sof the GBFS documentation. (added in v1.1)",
+  "type": "object",
+  "properties": {
+    "last_updated": {
+      "description": "Last time the data in the feed was updated in POSIX time.",
+      "type": "integer",
+      "minimum": 1450155600
+    },
+    "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.",
+      "type": "string",
+      "enum": [
+        "1.1-RC",
+        "1.1",
+        "2.0-RC",
+        "2.0",
+        "2.1-RC",
+        "2.1",
+        "3.0-RC",
+        "3.0"
+      ]
+    },
+    "data": {
+      "description": "Response data in the form of name:value pairs.",
+      "type": "object",
+      "properties": {
+        "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.1-RC",
+                  "1.1",
+                  "2.0-RC",
+                  "2.0",
+                  "2.1-RC",
+                  "2.1-RC2",
+                  "3.0-RC",
+                  "3.0"
+                ]
+              },
+              "url": {
+                "description": "URL of the corresponding gbfs.json endpoint",
+                "type": "string",
+                "format": "uri"
+              }
+            },
+            "required": [
+              "version",
+              "url"
+            ]
+          }
+        },
+        "required": true
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "last_updated",
+    "ttl",
+    "version",
+    "data"
+  ]
+}
diff --git a/station_information.json b/station_information.json
@@ -14,6 +14,16 @@
       "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",
+      "enum": [
+        "1.1-RC",
+        "1.1",
+        "2.0-RC",
+        "2.0"
+      ]
+    },
     "data": {
       "description": "Array that contains one object per station as defined below.",
       "type": "object",
@@ -80,27 +90,49 @@
               "minItems": 1
             },
             "capacity": {
-              "description": "Number of total docking points installed at this tation, both available and unavailable.",
+              "description": "Number of total docking points installed at this station, both available and unavailable.",
               "type": "number",
               "minimum": 0
             },
-            "required": [
-              "station_id",
-              "name",
-              "lat",
-              "lon"
-            ]
+            "rental_uris": {
+              "description": "Contains rental uris for Android, iOS, and web in the android, ios, and web fields (added in v1.1).",
+              "type": "object",
+              "properties": {
+                "android": {
+                  "description": "URI that can be passed to an Android app with an intent (added in v1.1).",
+                  "type": "string",
+                  "format": "uri"
+                },
+                "ios": {
+                  "description": "URI that can be used on iOS to launch the rental app for this station (added in v1.1).",
+                  "type": "string",
+                  "format": "uri"
+                },
+                "web": {
+                  "description": "URL that can be used by a web browser to show more information about renting a vehicle at this station (added in v1.1).",
+                  "type": "string",
+                  "format": "uri"
+                }
+              }
+            }
           },
           "required": [
-            "stations"
+            "station_id",
+            "name",
+            "lat",
+            "lon"
           ]
         }
       },
       "required": [
-        "last_updated",
-        "ttl",
-        "data"
+        "stations"
       ]
     }
-  }
+  },
+  "required": [
+    "last_updated",
+    "ttl",
+    "version",
+    "data"
+  ]
 }
diff --git a/station_status.json b/station_status.json
@@ -14,6 +14,14 @@
       "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",
+      "enum": [
+        "1.1-RC",
+        "1.1"
+      ]
+    },
     "data": {
       "description": "Array that contains one object per station as defined below.",
       "type": "object",
@@ -22,7 +30,7 @@
           "type": "array",
           "items": {
             "station_id": {
-              "description": "identifier of a station.",
+              "description": "Identifier of a station.",
               "type": "string"
             },
             "num_bikes_available": {
@@ -88,6 +96,7 @@
   "required": [
     "last_updated",
     "ttl",
+    "version",
     "data"
   ]
 }
diff --git a/system_alerts.json b/system_alerts.json
@@ -14,6 +14,19 @@
       "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",
+      "enum": [
+        "1.1-RC",
+        "1.1",
+        "2.0-RC",
+        "2.0",
+        "2.1-RC",
+        "2.1-RC2",
+        "3.0-RC"
+      ]
+    },
     "data": {
       "description": "Array that contains ad-hoc alerts for the system.",
       "type": "object",
@@ -109,6 +122,7 @@
   "required": [
     "last_updated",
     "ttl",
+    "version",
     "data"
   ]
 }
diff --git a/system_calendar.json b/system_calendar.json
@@ -14,6 +14,19 @@
       "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",
+      "enum": [
+        "1.1-RC",
+        "1.1",
+        "2.0-RC",
+        "2.0",
+        "2.1-RC",
+        "2.1-RC2",
+        "3.0-RC"
+      ]
+    },
     "data": {
       "description": "Array that contains opertions calendar for the system.",
       "type": "object",
@@ -72,6 +85,7 @@
   "required": [
     "last_updated",
     "ttl",
+    "version",
     "data"
   ]
 }
diff --git a/system_hours.json b/system_hours.json
@@ -14,6 +14,19 @@
       "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",
+      "enum": [
+        "1.1-RC",
+        "1.1",
+        "2.0-RC",
+        "2.0",
+        "2.1-RC",
+        "2.1-RC2",
+        "3.0-RC"
+      ]
+    },
     "data": {
       "description": "Array that contains system hours of operations.",
       "type": "object",
@@ -79,6 +92,7 @@
   "required": [
     "last_updated",
     "ttl",
+    "version",
     "data"
   ]
-}
+}