diff --git a/backend/openapi.yml b/backend/openapi.yml index d1107d72b3..471c8150a2 100644 --- a/backend/openapi.yml +++ b/backend/openapi.yml @@ -1076,28 +1076,68 @@ paths: "purpose": "" } ] - /api/v1/can-funding-summary/{can_id}: + /api/v1/can-funding-summary: get: tags: - CAN Funding Summary - operationId: getFundingTotalsByCanId - description: Get Funding Totals by CAN Id + operationId: getFundingTotals + description: Get Funding Totals parameters: - $ref: "#/components/parameters/simulatedError" + - name: can_ids + in: query + description: List of CAN Ids (required) + required: true + schema: + type: array + items: + type: integer + example: [ 12345, 12346, 12347 ] - name: fiscal_year in: query + description: Fiscal year (optional) schema: type: string - example: "2023" - - in: path - name: can_id - description: CAN Id - required: true + example: "2023" + - name: active_period + in: query + description: List of active periods (optional) schema: - type: integer - format: int32 - minimum: 0 - default: 0 + type: array + items: + type: integer + example: [ 1, 5 ] + - name: transfer + in: query + description: List of CAN Method of Transfers (optional) + schema: + type: array + items: + type: string + enum: + - DIRECT + - COST_SHARE + - IAA + - IDDA + example: [ "DIRECT", "IAA" ] + - name: portfolio + in: query + description: List of portfolio abbreviations (optional) + schema: + type: array + items: + type: string + example: [ "HS", "HMRF", "CC" ] + - name: fy_budget + in: query + description: List of two values representing the min and max fiscal year budget (optional) + schema: + type: array + items: + type: integer + minItems: 2 + maxItems: 2 + example: [ 50000, 100000 ] responses: "200": description: OK @@ -1153,6 +1193,8 @@ paths: type: string expected_funding: type: string + new_funding: + type: string examples: "0": value: | @@ -1180,7 +1222,8 @@ paths: "in_execution_funding": "2000000.00", "obligated_funding": 0, "planned_funding": 0, - "total_funding": "10000000.00" + "total_funding": "10000000.00", + "new_funding": "2000000.00" } /api/v1/users/: get: