Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: update can funding summary openapi spec #2963

Merged
merged 4 commits into from
Oct 23, 2024
Merged

fix: update can funding summary openapi spec #2963

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
06e9b57
fix: update can funding summary openapi spec
maiyerlee Oct 22, 2024
4b2db6e
fix: add fy new funding to can funding summary response
maiyerlee Oct 22, 2024
6df1ded
chore: add space to fix json syntax
maiyerlee Oct 22, 2024
018a291
docs: use portfolio abbreviations
maiyerlee Oct 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 56 additions & 13 deletions backend/openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor Author

@maiyerlee maiyerlee Oct 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm unsure if the portfolio parameter here should be the portfolio ID, name, or abbreviation. 🤔

Copy link
Contributor

@fpigeonjr fpigeonjr Oct 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

think the abbreviation or id would be more slug-friendly:
image

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
Expand Down Expand Up @@ -1153,6 +1193,8 @@ paths:
type: string
expected_funding:
type: string
new_funding:
type: string
examples:
"0":
value: |
Expand Down Expand Up @@ -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:
Expand Down