Skip to content

Add api documentation to serializer classes #827

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 8, 2020

Conversation

sliverc
Copy link
Member

@sliverc sliverc commented Sep 8, 2020

Fixes #433

Description of the Change

Add api documentation to serializer classes and mixins.

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

@sliverc sliverc requested a review from n2ygk September 8, 2020 15:37
@codecov
Copy link

codecov bot commented Sep 8, 2020

Codecov Report

Merging #827 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #827   +/-   ##
=======================================
  Coverage   97.08%   97.08%           
=======================================
  Files          58       58           
  Lines        3158     3158           
=======================================
  Hits         3066     3066           
  Misses         92       92           

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 bb672e4...f12c28a. Read the comment docs.

Copy link
Contributor

@n2ygk n2ygk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks

@n2ygk n2ygk merged commit 82daf66 into django-json-api:master Sep 8, 2020
@sliverc sliverc deleted the document_serializer_mixin branch December 28, 2021 18:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

document IncludedResourcesValidationMixin
2 participants