MPP-3799: Split API views by emails and privaterelay #4657
Merged
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.
For MPP-3799, I'm going to add schema definitions to make
drf_spectacular.W0002
warnings go away, which will expand the definitions of API serializers and view functions, and might change some of the implementation as well. Before I do that, I wanted to make theemails
andprivaterelay
code mirror thephones
code, without any deeper changes.The changes in
api/urls.py
is a decent overview of the changes:api.views.emails.py
has the email-specific views:DomainAddressViewSet
RelayAddressViewSet
first_forwarded_email
view functionapi.views.privaterelay.py
has the general service views:FlagViewSet
ProfileViewSet
UserViewSet
report_webcompat_issue
runtime_data
terms_accepted_user
I also moved the tests and serializers to separate files.
If this is too many changes, I can instead have view-specific PRs, that move the view and add the schema annotations. I'm open to other suggestions as well.
How to test:
pytest
runs without issues