-
Notifications
You must be signed in to change notification settings - Fork 299
Unified usage of JSON:API abbreviation #945
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
Conversation
Codecov Report
@@ Coverage Diff @@ ## master #945 +/- ## ======================================= Coverage 96.82% 96.82% ======================================= Files 65 65 Lines 3904 3904 ======================================= Hits 3780 3780 Misses 124 124
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot. Really appreciate you take a look at this!
Just a quick grep seems you missed just a few occurrences of JSON API
:
CHANGELOG.md:* Added `rest_framework_json_api.serializer.Serializer` class to support initial JSON API views without models.
SECURITY.md:If you believe you've found something in Django REST Framework JSON API which has security implications, please **do not raise the issue in a public forum**.
requirements.txt:# The base set of requirements for Django REST framework JSON API is actually
rest_framework_json_api/exceptions.py: # Use regular DRF format if not rendered by DRF JSON API and not uniform
rest_framework_json_api/exceptions.py: # Convert to DRF JSON API error format
rest_framework_json_api/exceptions.py: # Add top-level 'errors' object when not rendered by DRF JSON API
rest_framework_json_api/renderers.py: # ID is always provided in the root of JSON API so remove it from attributes
rest_framework_json_api/settings.py: raise AttributeError("Invalid JSON API setting: '%s'" % attr)
setup.py: description="A Django REST framework API adapter for the JSON API spec.",
Could you update those as well? And please add yourself to the AUTHORS
file too. Thanks.
Thanks a lot. Really appreciate you take a look at this!
Just a quick grep seems you missed just a few occurrences of
JSON API
:CHANGELOG.md:* Added `rest_framework_json_api.serializer.Serializer` class to support initial JSON API views without models. SECURITY.md:If you believe you've found something in Django REST Framework JSON API which has security implications, please **do not raise the issue in a public forum**. requirements.txt:# The base set of requirements for Django REST framework JSON API is actually rest_framework_json_api/exceptions.py: # Use regular DRF format if not rendered by DRF JSON API and not uniform rest_framework_json_api/exceptions.py: # Convert to DRF JSON API error format rest_framework_json_api/exceptions.py: # Add top-level 'errors' object when not rendered by DRF JSON API rest_framework_json_api/renderers.py: # ID is always provided in the root of JSON API so remove it from attributes rest_framework_json_api/settings.py: raise AttributeError("Invalid JSON API setting: '%s'" % attr) setup.py: description="A Django REST framework API adapter for the JSON API spec.",
Could you update those as well? And please add yourself to the
AUTHORS
file too. Thanks.
Sorry about the miss and the delay. Have updated accordingly. While updating I came across a term like "jsonapi". Wasn't sure if it needed to be updated to "json:api". Do let me know if I should modify it as well.
Thanks. Yes jsonapi
in text should also be renamed to JSON:API
but I think it is mostly urls except one I saw in test_filters.py
. Maybe you find more.
The upper case term JSONAPI
is actually also used in comments (like openapi.py) which should also be JSON:API
. Just need to be careful not to rename code bits like class JSONAPIMetadata
where a colon can of course not be used.
You have already changed some bits from "json api" to "json:api". Actually for consistency let's make sure that all occurrences are uppercase as "JSON:API".
This issue is actually trickier than I thought but it is great when we look at this with four eyes to make sure the wording of "JSON:API" is used the same in the whole documentation and code comments.
Thanks. Yes
jsonapi
in text should also be renamed toJSON:API
but I think it is mostly urls except one I saw intest_filters.py
. Maybe you find more.The upper case term
JSONAPI
is actually also used in comments (like openapi.py) which should also beJSON:API
. Just need to be careful not to rename code bits like classJSONAPIMetadata
where a colon can of course not be used.
Alright, will modify it as well.
You have already changed some bits from "json api" to "json:api". Actually for consistency let's make sure that all occurrences are uppercase as "JSON:API".
Sorry, I was under the impression that the case needs to be maintained. However, I shall update it to "JSON:API".
8218989
to
d84b09e
Compare
@MsMansiDhruv
I have found some time to work on this. So the last occurrences should now also be renamed...
Thanks a lot for your initial work. One request I have though. Could please delete django-rest-framework-json-api-modify on Read the docs which you created for testing? So users are not confused which one is now the official documentation. Thanks.
Sorry, I wasn't able to find time to fix this. I have deleted the link to the documentation.
Fixes #940
Description of the Change
Update JSON: API from JSON API in the docs.
Test the updated docs at Read the JSON: API