Skip to content

Commit 63f3351

Browse files
drewdadrewda
authored
Merge pull request #6 from transitland/gbfs-auto-discovery-url
GBFS will now only take a `gbfs_auto_discovery` URL
2 parents 18ab67f + d08ab48 commit 63f3351

File tree

3 files changed

+203
-1
lines changed

3 files changed

+203
-1
lines changed

‎CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Changelog
22

3+
## v0.3.0
4+
5+
When `spec=gbfs`, only one type of URL is now needed or allowed: `gbfs_auto_discovery`.
6+
7+
We made this decision because all of the GBFS feeds listed in [`systems.csv`](https://github.com/NABSA/gbfs/blob/v2.0/systems.csv) supply an auto-discovery URL. Also [GBFS v2.0](https://github.com/NABSA/gbfs/releases/tag/v2.0) requires the auto-discovery JSON file.
8+
39
## v0.2.0
410

511
**Breaking change**: We've removed support to specify a static GTFS feed URL using `feed.url`. Now the one option is to specify this using `feed.urls.static_current`. This change will slightly simplifying tooling that validates or consumes DMFR.

‎json-schema/dmfr.schema-v0.3.0.json‎

Lines changed: 196 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,196 @@
1+
{
2+
"$id": "https://dmfr.transit.land/json-schema/dmfr.schema-v0.3.0.json",
3+
"$schema": "http://json-schema.org/draft-07/schema#",
4+
"title": "Distributed Mobility Feed Registry",
5+
"type": "object",
6+
"properties": {
7+
"feeds": {
8+
"type": "array",
9+
"items": {
10+
"$ref": "#/definitions/feed"
11+
}
12+
},
13+
"license_spdx_identifier": {
14+
"type": "string"
15+
}
16+
},
17+
"definitions": {
18+
"feed": {
19+
"type": "object",
20+
"required": ["id", "spec", "urls"],
21+
"properties": {
22+
"id": {
23+
"type": "string",
24+
"description": "Identifier for this feed, internal to this DMFR instance. (Optionally can be a Onestop ID.)"
25+
},
26+
"spec": {
27+
"type": "string",
28+
"enum": ["gtfs", "gtfs-rt", "gbfs", "mds"],
29+
"description": "Type of data contained in this feed: GTFS, GTFS-RT, GBFS, or MDS."
30+
},
31+
"urls": {
32+
"type": "object",
33+
"properties": {
34+
"static_current": {
35+
"type": "string",
36+
"description": "URL (in Transitland Extended URL format) for the static feed that represents today's service. (Has the same meaning as url.)",
37+
"pattern": "^(http|https|ftp):\/\/[a-zA-Z0-9.~#{}/=?_/-]+$"
38+
},
39+
"static_historic": {
40+
"type": "array",
41+
"items": {
42+
"type": "string",
43+
"description": "URLs (in Transitland Extended URL format) for static feeds that represent past service that is no longer in effect.",
44+
"pattern": "^(http|https|ftp):\/\/[a-zA-Z0-9.~#{}/=?_/-]+$"
45+
}
46+
},
47+
"static_planned": {
48+
"type": "array",
49+
"items": {
50+
"type": "string",
51+
"description": "URLs (in Transitland Extended URL format) for static feeds that represent service planned for upcoming dates. Typically used to represent calendar/service changes that will take effect few weeks or months in the future.",
52+
"pattern": "^(http|https|ftp):\/\/[a-zA-Z0-9.~#{}/=?_/-]+$"
53+
}
54+
},
55+
"static_hypothetical": {
56+
"type": "array",
57+
"items": {
58+
"type": "string",
59+
"description": "URLs (in Transitland Extended URL format) for static feeds that represent potential service or network changes. Typically used to represent scenarios that may (or may not) take effect months or years in the future.",
60+
"pattern": "^(http|https|ftp):\/\/[a-zA-Z0-9.~#{}/=?_/-]+$"
61+
}
62+
},
63+
"realtime_vehicle_positions": {
64+
"type": "string",
65+
"description": "URL for GTFS Realtime VehiclePosition messages.",
66+
"pattern": "^(http|https|ftp):\/\/[a-zA-Z0-9.~#{}/=?_/-]+$"
67+
},
68+
"realtime_trip_updates": {
69+
"type": "string",
70+
"description": "URL for GTFS Realtime TripUpdate messages.",
71+
"pattern": "^(http|https|ftp):\/\/[a-zA-Z0-9.~#{}/=?_/-]+$"
72+
},
73+
"realtime_alerts": {
74+
"type": "string",
75+
"description": "URL for GTFS Realtime Alert messages.",
76+
"pattern": "^(http|https|ftp):\/\/[a-zA-Z0-9.~#{}/=?_/-]+$"
77+
},
78+
"gbfs_auto_discovery": {
79+
"type": "string",
80+
"description": "Auto-discovery file in JSON format that links to all of the other GBFS files published by the system.",
81+
"pattern": "^(http|https|ftp):\/\/[a-zA-Z0-9.~#{}/=?_/-]+$"
82+
},
83+
"mds_provider": {
84+
"type": "string",
85+
"description": "MDS provider API endpoints are intended to be implemented by mobility providers and consumed by regulatory agencies.",
86+
"pattern": "^(http|https|ftp):\/\/[a-zA-Z0-9.~#{}/=?_/-]+$"
87+
}
88+
}
89+
},
90+
"associated_feeds": {
91+
"type": "array",
92+
"description": "List of associated feeds, using IDs internal to this DMFR instance. For example to one or more GTFS feeds associated with an GTFS-RT feed.",
93+
"items": {
94+
"type": "string",
95+
"description": "Identifier for an associated feed, using ID internal to this DMFR."
96+
}
97+
},
98+
"feed_namespace_id": {
99+
"type": "string",
100+
"description": "Feeds that share the same feed_namespace_id value can be combined without needing to rewrite entity IDs. (Optionally can be an operator Onestop ID.)"
101+
},
102+
"other_ids": {
103+
"type": "object",
104+
"description": "Identifiers for this feed used by other DMFR instances. Key is the DMFR instance or feed registry platform; value is the feed ID."
105+
},
106+
"languages": {
107+
"type": "array",
108+
"description": "Language(s) included in this feed.",
109+
"items": {
110+
"$ref": "#/definitions/language"
111+
}
112+
},
113+
"license": {
114+
"$ref": "#/definitions/license_description"
115+
},
116+
"authorization": {
117+
"$ref": "#/definitions/authorization"
118+
}
119+
}
120+
},
121+
"language": {
122+
"type": "string",
123+
"description": "A language specified using an IETF language tag."
124+
},
125+
"license_description": {
126+
"type": "object",
127+
"oneOf": [{
128+
"required": ["spdx_identifier"]
129+
}, {
130+
"required": ["url"]
131+
}],
132+
"properties": {
133+
"spdx_identifier": {
134+
"type": "string",
135+
"description": "SPDX identifier for a common license. See https://spdx.org/licenses/"
136+
},
137+
"url": {
138+
"type": "string",
139+
"description": "URL for a custom license."
140+
},
141+
"use_without_attribution": {
142+
"type": "string",
143+
"enum": ["yes", "no", "unknown"],
144+
"description": "Are feed consumers allowed to use the feed contents without including attribution text in their app or map?"
145+
},
146+
"create_derived_product": {
147+
"type": "string",
148+
"enum": ["yes", "no", "unknown"],
149+
"description": "Are feed consumers allowed to create and share derived products from the feed?"
150+
},
151+
"redistribution_allowed": {
152+
"type": "string",
153+
"enum": ["yes", "no", "unknown"],
154+
"description": "Are feed consumers allowed to redistribute the feed in its entirety?"
155+
},
156+
"commercial_use_allowed": {
157+
"type": "string",
158+
"enum": ["yes", "no", "unknown"],
159+
"description": "Are feed consumers allowed to use the feed for commercial purposes?"
160+
},
161+
"share_alike_optional": {
162+
"type": "string",
163+
"enum": ["yes", "no", "unknown"],
164+
"description": "Are feed consumers allowed to keep their modifications of this feed private?"
165+
},
166+
"attribution_text": {
167+
"type": "string",
168+
"description": "Feed consumers must include this particular text when using this feed."
169+
},
170+
"attribution_instructions": {
171+
"type": "string",
172+
"description": "Feed consumers must follow these instructions for how to provide attribution."
173+
}
174+
}
175+
},
176+
"authorization": {
177+
"type": "object",
178+
"required": ["type"],
179+
"properties": {
180+
"type": {
181+
"type": "string",
182+
"enum": ["header", "basic_auth", "query_param", "path_segment"],
183+
"description": "Authorization approach: HTTP header, basic authentication, query parameter, or path segment in a Transitland Extended URL."
184+
},
185+
"param_name": {
186+
"type": "string",
187+
"description": "When type=query_param, this specifies the name of the query parameter."
188+
},
189+
"info_url": {
190+
"type": "string",
191+
"description": "Website to visit to sign up for an account."
192+
}
193+
}
194+
}
195+
}
196+
}

‎json-schema/dmfr.schema.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
dmfr.schema-v0.2.0.json
1+
dmfr.schema-v0.3.0.json

0 commit comments

Comments
 (0)