Modify JSON:API from JSON API (#940)

Author: MsMansiDhruv

CHANGELOG.md

@@ -105,7 +105,7 @@ This is the last release supporting Django 1.11, Django 2.1, Django REST Framewo
 
 * Added support for serializing nested serializers as attribute json value introducing setting `JSON_API_SERIALIZE_NESTED_SERIALIZERS_AS_ATTRIBUTE`
  * Note: As keys of nested serializers are not json:api spec field names they are not inflected by format field names option.
-* Added `rest_framework_json_api.serializer.Serializer` class to support initial JSON API views without models.
+* Added `rest_framework_json_api.serializer.Serializer` class to support initial JSON:API views without models.
   * Note that serializers derived from this class need to define `resource_name` in their `Meta` class.
   * This fix might be a **BREAKING CHANGE** if you use `rest_framework_json_api.serializers.Serializer` for non json:api spec views (usually `APIView`). You need to change those serializers classes to use `rest_framework.serializers.Serializer` instead.
 

SECURITY.md

@@ -2,7 +2,7 @@
 
 ## Reporting a Vulnerability
 
-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**.
+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**.
 
 Send a description of the issue via email to [rest-framework-jsonapi-security@googlegroups.com][security-mail]. The project maintainers will then work with you to resolve any issues where required, prior to any public disclosure.
 

example/tests/test_generic_viewset.py

@@ -55,7 +55,7 @@ def test_ember_expected_renderer(self):
 
     def test_default_validation_exceptions(self):
         """
-        Default validation exceptions should conform to json api spec
+        Default validation exceptions should conform to json:api spec
         """
         expected = {
             "errors": [

requirements.txt

@@ -1,4 +1,4 @@
-# The base set of requirements for Django REST framework JSON API is actually
+# The base set of requirements for Django REST framework JSON:API is actually
 # fairly small, but for the purposes of development and testing
 # there are a number of packages that are useful to install.
 

rest_framework_json_api/exceptions.py

@@ -29,16 +29,16 @@ def exception_handler(exc, context):
     if not response:
         return response
 
-    # Use regular DRF format if not rendered by DRF JSON API and not uniform
+    # Use regular DRF format if not rendered by DRF JSON:API and not uniform
     is_json_api_view = rendered_with_json_api(context["view"])
     is_uniform = json_api_settings.UNIFORM_EXCEPTIONS
     if not is_json_api_view and not is_uniform:
         return response
 
-    # Convert to DRF JSON API error format
+    # Convert to DRF JSON:API error format
     response = utils.format_drf_errors(response, context, exc)
 
-    # Add top-level 'errors' object when not rendered by DRF JSON API
+    # Add top-level 'errors' object when not rendered by DRF JSON:API
     if not is_json_api_view:
         response.data = utils.format_errors(response.data)
 

rest_framework_json_api/renderers.py

@@ -58,7 +58,7 @@ def extract_attributes(cls, fields, resource):
         """
         data = OrderedDict()
         for field_name, field in iter(fields.items()):
-            # ID is always provided in the root of JSON API so remove it from attributes
+            # ID is always provided in the root of JSON:API so remove it from attributes
             if field_name == "id":
                 continue
             # don't output a key for write only fields

rest_framework_json_api/settings.py

@@ -20,7 +20,7 @@
 
 class JSONAPISettings(object):
     """
-    A settings object that allows json api settings to be access as
+    A settings object that allows json:api settings to be access as
     properties.
     """
 
@@ -30,7 +30,7 @@ def __init__(self, user_settings=settings, defaults=DEFAULTS):
 
     def __getattr__(self, attr):
         if attr not in self.defaults:
-            raise AttributeError("Invalid JSON API setting: '%s'" % attr)
+            raise AttributeError("Invalid JSON:API setting: '%s'" % attr)
 
         value = getattr(
             self.user_settings, JSON_API_SETTINGS_PREFIX + attr, self.defaults[attr]

setup.py

@@ -72,7 +72,7 @@ def get_package_data(package):
     version=get_version("rest_framework_json_api"),
     url="https://github.com/django-json-api/django-rest-framework-json-api",
     license="BSD",
-    description="A Django REST framework API adapter for the JSON API spec.",
+    description="A Django REST framework API adapter for the JSON:API spec.",
     long_description=read("README.rst"),
     author="Jerel Unruh",
     author_email="",