243 Document endpoints to get MVTs for capital data

NYCPlanning · May 30, 2024 · 5067e07 · 5067e07
1 parent 832b208
commit 5067e07
Showing 1 changed file with 62 additions and 4 deletions.
diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
@@ -111,6 +111,24 @@ paths:
           $ref: "#/components/responses/NotFound"
         '500':
           $ref: "#/components/responses/InternalServerError"
+  /capital-projects/{z}/{x}/{y}.pbf:
+    get:
+      summary: 🚧 Mapbox Vector Tiles for capital projects
+      operationId: findCapitalProjectTiles
+      tags:
+        - MVT
+        - Capital Projects
+      parameters:
+        - $ref: '#/components/parameters/viewportZoomParam'
+        - $ref: '#/components/parameters/viewportXParam'
+        - $ref: '#/components/parameters/viewportYParam'
+      responses:
+        '200':
+          $ref: '#/components/responses/MVT'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '500':
+          $ref: '#/components/responses/InternalServerError'
   /city-council-districts:
     get:
       summary: 🚧 Find city council districts
@@ -131,10 +149,7 @@ paths:
                       $ref: '#/components/schemas/CityCouncilDistrict'
                 required:
                  - cityCouncilDistricts
-        '400':
-          $ref: '#/components/responses/BadRequest'
-        '500':
-          $ref: '#/components/responses/InternalServerError'
+          $ref: "#/components/responses/InternalServerError" 
   /city-council-districts/{cityCouncilDistrictId}/capital-projects:
     get:
       summary: 🚧 Find paginated capital projects within a specific city council district.
@@ -156,6 +171,42 @@ paths:
           $ref: "#/components/responses/NotFound"
         '500':
           $ref: "#/components/responses/InternalServerError"
+  /city-council-districts/{z}/{x}/{y}.pbf:
+    get:
+      summary: 🚧 Mapbox Vector Tiles for city council districts
+      operationId: findCityCouncilDistrictTiles
+      tags:
+        - MVT
+        - City Council Districts
+      parameters:
+        - $ref: '#/components/parameters/viewportZoomParam'
+        - $ref: '#/components/parameters/viewportXParam'
+        - $ref: '#/components/parameters/viewportYParam'
+      responses:
+        '200':
+          $ref: '#/components/responses/MVT'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '500':
+          $ref: '#/components/responses/InternalServerError'
+  /community-districts/{z}/{x}/{y}.pbf:
+    get:
+      summary: 🚧 Mapbox Vector Tiles for community districts
+      operationId: findCommunityDistrictTiles
+      tags:
+        - MVT
+        - Community Districts
+      parameters:
+        - $ref: '#/components/parameters/viewportZoomParam'
+        - $ref: '#/components/parameters/viewportXParam'
+        - $ref: '#/components/parameters/viewportYParam'
+      responses:
+        '200':
+          $ref: '#/components/responses/MVT'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '500':
+          $ref: '#/components/responses/InternalServerError'
   /land-uses:
     get: 
       summary: List land uses
@@ -1045,6 +1096,13 @@ components:
           required:
             - taxLots
   responses:
+    MVT:
+      description: A protobuf file formatted as Mapbox Vector Tile
+      content:
+        application/x-protobuf:
+          schema:
+            type: string
+            format: binary
     BadRequest:
       description: Invalid client request
       content: