fix:PRComments

Author: RSam-NI

examples/file/search_files.py

@@ -5,7 +5,7 @@
 
 from nisystemlink.clients.core import HttpConfiguration
 from nisystemlink.clients.file import FileClient, models
-from nisystemlink.clients.file.models import UpdateMetadataRequest
+from nisystemlink.clients.file.models import SearchFilesOrderBy, UpdateMetadataRequest
 
 # Configure connection to SystemLink server
 server_configuration = HttpConfiguration(
@@ -54,7 +54,7 @@
     filter='name:("search-example*")',
     skip=0,
     take=20,
-    order_by="created",
+    order_by=SearchFilesOrderBy.CREATED,
     order_by_descending=True,
 )
 

nisystemlink/clients/file/models/__init__.py

@@ -1,5 +1,9 @@
 from ._file_metadata import FileMetadata
-from ._file_query_order_by import FileQueryOrderBy, FileLinqQueryOrderBy
+from ._file_query_order_by import (
+    FileQueryOrderBy,
+    FileLinqQueryOrderBy,
+    SearchFilesOrderBy,
+)
 from ._file_query_response import FileQueryResponse
 from ._link import Link
 from ._operations import V1Operations

nisystemlink/clients/file/models/_base_file_request.py

@@ -1,5 +1,7 @@
 from nisystemlink.clients.core._uplink._json_model import JsonModel
 
+from ._file_query_order_by import BaseFileOrderBy
+
 
 class BaseFileRequest(JsonModel):
     """Base class for file request models containing common query parameters."""
@@ -19,6 +21,11 @@ class BaseFileRequest(JsonModel):
     How many files to return in the result.
     """
 
+    order_by: BaseFileOrderBy | None = None
+    """
+    The property by which to order the files in the response.
+    """
+
     order_by_descending: bool | None = False
     """
     Whether to sort in descending order.

nisystemlink/clients/file/models/_file_linq_query.py

@@ -1,11 +1,11 @@
 from nisystemlink.clients.file.models._base_file_request import BaseFileRequest
 from nisystemlink.clients.file.models._base_file_response import BaseFileResponse
-from nisystemlink.clients.file.models._file_query_order_by import FileLinqQueryOrderBy
 
 
 class FileLinqQueryRequest(BaseFileRequest):
-    order_by: FileLinqQueryOrderBy | None = None
-    """The property by which to order the files in the response."""
+    """Request model for LINQ query operations."""
+
+    pass
 
 
 class FileLinqQueryResponse(BaseFileResponse):

nisystemlink/clients/file/models/_file_query_order_by.py

@@ -10,9 +10,27 @@ class FileQueryOrderBy(Enum):
     LAST_UPDATED_TIMESTAMP = "lastUpdatedTimestamp"
 
 
-class FileLinqQueryOrderBy(Enum):
+class BaseFileOrderBy(Enum):
+    """Base enum for file ordering options."""
+
+    pass
+
+
+class FileLinqQueryOrderBy(BaseFileOrderBy):
     """Order Files LINQ Query by Metadata for POST /query-files-linq endpoint."""
 
+    NAME = "name"
+    CREATED = "created"
+    UPDATED = "updated"
+    EXTENSION = "extension"
+    SIZE = "size"
+    WORKSPACE = "workspace"
+
+
+class SearchFilesOrderBy(BaseFileOrderBy):
+    """Order Files Search by Metadata for POST /search-files endpoint."""
+
+    NAME = "name"
     CREATED = "created"
     UPDATED = "updated"
     EXTENSION = "extension"

nisystemlink/clients/file/models/_search_files_request.py

@@ -4,7 +4,4 @@
 class SearchFilesRequest(BaseFileRequest):
     """Request model for searching files."""
 
-    order_by: str | None = None
-    """
-    The name of the metadata field to sort by.
-    """
+    pass

tests/integration/file/test_file_client.py

@@ -13,6 +13,7 @@
 from nisystemlink.clients.file.models import (
     FileLinqQueryOrderBy,
     FileLinqQueryRequest,
+    SearchFilesOrderBy,
     SearchFilesRequest,
     UpdateMetadataRequest,
 )
@@ -319,7 +320,7 @@ def test__search_files__succeeds(
             filter=f'(name: ("{file_prefix}*"))',
             skip=1,
             take=3,
-            order_by="name",
+            order_by=SearchFilesOrderBy.NAME,
             order_by_descending=True,
         )