Some CAN-related endpoints mismatch for CANFundingDetails and CANFundingReceived #3279
Labels
Dev Backend Ready
Backend, Pipeline, or other UX related work is refined, and ready for Developers
python
Pull requests that update Python code
tech-debt
Resolved technical debt (tooling, configuration, or workflow)
The /can-funding-details and /can-funding-received endpoints have inconsistencies in the openAPI schema. They also occasionally do not match the actual
Expected Behavior
The list and item API for the CANFundingReceived and CANFundingDetails, both in the python URL definition and the openAPI yaml file should be
/can-funding-details
/can-funding-received
Current Behavior
There are a mix of /can-funding-details and /cans-funding-received, /can-funding-received and /cans-funding-received.
The FLASK URLs should be /can-funding-details/ and /can-funding-received/
The OpenAPI schemas should be /can-funding-details/ and /can-funding-received/ as well.
'can' should be singular in all cases. Make sure both the openAPI schema and python URIs are singular 'can'
Possible Cause
Developer Error
Steps to Reproduce
Nothing needs to be reproduced. This isn't a logic bug, it's a definition and documentation bug.
Context
The inconsistency between the openapi and the python URIs could lead to issues when doing front end development.
The text was updated successfully, but these errors were encountered: