Document a capital project

Add the /capital-projects/{managingCode}/{capitalProjectid} endpoint. closes #238
NYCPlanning · Jun 12, 2024 · e2a5a67 · e2a5a67
1 parent 1470d53
commit e2a5a67
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
@@ -134,6 +134,22 @@ paths:
                       $ref: '#/components/schemas/CapitalCommitment'
                 required:
                 - capitalCommitments
+  /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':