Renamed missing json api occurences

sliverc · sliverc · commit d84b09e915a9 · 2021-08-14T22:28:27.000+04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -104,10 +104,10 @@ This is the last release supporting Django 1.11, Django 2.1, Django REST Framewo
 ### Added
 
 * 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.
+ * 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.
   * 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.
+  * 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.
 
 ### Fixed
 
@@ -202,7 +202,7 @@ This is the last release supporting Python 2.7, Python 3.4, Django Filter 1.1, D
 * Don't swallow `filter[]` params when there are several
 * Fix DeprecationWarning regarding collections.abc import in Python 3.7
 * Allow OPTIONS request to be used on RelationshipView
-* Remove non-JSONAPI methods (PUT and TRACE) from ModelViewSet and RelationshipView.
+* Remove non-JSON:API methods (PUT and TRACE) from ModelViewSet and RelationshipView.
   This fix might be a **BREAKING CHANGE** if your clients are incorrectly using PUT instead of PATCH.
 * Avoid validation error for missing fields on a PATCH request using polymorphic serializers
 
diff --git a/README.rst b/README.rst
@@ -149,7 +149,7 @@ installed and activated:
 
 Browse to
 
-* http://localhost:8000 for the list of available collections (in a non-JSONAPI format!),
+* http://localhost:8000 for the list of available collections (in a non-JSON:API format!),
 * http://localhost:8000/swagger-ui/ for a Swagger user interface to the dynamic schema view, or
 * http://localhost:8000/openapi for the schema view's OpenAPI specification document.
 
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -97,7 +97,7 @@ and add `rest_framework_json_api` to your `INSTALLED_APPS` setting below `rest_f
 
 
 Browse to
-* [http://localhost:8000](http://localhost:8000) for the list of available collections (in a non-JSONAPI format!),
+* [http://localhost:8000](http://localhost:8000) for the list of available collections (in a non-JSON:API format!),
 * [http://localhost:8000/swagger-ui/](http://localhost:8000/swagger-ui/) for a Swagger user interface to the dynamic schema view, or
 * [http://localhost:8000/openapi](http://localhost:8000/openapi) for the schema view's OpenAPI specification document.
 
diff --git a/docs/usage.md b/docs/usage.md
@@ -312,7 +312,7 @@ multiple endpoints. Setting the `resource_name` on views may result in a differe
 
 ### Inflecting object and relation keys
 
-This package includes the ability (off by default) to automatically convert [json:api field names](http://jsonapi.org/format/#document-resource-object-fields) of requests and responses from the python/rest_framework's preferred underscore to
+This package includes the ability (off by default) to automatically convert [JSON:API field names](http://jsonapi.org/format/#document-resource-object-fields) of requests and responses from the python/rest_framework's preferred underscore to
 a format of your choice. To hook this up include the following setting in your
 project settings:
 
diff --git a/example/tests/test_filters.py b/example/tests/test_filters.py
@@ -104,7 +104,7 @@ def test_sort_underscore(self):
 
     def test_sort_related(self):
         """
-        test sort via related field using jsonapi path `.` and django orm `__` notation.
+        test sort via related field using JSON:API path `.` and django orm `__` notation.
         ORM relations must be predefined in the View's .ordering_fields attr
         """
         for datum in ("blog__id", "blog.id"):
diff --git a/example/tests/test_generic_viewset.py b/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": [
diff --git a/rest_framework_json_api/django_filters/backends.py b/rest_framework_json_api/django_filters/backends.py
@@ -11,7 +11,7 @@ class DjangoFilterBackend(DjangoFilterBackend):
     """
     A Django-style ORM filter implementation, using `django-filter`.
 
-    This is not part of the jsonapi standard per-se, other than the requirement
+    This is not part of the JSON:API standard per-se, other than the requirement
     to use the `filter` keyword: This is an optional implementation of style of
     filtering in which each filter is an ORM expression as implemented by
     DjangoFilterBackend and seems to be in alignment with an interpretation of
@@ -50,7 +50,7 @@ class DjangoFilterBackend(DjangoFilterBackend):
     the name of the query parameter for searching to make sure it doesn't conflict
     with a field name defined in the filterset.
     The recommended value is: `search_param="filter[search]"` but just make sure it's
-    `filter[<something>]` to comply with the jsonapi spec requirement to use the filter
+    `filter[<something>]` to comply with the JSON:API spec requirement to use the filter
     keyword. The default is "search" unless overriden but it's used here just to make sure
     we don't complain about it being an invalid filter.
     """
@@ -117,7 +117,7 @@ def get_filterset_kwargs(self, request, queryset, view):
                     raise ValidationError(
                         "missing value for query parameter {}".format(qp)
                     )
-                # convert jsonapi relationship path to Django ORM's __ notation
+                # convert JSON:API relationship path to Django ORM's __ notation
                 key = m.groupdict()["assoc"].replace(".", "__")
                 key = undo_format_field_name(key)
                 data.setlist(key, val)
diff --git a/rest_framework_json_api/filters.py b/rest_framework_json_api/filters.py
@@ -90,7 +90,7 @@ def validate_query_params(self, request):
 
         :raises ValidationError: if not.
         """
-        # TODO: For jsonapi error object conformance, must set jsonapi errors "parameter" for
+        # TODO: For JSON:API error object conformance, must set JSON:API errors "parameter" for
         # the ValidationError. This requires extending DRF/DJA Exceptions.
         for qp in request.query_params.keys():
             m = self.query_regex.match(qp)
diff --git a/rest_framework_json_api/pagination.py b/rest_framework_json_api/pagination.py
@@ -10,7 +10,7 @@
 
 class JsonApiPageNumberPagination(PageNumberPagination):
     """
-    A json:api compatible pagination format.
+    A JSON:API compatible pagination format.
     """
 
     page_query_param = "page[number]"
diff --git a/rest_framework_json_api/parsers.py b/rest_framework_json_api/parsers.py
@@ -87,7 +87,7 @@ def parse(self, stream, media_type=None, parser_context=None):
         from rest_framework_json_api.views import RelationshipView
 
         if isinstance(view, RelationshipView):
-            # We skip parsing the object as JSONAPI Resource Identifier Object and not a regular
+            # We skip parsing the object as JSON:API Resource Identifier Object and not a regular
             # Resource Object
             if isinstance(data, list):
                 for resource_identifier_object in data:
@@ -96,12 +96,12 @@ def parse(self, stream, media_type=None, parser_context=None):
                         and resource_identifier_object.get("type")
                     ):
                         raise ParseError(
-                            "Received data contains one or more malformed JSONAPI "
+                            "Received data contains one or more malformed JSON:API "
                             "Resource Identifier Object(s)"
                         )
             elif not (data.get("id") and data.get("type")):
                 raise ParseError(
-                    "Received data is not a valid JSONAPI Resource Identifier Object"
+                    "Received data is not a valid JSON:API Resource Identifier Object"
                 )
 
             return data
@@ -111,7 +111,7 @@ def parse(self, stream, media_type=None, parser_context=None):
         # Sanity check
         if not isinstance(data, dict):
             raise ParseError(
-                "Received data is not a valid JSONAPI Resource Identifier Object"
+                "Received data is not a valid JSON:API Resource Identifier Object"
             )
 
         # Check for inconsistencies
diff --git a/rest_framework_json_api/schemas/openapi.py b/rest_framework_json_api/schemas/openapi.py
@@ -11,10 +11,10 @@
 
 class SchemaGenerator(drf_openapi.SchemaGenerator):
     """
-    Extend DRF's SchemaGenerator to implement jsonapi-flavored generateschema command.
+    Extend DRF's SchemaGenerator to implement JSON:API flavored generateschema command.
     """
 
-    #: These JSONAPI component definitions are referenced by the generated OAS schema.
+    #: These JSON:API component definitions are referenced by the generated OAS schema.
     #: If you need to add more or change these static component definitions, extend this dict.
     jsonapi_components = {
         "schemas": {
@@ -258,7 +258,7 @@ class SchemaGenerator(drf_openapi.SchemaGenerator):
 
     def get_schema(self, request=None, public=False):
         """
-        Generate a JSONAPI OpenAPI schema.
+        Generate a JSON:API OpenAPI schema.
         Overrides upstream DRF's get_schema.
         """
         # TODO: avoid copying so much of upstream get_schema()
@@ -393,15 +393,15 @@ def _field_is_one_or_many(self, field, view):
 
 class AutoSchema(drf_openapi.AutoSchema):
     """
-    Extend DRF's openapi.AutoSchema for JSONAPI serialization.
+    Extend DRF's openapi.AutoSchema for JSON:API serialization.
     """
 
-    #: ignore all the media types and only generate a JSONAPI schema.
+    #: ignore all the media types and only generate a JSON:API schema.
     content_types = ["application/vnd.api+json"]
 
     def get_operation(self, path, method):
         """
-        JSONAPI adds some standard fields to the API response that are not in upstream DRF:
+        JSON:API adds some standard fields to the API response that are not in upstream DRF:
         - some that only apply to GET/HEAD methods.
         - collections
         - special handling for POST, PATCH, DELETE
@@ -505,7 +505,7 @@ def _add_get_item_response(self, operation):
 
     def _get_toplevel_200_response(self, operation, collection=True):
         """
-        return top-level JSONAPI GET 200 response
+        return top-level JSON:API GET 200 response
 
         :param collection: True for collections; False for individual items.
 
@@ -587,15 +587,15 @@ def _add_delete_item_response(self, operation, path):
 
     def get_request_body(self, path, method):
         """
-        A request body is required by jsonapi for POST, PATCH, and DELETE methods.
+        A request body is required by JSON:API for POST, PATCH, and DELETE methods.
         """
         serializer = self.get_serializer(path, method)
         if not isinstance(serializer, (serializers.BaseSerializer,)):
             return {}
         is_relationship = isinstance(self.view, views.RelationshipView)
 
         # DRF uses a $ref to the component schema definition, but this
-        # doesn't work for jsonapi due to the different required fields based on
+        # doesn't work for JSON:API due to the different required fields based on
         # the method, so make those changes and inline another copy of the schema.
         # TODO: A future improvement could make this DRYer with multiple component schemas:
         #   A base schema for each viewset that has no required fields
@@ -640,7 +640,7 @@ def get_request_body(self, path, method):
 
     def map_serializer(self, serializer):
         """
-        Custom map_serializer that serializes the schema using the jsonapi spec.
+        Custom map_serializer that serializes the schema using the JSON:API spec.
         Non-attributes like related and identity fields, are move to 'relationships' and 'links'.
         """
         # TODO: remove attributes, etc. for relationshipView??
diff --git a/rest_framework_json_api/serializers.py b/rest_framework_json_api/serializers.py
@@ -214,9 +214,9 @@ class Serializer(
 ):
     """
     A `Serializer` is a model-less serializer class with additional
-    support for json:api spec features.
+    support for JSON:API spec features.
 
-    As in json:api specification a type is always required you need to
+    As in JSON:API specification a type is always required you need to
     make sure that you define `resource_name` in your `Meta` class
     when deriving from this class.
 
diff --git a/rest_framework_json_api/settings.py b/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.
     """
 
diff --git a/tests/test_parsers.py b/tests/test_parsers.py
@@ -110,8 +110,9 @@ def test_parse_fails_on_list_of_objects(self, parse):
         with pytest.raises(ParseError) as excinfo:
             parse(data)
 
-        assert "Received data is not a valid JSONAPI Resource Identifier Object" == str(
-            excinfo.value
+        assert (
+            "Received data is not a valid JSON:API Resource Identifier Object"
+            == str(excinfo.value)
         )
 
     def test_parse_fails_when_id_is_missing_on_patch(self, rf, parse, parser_context):
