Merge pull request #110 from code42/bugfix/search-filter-value-field-type

update search filter value field to accept [str] type

Author: tora-kozic

CHANGELOG.md

@@ -9,6 +9,12 @@
  how a consumer would use the library or CLI tool (e.g. adding unit tests, updating documentation, etc) are not captured
  here.
 
+## 1.1.2 - 2023-12-11
+
+### Fixed
+
+- Saved search filter values can now accept a list of strings.  Prior to this fix this was incorrectly resulting in a model validation error.
+
 ## 1.1.1 - 2023-10-03
 
 ### Fixed

pyproject.toml

@@ -85,7 +85,7 @@ svg = "python docs/example_logging.py"
 
 
 [[tool.hatch.envs.test.matrix]]
-python = ["37", "38", "39", "310","311"]
+python = ["37", "38", "39", "310","311", "312"]
 [tool.hatch.envs.test]
 dependencies = [
   "pytest",
@@ -98,6 +98,7 @@ dependencies = [
   "python-dateutil",
 ]
 [tool.hatch.envs.test.scripts]
+debug = "pytest ./tests/test_file_events.py -s -k saved_search"
 cov = "pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=incydr"
 cov-report = "pytest --cov-report=xml:coverage.xml --cov-config=pyproject.toml --cov=incydr"
 no-cov = "cov --no-cov"

src/_incydr_sdk/__version__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2022-present Code42 Software <integrations@code42.com>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "1.1.1"
+__version__ = "1.1.2"

src/_incydr_sdk/file_events/models/response.py

@@ -1,6 +1,7 @@
 from datetime import datetime
 from typing import List
 from typing import Optional
+from typing import Union
 
 from pydantic import Field
 
@@ -15,7 +16,7 @@ class SearchFilter(ResponseModel):
         example="IS_NOT",
     )
     term: Optional[str] = Field(description="The field to match.", example="user.email")
-    value: Optional[str] = Field(
+    value: Optional[Union[List[str], str]] = Field(
         None, description="The input for the search.", example="ari@example.com"
     )
 

src/_incydr_sdk/utils.py

@@ -174,7 +174,14 @@ class Parent(BaseModel):
     for name, field in model.__fields__.items():
         # the field.shape tells us if the field contains a single `BaseModel` or something like a `List[BaseModel]`
         # we can only traverse singleton models when flattening
-        if issubclass(field.type_, BaseModel) and field.shape == SHAPE_SINGLETON:
+        try:
+            is_subclass = issubclass(field.type_, BaseModel)
+        # TypeError is thrown if field.type_ is a Union type.
+        # Assumes our endpoints won't return a field that can be one of multiple models
+        # This would be a pretty odd API design anyway
+        except TypeError:
+            is_subclass = False
+        if field.shape == SHAPE_SINGLETON and is_subclass:
             for child_name in flatten_fields(field.type_):
                 yield f"{name}.{child_name}"
         else: