241 city council district endpoint documentation

NYCPlanning · May 30, 2024 · 832b208 · 832b208
1 parent d6d9acc
commit 832b208
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
@@ -111,6 +111,30 @@ paths:
           $ref: "#/components/responses/NotFound"
         '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
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  cityCouncilDistricts:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/CityCouncilDistrict'
+                required:
+                 - cityCouncilDistricts
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '500':
+          $ref: '#/components/responses/InternalServerError'
   /city-council-districts/{cityCouncilDistrictId}/capital-projects:
     get:
       summary: 🚧 Find paginated capital projects within a specific city council district.