api/apiresponse: Use DRF JsonEncoder in documented endpoint views
ClosedPublic
Actions

Authored by anlambert on Aug 21 2020, 6:06 PM.

Details

Reviewers

vlorentz

Group Reviewers

Reviewers

Commits

rDWAPPS37a8f590ad54: api/apiresponse: Use DRF JsonEncoder in documented endpoint views

Summary

That encoder is used when querying the API for "application/json" content type.
It handles more encoding cases than the default one (notably it knows how to
encode a swh.model.collections.ImmutableDict), so let's also use it when
generating HTML documentation for the API endpoints.

Test Plan

I added a test to cover the issue discovered by @moranegg but this clearly calls
for tests improvements so I also created T2529.

Diff Detail

Repository

rDWAPPS Web applications

Lint

Automatic diff as part of commit; lint not applicable.

Unit

Automatic diff as part of commit; unit tests not applicable.

Event Timeline

anlambert created this revision.Aug 21 2020, 6:06 PM

Herald added a reviewer: Reviewers. · View Herald TranscriptAug 21 2020, 6:06 PM

anlambert edited the test plan for this revision. (Show Details)Aug 21 2020, 6:07 PM

anlambert edited the summary of this revision. (Show Details)Aug 21 2020, 6:10 PM

Build is green

Patch application report for D3826 (id=13465)

Rebasing onto b98a351cea...

Current branch diff-target is up to date.

Changes applied before test

commit 37a8f590ad54c37ab25155cac8058ddefd5d8b3d
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Fri Aug 21 17:18:20 2020 +0200

    api/apiresponse: Use DRF JsonEncoder in documented endpoint views
    
    That encoder is used when querying the API for "application/json" content type.
    It handles more encoding cases than the default one (notably it knows how to
    encode a swh.model.collections.ImmutableDict), so let's also use it when
    generating HTML documentation for the API endpoints.

See https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/340/ for more details.

Harbormaster completed remote builds in B14728: Diff 13465.Aug 21 2020, 6:13 PM

vlorentz accepted this revision.Aug 21 2020, 11:48 PM

This revision is now accepted and ready to land.Aug 21 2020, 11:48 PM

Closed by commit rDWAPPS37a8f590ad54: api/apiresponse: Use DRF JsonEncoder in documented endpoint views (authored by anlambert). · Explain WhyAug 24 2020, 11:16 AM

This revision was automatically updated to reflect the committed changes.

anlambert added a commit: rDWAPPS37a8f590ad54: api/apiresponse: Use DRF JsonEncoder in documented endpoint views.