simple changes

Author: robertMileaNi

docs/api_reference/notebook.rst

@@ -11,7 +11,7 @@ nisystemlink.clients.notebook
    .. automethod:: update_notebook
    .. automethod:: delete_notebook
    .. automethod:: create_notebook
-   .. automethod:: query_notebooks_paged
+   .. automethod:: query_notebooks
    .. automethod:: get_notebook_content
    .. automethod:: create_executions
    .. automethod:: get_execution_by_id

examples/notebook/notebook.py

@@ -41,20 +41,20 @@
 
 # Query notebook by name
 query_request = QueryNotebookRequest(
-    filter="name='Example Notebook'",
+    filter='name="Example Notebook"',
 )
 
-query_response = client.query_notebooks_paged(query_request)
+query_response = client.query_notebooks(query_request)
 
 # Query notebooks by take
 query_request = QueryNotebookRequest(take=2)
-query_response = client.query_notebooks_paged(query_request)
+query_response = client.query_notebooks(query_request)
 
 query_request = QueryNotebookRequest(
     continuation_token=query_response.continuation_token,
     take=1,
 )
-query_response = client.query_notebooks_paged(query_request)
+query_response = client.query_notebooks(query_request)
 
 # Delete the notebook by ID
 client.delete_notebook("your_notebook_id")

nisystemlink/clients/notebook/_notebook_client.py

@@ -184,9 +184,9 @@ def create_notebook(
         )
 
     @post("ninotebook/v1/notebook/query")
-    def query_notebooks_paged(
+    def query_notebooks(
         self, query: models.QueryNotebookRequest
-    ) -> models.QueryNotebookResponse:
+    ) -> models.PagedNotebooks:
         """Queries notebooks.
 
         Args:

nisystemlink/clients/notebook/models/__init__.py

@@ -1,6 +1,6 @@
 from ._notebook_metadata import NotebookMetadata
 from ._query_notebook_request import QueryNotebookRequest
-from ._query_notebook_response import QueryNotebookResponse
+from ._query_notebook_response import PagedNotebooks
 from ._query_execution_request import (
     ExecutionField,
     ExecutionSortField,
@@ -14,7 +14,7 @@
     CreateExecutionRequest,
 )
 from ._create_execution_response import (
-    CreatedExecutionModal,
+    CreatedExecution,
     CreateExecutionsResponse,
 )
 from ._execution import (

nisystemlink/clients/notebook/models/_create_execution_request.py

@@ -34,9 +34,6 @@ class CreateExecutionRequest(JsonModel):
     A value of 0 means do not reuse results from any previous executions. A value of -1 means always reuse results if
     possible and return an error if not possible. This prevents actual execution of a notebook."""
 
-    source: Optional[Source] = None
-    """An object that defines properties set by routine service"""
-
     report_settings: Optional[ReportSettings] = None
     """Settings of the Report"""
 
@@ -49,3 +46,4 @@ class CreateExecutionRequest(JsonModel):
     """Execution priority. Can be one of Low, Medium or High."""
 
     resource_profile: Optional[ExecutionResourceProfile] = None
+    """Resource profile of the execution."""

nisystemlink/clients/notebook/models/_create_execution_response.py

@@ -6,7 +6,7 @@
 from ._execution import Execution
 
 
-class CreatedExecutionModal(Execution):
+class CreatedExecution(Execution):
     cached_result: bool
     """Returns true if the execution is returned from cache"""
 
@@ -15,6 +15,7 @@ class CreateExecutionsResponse(JsonModel):
     """Model for response to a request to create an execution."""
 
     error: Optional[ApiError] = None
+    """The error that occurred during the request, if any."""
 
-    executions: Optional[List[CreatedExecutionModal]] = None
+    executions: Optional[List[CreatedExecution]] = None
     """Gets or sets the collection of authorized executions."""

nisystemlink/clients/notebook/models/_query_execution_response.py

@@ -69,9 +69,6 @@ class QueryExecutionResponse(JsonModel):
     result: Optional[Dict[str, Optional[str]]] = None
     """Result of the execution. This is used only when status is SUCCEEDED."""
 
-    source: Optional[Source] = None
-    """An object that defines properties set by routine service"""
-
     priority: Optional[ExecutionPriority] = None
     """Execution priority. Can be one of Low, Medium or High."""
 

nisystemlink/clients/notebook/models/_query_notebook_response.py

@@ -5,7 +5,7 @@
 from ._notebook_metadata import NotebookMetadata
 
 
-class QueryNotebookResponse(WithPaging):
+class PagedNotebooks(WithPaging):
     """Model for a query notebooks response."""
 
     notebooks: Optional[List[NotebookMetadata]] = None

tests/integration/notebook/test_notebook_client.py

@@ -209,7 +209,7 @@ def test__query_notebook_by_id__return_notebook_matches_id(
 
         request = QueryNotebookRequest(filter=f'id="{notebook.id}"')
         print(request)
-        response = client.query_notebooks_paged(request)
+        response = client.query_notebooks(request)
 
         assert response.notebooks is not None
         assert len(response.notebooks) == 1
@@ -219,7 +219,7 @@ def test__query_notebook_by_id__return_notebook_matches_id(
 
     def test__query_notebook_by_invalid_id__returns_empty_list(self, client):
         request = QueryNotebookRequest(filter='id="invalid_id"')
-        response = client.query_notebooks_paged(request)
+        response = client.query_notebooks(request)
 
         assert len(response.notebooks) == 0
         assert response.continuation_token is None
@@ -231,7 +231,7 @@ def test__query_notebook_by_name__returns_notebook_matches_name(
         notebook = create_notebook(metadata=metadata)
 
         request = QueryNotebookRequest(filter=f'name.StartsWith("{random_filename}")')
-        response = client.query_notebooks_paged(request)
+        response = client.query_notebooks(request)
 
         assert len(response.notebooks) == 1
         assert response.continuation_token is None
@@ -240,14 +240,14 @@ def test__query_notebook_by_name__returns_notebook_matches_name(
 
     def test__query_notebook_by_invalid_name__returns_empty_list(self, client):
         request = QueryNotebookRequest(filter='name="invalid_name"')
-        response = client.query_notebooks_paged(request)
+        response = client.query_notebooks(request)
 
         assert len(response.notebooks) == 0
         assert response.continuation_token is None
 
     def test__query_by_taking_3_notebooks__returns_3_notebooks(self, client):
         request = QueryNotebookRequest(take=3)
-        response = client.query_notebooks_paged(request)
+        response = client.query_notebooks(request)
 
         assert len(response.notebooks) == 3
         assert response.continuation_token is not None
@@ -256,13 +256,13 @@ def test__query_notebooks_by_continuation_token__returns_next_page_of_notebooks(
         self, client
     ):
         request = QueryNotebookRequest(take=3)
-        response = client.query_notebooks_paged(request)
+        response = client.query_notebooks(request)
 
         assert len(response.notebooks) == 3
         assert response.continuation_token is not None
 
         request.continuation_token = response.continuation_token
-        response = client.query_notebooks_paged(request)
+        response = client.query_notebooks(request)
 
         assert len(response.notebooks) != 0
         assert response.continuation_token is not None
@@ -627,11 +627,11 @@ def test__query_executions_by_projection__returns_executions_with_projected_prop
                 "status": "IN_PROGRESS",
             },
             {
-                "id": "execution_id_1",
+                "id": "execution_id_2",
                 "status": "TIMED_OUT",
             },
             {
-                "id": "execution_id_1",
+                "id": "execution_id_3",
                 "status": "FAILED",
             },
         ]