Document a capital project

Add the /capital-projects/{managingCode}/{capitalProjectid} endpoint. closes #238
NYCPlanning · Jun 12, 2024 · 95160cb · 95160cb
1 parent 1470d53
commit 95160cb
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
@@ -140,6 +140,28 @@ paths:
           $ref: "#/components/responses/NotFound"
         '500':
           $ref: "#/components/responses/InternalServerError"
+  /capital-projects/{managingCode}/{capitalProjectId}:
+    get:
+      summary: 🚧 Find details about a specific capital project
+      operationId: findCapitalProjectByManagingCodeCapitalProjectId
+      tags:
+      - Capital Projects
+      parameters:
+        - $ref: "#/components/parameters/managingCodeParam"
+        - $ref: "#/components/parameters/capitalProjectIdParam"
+      responses:
+        '200':
+          description: An object of capital project details
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CapitalProjectBudgeted'
+        '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