241 city council district endpoint documentation

NYCPlanning · May 24, 2024 · 45f6bd5 · 45f6bd5
1 parent 08e2960
commit 45f6bd5
Showing 1 changed file with 25 additions and 1 deletion.
diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
@@ -88,7 +88,31 @@ paths:
         '404':
           $ref: "#/components/responses/NotFound"
         '500':
-          $ref: "#/components/responses/InternalServerError" 
+          $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'
   /land-uses:
     get: 
       summary: List land uses