Skip to content

Commit c592c20

Browse files
authored
Added openAPI for 3.0 (#145)
Added openAPI for GBFS 3.0
1 parent 4610d04 commit c592c20

File tree

2 files changed

+202
-0
lines changed

2 files changed

+202
-0
lines changed

models/openapi/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,4 @@ If needed, this can be overriden for a specific path.
2525

2626
## Versions
2727
- v2.3
28+
- v3.0

models/openapi/v3.0/openapi.yaml

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
---
2+
openapi: 3.0.3
3+
info:
4+
title: 'GBFS'
5+
version: '3.0'
6+
description: |-
7+
OpenAPI specification for [General Bikeshare Feed Specification (GBFS)](https://github.com/MobilityData/gbfs/blob/master/gbfs.md) feeds, managed by MobilityData.
8+
tags:
9+
- name: gbfs
10+
externalDocs:
11+
url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#gbfsjson
12+
- name: manifest
13+
externalDocs:
14+
url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#manifestjson
15+
- name: gbfs_versions
16+
externalDocs:
17+
url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#gbfs_versionsjson
18+
- name: system_information
19+
externalDocs:
20+
url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#system_informationjson
21+
- name: vehicle_types
22+
externalDocs:
23+
url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#vehicle_typesjson
24+
- name: station_information
25+
externalDocs:
26+
url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#station_informationjson
27+
- name: station_status
28+
externalDocs:
29+
url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#station_statusjson
30+
- name: vehicle_status
31+
externalDocs:
32+
url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#vehicle_statusjson
33+
- name: system_regions
34+
externalDocs:
35+
url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#system_regionsjson
36+
- name: system_pricing_plans
37+
externalDocs:
38+
url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#system_pricing_plansjson
39+
- name: system_alerts
40+
externalDocs:
41+
url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#system_alertsjson
42+
- name: geofencing_zones
43+
externalDocs:
44+
url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#geofencing_zonesjson
45+
paths:
46+
/gbfs:
47+
get:
48+
tags:
49+
- gbfs
50+
operationId: getGbfs
51+
responses:
52+
'200':
53+
description: returns gbfs.json
54+
content:
55+
application/json:
56+
schema:
57+
$ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/gbfs.json
58+
/manifest:
59+
get:
60+
tags:
61+
- manifest
62+
operationId: manifest
63+
responses:
64+
'200':
65+
description: returns manifest.json
66+
content:
67+
application/json:
68+
schema:
69+
$ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/manifest.json
70+
71+
72+
/gbfs_versions:
73+
get:
74+
tags:
75+
- gbfs_versions
76+
operationId: getGbfsVersions
77+
responses:
78+
'200':
79+
description: returns gbfs_versions.json
80+
content:
81+
application/json:
82+
schema:
83+
$ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/gbfs_versions.json
84+
85+
/system_information:
86+
get:
87+
tags:
88+
- system_information
89+
operationId: getSystemInformation
90+
responses:
91+
'200':
92+
description: returns system_information.json
93+
content:
94+
application/json:
95+
schema:
96+
$ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/system_information.json
97+
98+
/vehicle_types:
99+
get:
100+
tags:
101+
- vehicle_types
102+
operationId: getVehicleTypes
103+
responses:
104+
'200':
105+
description: returns vehicle_types.json
106+
content:
107+
application/json:
108+
schema:
109+
$ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/vehicle_types.json
110+
111+
/station_information:
112+
get:
113+
tags:
114+
- station_information
115+
operationId: getStationInformation
116+
responses:
117+
'200':
118+
description: returns station_information.json
119+
content:
120+
application/json:
121+
schema:
122+
$ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/station_information.json
123+
124+
/station_status:
125+
get:
126+
tags:
127+
- station_status
128+
operationId: getStationStatus
129+
responses:
130+
'200':
131+
description: returns station_status.json
132+
content:
133+
application/json:
134+
schema:
135+
$ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/station_status.json
136+
137+
/vehicle_status:
138+
get:
139+
tags:
140+
- vehicle_status
141+
operationId: getVehicleStatus
142+
responses:
143+
'200':
144+
description: returns vehicle_status.json
145+
content:
146+
application/json:
147+
schema:
148+
$ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/vehicle_status.json
149+
150+
151+
/system_regions:
152+
get:
153+
tags:
154+
- system_regions
155+
operationId: getSystemRegions
156+
responses:
157+
'200':
158+
description: returns system_regions.json
159+
content:
160+
application/json:
161+
schema:
162+
$ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/system_regions.json
163+
164+
/system_pricing_plans:
165+
get:
166+
tags:
167+
- system_pricing_plans
168+
operationId: getSystemPricingPlans
169+
responses:
170+
'200':
171+
description: returns system_pricing_plans.json
172+
content:
173+
application/json:
174+
schema:
175+
$ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/system_pricing_plans.json
176+
177+
/system_alerts:
178+
get:
179+
tags:
180+
- system_alerts
181+
operationId: getSystemAlerts
182+
responses:
183+
'200':
184+
description: returns system_alerts.json
185+
content:
186+
application/json:
187+
schema:
188+
$ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/system_alerts.json
189+
190+
/geofencing_zones:
191+
get:
192+
tags:
193+
- geofencing_zones
194+
operationId: getGeofencingZones
195+
responses:
196+
'200':
197+
description: returns geofencing_zones.json
198+
content:
199+
application/json:
200+
schema:
201+
$ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/geofencing_zones.json

0 commit comments

Comments
 (0)