Add capital projects in community district endpoint

NYCPlanning · May 28, 2024 · 97c0645 · 97c0645
1 parent 08e2960
commit 97c0645
Showing 1 changed file with 30 additions and 1 deletion.
diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
@@ -88,7 +88,36 @@ paths:
         '404':
           $ref: "#/components/responses/NotFound"
         '500':
-          $ref: "#/components/responses/InternalServerError" 
+          $ref: "#/components/responses/InternalServerError"
+  /boroughs/{boroughId}/community-districts/{communityDistrictId}/capital-projects:
+    get:
+      summary: Find paginated capital projects within a specified community district
+      operationId: findCapitalProjectsByBoroughIdCommunityDistrictId
+      tags:
+      - Capital Projects
+      parameters:
+        - $ref: "#/components/parameters/boroughIdParam"
+        - $ref: "#/components/parameters/communityDistrictIdParam"
+      responses:
+        '200':
+          description: An array of capital projects for the community district
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  capitalProjectPage:
+                    type: array
+                    items:
+                      $ref: "#/components/schemas/CapitalProjectPage"
+                required:
+                  - capitalProjectPage
+        '400':
+          $ref: "#/components/responses/BadRequest"
+        '404':
+          $ref: "#/components/responses/NotFound"
+        '500':
+          $ref: "#/components/responses/InternalServerError"
   /land-uses:
     get: 
       summary: List land uses