Expose exclude_fields in the REST API schema

CHANGES/5519.feature

@@ -0,0 +1 @@
+Expose `exclude_fields` the api schema and bindings to allow users to filter out fields.

CHANGES/5519.removal

@@ -0,0 +1 @@
+Renamed `fields!` to `exclude_fields` since exclamation mark is a special char in many languages.

pulpcore/app/openapigenerator.py

@@ -274,6 +274,14 @@ def get_operation(self, operation_keys):
                 type="string",
             )
             query.append(fields_paramenter)
+            not_fields_paramenter = Parameter(
+                name="exclude_fields",
+                in_="query",
+                description="A list of fields to exclude from the response.",
+                required=False,
+                type="string",
+            )
+            query.append(not_fields_paramenter)
         parameters = body + query
         parameters = filter_none(parameters)
         parameters = self.add_manual_parameters(parameters)

pulpcore/app/serializers/base.py

@@ -31,6 +31,9 @@ class ModelSerializer(QueryFieldsMixin, serializers.HyperlinkedModelSerializer):
     This ensures that all Serializers provide values for the '_href` field.
     """
 
+    # default is 'fields!' which doesn't work in the bindings for some langs
+    exclude_arg_name = "exclude_fields"
+
     class Meta:
         fields = ('_href', '_created')
 

pulpcore/tests/functional/api/test_crud_repos.py

@@ -76,7 +76,7 @@ def test_02_read_repo_with_specific_fields(self):
     def test_02_read_repo_without_specific_fields(self):
         """Read a repo by its href excluding specific fields."""
         # requests doesn't allow the use of != in parameters.
-        url = '{}?fields!=created,name'.format(self.repo['_href'])
+        url = '{}?exclude_fields=created,name'.format(self.repo['_href'])
         repo = self.client.get(url)
         response_fields = repo.keys()
         self.assertNotIn('created', response_fields)

pulpcore/tests/functional/api/test_tasks.py

@@ -66,7 +66,7 @@ def test_02_read_href_with_specific_fields(self):
     def test_02_read_task_without_specific_fields(self):
         """Read a task by its href excluding specific fields."""
         # requests doesn't allow the use of != in parameters.
-        url = '{}?fields!=state'.format(self.task['_href'])
+        url = '{}?exclude_fields=state'.format(self.task['_href'])
         task = self.client.get(url)
         self.assertNotIn('state', task.keys())
 

pulpcore/tests/functional/api/using_plugin/test_crd_publications.py

@@ -85,7 +85,7 @@ def test_02_read_publication_with_specific_fields(self):
     def test_02_read_publication_without_specific_fields(self):
         """Read a publication by its href excluding specific fields."""
         # requests doesn't allow the use of != in parameters.
-        url = '{}?fields!=distributions'.format(self.publication['_href'])
+        url = '{}?exclude_fields=distributions'.format(self.publication['_href'])
         publication = self.client.get(url)
         self.assertNotIn('distributions', publication.keys())