Added openAPI for 3.0

MobilityData · Oct 25, 2024 · a518b04 · a518b04
1 parent 4610d04
commit a518b04
Showing 1 changed file with 201 additions and 0 deletions.
diff --git a/models/openapi/v3.0/openapi.yaml b/models/openapi/v3.0/openapi.yaml
@@ -0,0 +1,201 @@
+---
+openapi: 3.1.0
+info:
+    title: 'GBFS'
+    version: '3.0'
+    description: |-
+      OpenAPI specification for [General Bikeshare Feed Specification  (GBFS)](https://github.com/MobilityData/gbfs/blob/master/gbfs.md) feeds, managed by MobilityData.
+tags:
+    -   name: gbfs
+        externalDocs:
+            url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#gbfsjson
+    -   name: manifest
+        externalDocs:
+            url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#manifestjson
+    -   name: gbfs_versions
+        externalDocs:
+            url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#gbfs_versionsjson
+    -   name: system_information
+        externalDocs:
+            url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#system_informationjson
+    -   name: vehicle_types
+        externalDocs:
+            url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#vehicle_typesjson
+    -   name: station_information
+        externalDocs:
+            url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#station_informationjson
+    -   name: station_status
+        externalDocs:
+            url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#station_statusjson
+    -   name: vehicle_status
+        externalDocs:
+            url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#vehicle_statusjson
+    -   name: system_regions
+        externalDocs:
+            url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#system_regionsjson
+    -   name: system_pricing_plans
+        externalDocs:
+            url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#system_pricing_plansjson
+    -   name: system_alerts
+        externalDocs:
+            url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#system_alertsjson
+    -   name: geofencing_zones
+        externalDocs:
+            url: https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#geofencing_zonesjson
+paths:
+    /gbfs:
+        get:
+            tags:
+                - gbfs
+            operationId: getGbfs
+            responses:
+                '200':
+                    description: returns gbfs.json
+                    content:
+                        application/json:
+                            schema:
+                                $ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/gbfs.json
+    /manifest:
+        get:
+            tags:
+                - manifest
+            operationId: manifest
+            responses:
+                '200':
+                    description: returns manifest.json
+                    content:
+                        application/json:
+                            schema:
+                                $ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/manifest.json
+
+
+    /gbfs_versions:
+        get:
+            tags:
+                - gbfs_versions
+            operationId: getGbfsVersions
+            responses:
+                '200':
+                    description: returns gbfs_versions.json
+                    content:
+                        application/json:
+                            schema:
+                                $ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/gbfs_versions.json
+
+    /system_information:
+        get:
+            tags:
+                - system_information
+            operationId: getSystemInformation
+            responses:
+                '200':
+                    description: returns system_information.json
+                    content:
+                        application/json:
+                            schema:
+                                $ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/system_information.json
+
+    /vehicle_types:
+        get:
+            tags:
+                - vehicle_types
+            operationId: getVehicleTypes
+            responses:
+                '200':
+                    description: returns vehicle_types.json
+                    content:
+                        application/json:
+                            schema:
+                                $ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/vehicle_types.json
+
+    /station_information:
+        get:
+            tags:
+                - station_information
+            operationId: getStationInformation
+            responses:
+                '200':
+                    description: returns station_information.json
+                    content:
+                        application/json:
+                            schema:
+                                $ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/station_information.json
+
+    /station_status:
+        get:
+            tags:
+                - station_status
+            operationId: getStationStatus
+            responses:
+                '200':
+                    description: returns station_status.json
+                    content:
+                        application/json:
+                            schema:
+                                $ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/station_status.json
+
+    /vehicle_status:
+        get:
+            tags:
+                - vehicle_status
+            operationId: getVehicleStatus
+            responses:
+                '200':
+                    description: returns vehicle_status.json
+                    content:
+                        application/json:
+                            schema:
+                                $ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/vehicle_status.json
+
+
+    /system_regions:
+        get:
+            tags:
+                - system_regions
+            operationId: getSystemRegions
+            responses:
+                '200':
+                    description: returns system_regions.json
+                    content:
+                        application/json:
+                            schema:
+                                $ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/system_regions.json
+
+    /system_pricing_plans:
+        get:
+            tags:
+                - system_pricing_plans
+            operationId: getSystemPricingPlans
+            responses:
+                '200':
+                    description: returns system_pricing_plans.json
+                    content:
+                        application/json:
+                            schema:
+                                $ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/system_pricing_plans.json
+
+    /system_alerts:
+        get:
+            tags:
+                - system_alerts
+            operationId: getSystemAlerts
+            responses:
+                '200':
+                    description: returns system_alerts.json
+                    content:
+                        application/json:
+                            schema:
+                                $ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/system_alerts.json
+
+    /geofencing_zones:
+        get:
+            tags:
+                - geofencing_zones
+            operationId: getGeofencingZones
+            responses:
+                '200':
+                    description: returns geofencing_zones.json
+                    content:
+                        application/json:
+                            schema:
+                                $ref: https://raw.githubusercontent.com/MobilityData/gbfs-json-schema/refs/heads/master/v3.0/geofencing_zones.json