Add relationships support for pointers in errors

[mehdy]

Fixes #413

Description of the Change

When formatting DRF errors, use relationships in the pointer when the field is actually a relationship.

Checklist

• PR only contains one change (considered splitting up PR)
• unit-test added
• documentation updated
• CHANGELOG.md updated (only for user relevant changes)
• author name in AUTHORS

[mehdy]

@sliverc This is my draft attempt at solving the problem. I was wondering if you could give me some hints on whether I'm headed in the right direction or not?

[codecov]

Codecov Report

Merging #986 (24de3fa) into master (0816192) will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #986      +/-   ##
==========================================
+ Coverage   96.83%   96.84%   +0.01%     
==========================================
  Files          65       65              
  Lines        3914     3929      +15     
==========================================
+ Hits         3790     3805      +15     
  Misses        124      124              

Impacted Files	Coverage Δ
example/tests/snapshots/snap_test_errors.py	100.00% <100.00%> (ø)
example/tests/test_errors.py	100.00% <100.00%> (ø)
rest_framework_json_api/renderers.py	90.15% <100.00%> (ø)
example/utils.py	92.67% <0.00%> (+0.30%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0816192...24de3fa. Read the comment docs.

[sliverc]

Yes you are on the right track. included_serializers is optional though so not the right way to determine whether a field is a relationship. See here how an attribute is distinguished from relationship in the renderer.

[mehdy]

@sliverc Great! Thanks!

[mehdy]

@sliverc
I think this is ready for review.
Just let me know if I should add it to CHANGELOG.md and/or the docs.

[mehdy]

@sliverc I couldn't understand why codecov is failing. Should I do something?

[sliverc]

Thanks for working on this. Please see my inline comments.

[mehdy]

@sliverc Resolved all the issues you mentioned.

[sliverc]

This PR is shaping up nicely. See some small comments inline.

[mehdy]

@sliverc Done as well. Thanks for the tips.

[sliverc]

Thanks for the changes. Somewhat one of my comment got swallowed (maybe had to many tabs open... 😄 ) See last comment, also rebase to current master and then this PR is good to merge.

[sliverc]

and totally forgot please also add a changelog entry.

[mehdy]

@sliverc I think we're good to go :D

[sliverc]

Thanks for the changes and your time putting into making this work. Very appreciated.

It seems that you (your IDE?) autoformatted the changelog markdown file (I guess with prettier?). There were quite a few changes... I reverted those to make this PR ready. But certainly something to think about whether as DJA we want to autoformat md files but I guess part of another discussion.

Thanks again.

[mehdy]

@sliverc You're very welcome!
Sorry about the autoformat. Thanks for taking care of it though. :D