Bug 1928549: Fix API schema generation and 500 error on docs page #9148
+49
−10
Conversation
This file contains hidden or 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
This fixes the 500 error preventing the API documentation from loading by doing the below: * Add `TreeherderFilterBackend` to implement missing `get_schema_operation_parameters` method in `DjangoFilterBackend`. * Update `DEFAULT_FILTER_BACKENDS` and `performance_data.py` viewsets to use the new custom backend. * Change `PerformanceJobViewSet` to inherit from ViewSet to avoid `serializer_class` assertion errors. * Fix `AttributeError` in `PerfCompareResults.get_serializer_class` when request is `None` during schema generation. * Rename typos in DetailsPanel.jsx and PerformanceJobViewSet for consistency. Fixes Bug 1998273
moijes12
changed the title
Contributor
Author
|
@bhearsum Please can you review this if you get some time |
Collaborator
|
I'm not actually a reviewer for Treeherder.... @Archaeopteryx ? |
Contributor
Author
|
No problem. Thanks @bhearsum |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR resolves a 500 error encountered when accessing the
/docs/and/api/schema/endpoints. The issue was caused by incompatibilities betweendjango-filteranddjangorestframework's schema generation, as well as missing attributes in specific API views.TreeherderFilterBackendto implement missingget_schema_operation_parametersmethod inDjangoFilterBackend.DEFAULT_FILTER_BACKENDSandperformance_data.pyviewsets to use the new custom backend.PerformanceJobViewSetto inherit from ViewSet to avoidserializer_classassertion errors.AttributeErrorinPerfCompareResults.get_serializer_classwhen request isNoneduring schema generation.@jmaher @gmierz
Fixes Bug 1928549