OpenAPI: MVTs and cc fix

Documenting endpoints for vector tiles Fixing capital commitments return type closes #243
NYCPlanning · Jun 4, 2024 · e4566ee · e4566ee
1 parent 896db8b
commit e4566ee
Showing 1 changed file with 89 additions and 23 deletions.
diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
@@ -113,15 +113,59 @@ paths:
           $ref: "#/components/responses/InternalServerError"
   /capital-projects/{managingCode}/{capitalProjectid}/capital-commitments:
     get:
-      summary: 🚧 Find capital commitments associated with a specific capital project
-      operationId: findCapitalCommitmentsByManagingCodeCapitalProjectId
-      tags: Capital Commitments
+        summary: 🚧 Find capital commitments associated with a specific capital project
+        operationId: findCapitalCommitmentsByManagingCodeCapitalProjectId
+        tags: Capital Commitments
+        parameters:
+          - managingCode
+          - capitalProjectId
+        responses:
+          '200':
+            description: an object of capital commitments for the capital project
+            content:
+              application/json:
+                schema:
+                  type: object
+                  properties:
+                    capitalCommitments:
+                      type: array
+                      items:
+                        $ref: '#/components/schemas/CapitalCommitments'
+                  required:
+                 - capitalCommitments
+          '400':
+            $ref: "#/components/responses/BadRequest"
+          '404':
+            $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:
-        - managingCode
-        - capitalProjectId
+        - $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
+      operationId: findCityCouncilDistricts
+      tags: 
+        - City Council Districts
       responses:
         '200':
-          description: an object of capital commitments for the capital project
+          description: an object of city council districts
           content:
             application/json:
               schema:
@@ -137,15 +181,6 @@ paths:
           $ref: '#/components/responses/BadRequest'
         '500':
           $ref: '#/components/responses/InternalServerError'
-  /city-council-districts:
-    get:
-      summary: 🚧 Find city council districts
-      operationId: findCityCouncilDistricts
-      tags: 
-        - City Council Districts
-      responses:
-        '200':
-          description: an object of city council districts
   /city-council-districts/{cityCouncilDistrictId}/capital-projects:
     get:
       summary: 🚧 Find paginated capital projects within a specific city council district.
@@ -167,16 +202,40 @@ paths:
           $ref: "#/components/responses/NotFound"
         '500':
           $ref: "#/components/responses/InternalServerError"
-                  capitalCommitments:
-                    type: object
-                    items:
-                      $ref: '#/components/schemas/CapitalCommitment'
-                required:
-                  - capitalCommitments
+  /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'
-        '404':
-          $ref: '#/components/responses/NotFound'
         '500':
           $ref: '#/components/responses/InternalServerError'
   /land-uses:
@@ -1068,6 +1127,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: