Add and apply custom ViewSet classes #14
Closed
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.
What:
Adding custom ViewSet classes to better control the methods generated/exposed by the routers. The two new view set classes are:
RetrieveOnlyViewSet:
Supports GET requests to urls like
addons.osf.io/v1/{resource-type}/{pk}
RetrieveWriteViewSet:
Supports GET/PATCH/DELETE requests to urls like
addons.osf.io/v1/{resource-type}/{pk}
Supports POST requests to urls like
addons.osf.io/v1/{resource-type}/
Notably, neither class supports GET requests to urls like
addons.osf.io/v1/{resource-type}/
Why:
Of our top-level entities, only ExternalStorageService supports a List View (all of our other supported List Views are relationship views). Meanwhile, existing, out-of-the-box ViewSets from DRF and DRF-JSON API all provide both
retrieve
ANDlist
functionality.How:
Future Steps