rename ids to include_ids

apache · Jan 27, 2021 · 4c69402 · 4c69402
1 parent 6b2053e
commit 4c69402
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/superset/views/base_api.py b/superset/views/base_api.py
@@ -46,7 +46,7 @@
     "properties": {
         "page_size": {"type": "integer"},
         "page": {"type": "integer"},
-        "ids": {"type": "array", "items": {"type": "integer"}},
+        "include_ids": {"type": "array", "items": {"type": "integer"}},
         "filter": {"type": "string"},
     },
 }
@@ -491,7 +491,7 @@ def related(self, column_name: str, **kwargs: Any) -> FlaskResponse:
         result = self._get_result_from_rows(datamodel, rows, column_name)
 
         # If ids are specified make sure we fetch and include them on the response
-        ids = args.get("ids")
+        ids = args.get("include_ids")
         self._add_extra_ids_to_result(datamodel, column_name, ids, result)
 
         return self.response(200, count=len(result), result=result)

diff --git a/tests/base_api_tests.py b/tests/base_api_tests.py
@@ -225,7 +225,7 @@ def test_get_ids_related_owners(self):
         API: Test get filter related owners
         """
         self.login(username="admin")
-        argument = {"filter": "gamma_sqllab", "ids": [2]}
+        argument = {"filter": "gamma_sqllab", "include_ids": [2]}
         uri = f"api/v1/{self.resource_name}/related/owners?q={prison.dumps(argument)}"
 
         rv = self.client.get(uri)
@@ -244,7 +244,7 @@ def test_get_repeated_ids_related_owners(self):
         API: Test get filter related owners
         """
         self.login(username="admin")
-        argument = {"filter": "gamma_sqllab", "ids": [2, 4]}
+        argument = {"filter": "gamma_sqllab", "include_ids": [2, 4]}
         uri = f"api/v1/{self.resource_name}/related/owners?q={prison.dumps(argument)}"
 
         rv = self.client.get(uri)