frontend: first steps towards removing unnecessary APIv3 abstractions #3228
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
We intentionally left a huge mess and a lot of magic in `fields.py`, `schemas.py`, and `docs.py` because it made the migration to Flask-RESTX a lot easier and we didn't know the correct abstractions beforehand. In this patch, I am proposing several refactors to simplify the code: - Schemas duplicated file types that were already-defined in `fields.py`. I am using the already defined ones to avoid duplication - There seems to be no need for separately defining schemas and models now. In the end, we care only about models and schemas were IIRC only an implementation detail. I am showing how to remove some schemas and define models directly. - Having every field defined as a variable in one giant pile in `fields.py` was a temporary measure. We can define the fields within models and then point to them to avoid duplication. See `project_fork_input_model` and its `ownername`. Also, some fields (projectname, persistent, and additional_repos) were missing from the schema while being mentioned in `apiv3_projects.to_dict`. I don't know how it worked without errors. I am adding them.
|
Do you think this approach could be done for the whole APIv3 code, or we will hit a wall somewhere? which tracebacks. But I don't think I caused it in this PR (not sure). |
|
We'll have to wait for the Pydantic support in python3-flask-restx. The thing Jakub propose works on "outputs", but not on "user inputs" int he API. |
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.
We intentionally left a huge mess and a lot of magic in
fields.py,schemas.py, anddocs.pybecause it made the migration to Flask-RESTX a lot easier and we didn't know the correct abstractions beforehand.In this patch, I am proposing several refactors to simplify the code:
fields.py. I am using the already defined ones to avoid duplicationfields.pywas a temporary measure. We can define the fields within models and then point to them to avoid duplication. Seeproject_fork_input_modeland itsownername.