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.

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

Some CAN-related endpoints mismatch for CANFundingDetails and CANFundingReceived #3279

Open
rajohnson90 opened this issue Jan 8, 2025 · 0 comments
Assignees
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)

Comments

@rajohnson90
Copy link
Contributor

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.

@rajohnson90 rajohnson90 added bug Something isn't working Dev Backend Ready Backend, Pipeline, or other UX related work is refined, and ready for Developers python Pull requests that update Python code labels Jan 8, 2025
@jonnalley jonnalley added tech-debt Resolved technical debt (tooling, configuration, or workflow) and removed bug Something isn't working labels Jan 9, 2025
@Santi-3rd Santi-3rd self-assigned this Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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)
Projects
None yet
Development

No branches or pull requests

3 participants