fix: update can funding summary openapi spec #2963
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
maiyerlee
commented
Oct 22, 2024
| schema: | ||
| type: array | ||
| items: | ||
| type: string |
There was a problem hiding this comment.
I'm unsure if the portfolio parameter here should be the portfolio ID, name, or abbreviation. 🤔
There was a problem hiding this comment.
think the abbreviation or id would be more slug-friendly:
maiyerlee
requested review from
fpigeonjr,
johndeange,
rajohnson90 and
Santi-3rd
fpigeonjr
approved these changes
Oct 22, 2024
johndeange
approved these changes
Oct 23, 2024
maiyerlee
deleted the
2961-update-openapi-spec-for-can-funding-summary
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changed
This PR updates the openapi.yml file to reflect changes to the CAN Funding Summary (
/api/v1/can-funding-summary/{can_id}) endpoint for supporting CAN Summary Information cards.can_idpath parametercan_idsquery parameter: Required list of CAN Idsactive_periodquery parameter: Optional list of active periodstransferquery parameter: Optional list of method of transfer typesportfolioquery parameter: Optional list of portfoliosfy_budgetquery parameter: Optional list of exactly two values (min and max)new_fundingto the response object: String value of the spending amountIssue
#2961
How to test
The openapi.yml file has been successfully generated and is free of any syntax issues.
Screenshots
N/A
Definition of Done Checklist
Links
N/A