239 document capital project commitments endpoint

NYCPlanning · May 24, 2024 · f198a5a · f198a5a
1 parent 9e1ce55
commit f198a5a
Showing 1 changed file with 38 additions and 10 deletions.
diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
@@ -88,7 +88,35 @@ paths:
         '404':
           $ref: "#/components/responses/NotFound"
         '500':
-          $ref: "#/components/responses/InternalServerError" 
+          $ref: "#/components/responses/InternalServerError"
+  /capital-projects/{managingCode}/{capitalProjectid}/capital-commitments:
+    get:
+      summary: Find capital commitments associated with a specific capital project
+      operationId: findCapitalCommitmentsByManagingCodeCapitalProjectId
+      tags: Capital Commitments
+      parameters:
+        - managingCode
+        - capitalProjectId
+      responses:
+        '200':
+          description: an object of capital commitments for the capital project
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  capitalCommitments:
+                    type: object
+                    items:
+                      $ref: '#/components/schemas/CapitalCommitment'
+                required:
+                  - capitalCommitments
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '404':
+          $ref: '#/components/responses/NotFound'
+        '500':
+          $ref: '#/components/responses/InternalServerError'
   /land-uses:
     get: 
       summary: List land uses
@@ -597,15 +625,15 @@ components:
           type: number
           description: A numeric string used to refer to the amount of total planned commitments.
           example: 1600000
-        required:
-          - id
-          - type
-          - plannedDate
-          - budgetLineCode
-          - budgetLineId
-          - sponsoringAgencyInitials
-          - budgetType
-          - totalValue
+      required:
+        - id
+        - type
+        - plannedDate
+        - budgetLineCode
+        - budgetLineId
+        - sponsoringAgencyInitials
+        - budgetType
+        - totalValue
     CapitalProjectCategory:
       type: string
       enum: