Document goals of Django REST Framework JSON API #447
Merged
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
Codecov Report
@@ Coverage Diff @@
## master #447 +/- ##
======================================
Coverage 93.1% 93.1%
======================================
Files 54 54
Lines 3000 3000
======================================
Hits 2793 2793
Misses 207 207Continue to review full report at Codecov.
|
mblayman
approved these changes
Jul 24, 2018
|
|
||
| 1. Support the [JSON API](http://jsonapi.org/) spec to compliance | ||
| 2. Be as compatible with Django REST Framework as possible | ||
| e.g. issues in Django REST Framework should be fixed upstream and not worked around in DJA |
There was a problem hiding this comment.
This line looks good in the plain text, but I think it won't format well in the final documentation. It would look like "... as possible e.g. issues in Django...." I think the line should be wrapped with parentheses.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add goals of Django RESTFramework JSON API which we can reference to and use as basis in discussions of issues and pull requests.
This goals are extracted from following comment made by @mblayman. I can fully agree to those points and think it is important to document those goals in a easy to find place.
Checklist
CHANGELOG.mdAUTHORS