Change error message for bulk update

The `invalid_data_id` label was confusing, so this patch changes it to
`id_of_invalid_data`, which should be clearer. The documentation and
tests are updated as well.

JIRA: PDC-959

contrib/bulk_operations/bulk_operations.py

@@ -31,7 +31,7 @@ def _failure_response(ident, response, data=None):
     Response object that describes the error.
     """
     result = {
-        'invalid_data_id': ident,
+        'id_of_invalid_data': ident,
         'detail': response.data.get('detail', response.data),
     }
     if data:

contrib/bulk_operations/tests.py

@@ -72,7 +72,7 @@ def view(viewset, _request, **kwargs):
         response = wrapped(self.viewset, self.request)
         self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
         self.assertEqual(response.data,
-                         {'invalid_data': 'baz', 'invalid_data_id': 2, 'detail': 'error'})
+                         {'invalid_data': 'baz', 'id_of_invalid_data': 2, 'detail': 'error'})
 
     def test_bulk_destroy(self):
         self.request.data = ['foo', 'bar', 'baz']

docs/source/bulk_operations.rst

@@ -83,15 +83,15 @@ The structure of the response body should (in case of client errors) consist of
 a JSON object with the following structure.::
 
     {
-        "detail":           <string|object>,
-        "invalid_data_id":  <string|int>,
-        "invalid_data":     object
+        "detail":             <string|object>,
+        "id_of_invalid_data": <string|int>,
+        "invalid_data":       object
     }
 
 The ``detail`` key denotes a more precise description of the error. Its value
 is supplied by the single item manipulating function.
 
-The ``invalid_data_id`` describes which part of the request caused the error.
+The ``id_of_invalid_data`` describes which part of the request caused the error.
 For create, it is an integer index from the request array (starting from zero),
 for update or delete it is the identifier.
 

pdc/apps/contact/tests.py

@@ -745,7 +745,7 @@ def test_create_with_error(self):
         self.assertEqual(response.data,
                          {'detail': {'email': ['This field is required.']},
                           'invalid_data': {'username': 'Alice'},
-                          'invalid_data_id': 0})
+                          'id_of_invalid_data': 0})
         self.assertNumChanges([])
         self.assertEqual(Person.objects.all().count(), 2)
 
@@ -796,7 +796,7 @@ def test_update_error_bad_data(self):
         self.assertEqual(response.data,
                          {'detail': {'email': ['This field is required.']},
                           'invalid_data': {'username': 'Bob'},
-                          'invalid_data_id': self.mal})
+                          'id_of_invalid_data': self.mal})
         self.assertNumChanges([])
         persons = Person.objects.all()
         self.assertItemsEqual(self.persons, [person.export() for person in persons])
@@ -814,7 +814,7 @@ def test_update_error_not_found(self):
                          {'detail': 'Not found.',
                           'invalid_data': {'username': 'Jim',
                                            'email': 'jim@example.com'},
-                          'invalid_data_id': str(self.non_exist_1)})
+                          'id_of_invalid_data': str(self.non_exist_1)})
         self.assertNumChanges([])
         persons = Person.objects.all()
         self.assertItemsEqual(self.persons, [person.export() for person in persons])
@@ -847,7 +847,7 @@ def test_partial_update_error_bad_data(self):
         self.assertEqual(response.data,
                          {'detail': {'email': ['Enter a valid email address.']},
                           'invalid_data': {'email': 'not-an-email-address'},
-                          'invalid_data_id': self.mal})
+                          'id_of_invalid_data': self.mal})
         self.assertNumChanges([])
         persons = Person.objects.all()
         self.assertItemsEqual(self.persons, [person.export() for person in persons])
@@ -860,7 +860,7 @@ def test_partial_update_error_not_found(self):
         self.assertEqual(response.data,
                          {'detail': 'Not found.',
                           'invalid_data': {'email': 'not-an-email-address'},
-                          'invalid_data_id': str(self.non_exist_1)})
+                          'id_of_invalid_data': str(self.non_exist_1)})
         self.assertNumChanges([])
         persons = Person.objects.all()
         self.assertItemsEqual(self.persons, [person.export() for person in persons])

pdc/apps/release/tests.py

@@ -1623,7 +1623,7 @@ def test_bulk_delete_bad_identifier(self):
         self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
         self.assertEqual(response.data,
                          {'detail': 'Not found.',
-                          'invalid_data_id': '/release-1.0/Client-UID'})
+                          'id_of_invalid_data': '/release-1.0/Client-UID'})
         self.assertEqual(models.Variant.objects.count(), 2)
         self.assertNumChanges([])
 
@@ -1634,5 +1634,5 @@ def test_bulk_partial_update_empty_data(self):
         self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
         self.assertEqual(response.data,
                          {'detail': 'Partial update with no changes does not make much sense.',
-                          'invalid_data_id': 'release-1.0/Server-UID'})
+                          'id_of_invalid_data': 'release-1.0/Server-UID'})
         self.assertNumChanges([])

pdc/apps/repository/tests.py

@@ -581,7 +581,7 @@ def test_create_is_atomic(self):
                                            'content_category': 'binary',
                                            'name': 'repo-1.0-beta-rpms',
                                            'shadow': False},
-                          'invalid_data_id': 1})
+                          'id_of_invalid_data': 1})
         self.assertNumChanges([])
         self.assertEqual(models.Repo.objects.all().count(), 0)