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

Add check of backend model serializers vs. frontend types #1080

Open
2 tasks done
andrewtavis opened this issue Jan 12, 2025 · 0 comments
Open
2 tasks done

Add check of backend model serializers vs. frontend types #1080

andrewtavis opened this issue Jan 12, 2025 · 0 comments
Labels
feature New feature or request help wanted Extra attention is needed question Further information is requested

Comments

@andrewtavis
Copy link
Member

andrewtavis commented Jan 12, 2025

Terms

Description

A recent discussion was how to make sure that the frontend and backend are aligned as far as what data is being sent and received. A general idea for this is to write backend model serializers and frontend types in a way that they can be compared. By this I mean that we would link and check serializers.py files against frontend/types files such that that each would need to have matching classes with the same included arguments/methods (given snake_case to camelCase conversion). The serializers would then be checked by backend processes and the types would be enforced on the frontend, so we should then have dramatically more consistent data transfers.

Included in this would also need to be a check to assure that all serializers are included and matched with a given type file so we know that everything is being checked.

Contribution

Happy to discuss and eventually work on this once things are a bit more stable :)

CC @to-sta

@andrewtavis andrewtavis added feature New feature or request help wanted Extra attention is needed question Further information is requested labels Jan 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request help wanted Extra attention is needed question Further information is requested
Projects
Status: Todo
Development

No branches or pull requests

1 participant