From f0e8b38cc3b40dcc17d9ba801db106dcf81f75f2 Mon Sep 17 00:00:00 2001 From: Cameron Waterman Date: Mon, 23 Jan 2023 13:05:45 -0600 Subject: [PATCH 01/10] First pass --- .../clients/dataframe/_data_frame_client.py | 62 ++++++++++++++++++- 1 file changed, 60 insertions(+), 2 deletions(-) diff --git a/nisystemlink/clients/dataframe/_data_frame_client.py b/nisystemlink/clients/dataframe/_data_frame_client.py index 1d5b9d9..b7a6176 100644 --- a/nisystemlink/clients/dataframe/_data_frame_client.py +++ b/nisystemlink/clients/dataframe/_data_frame_client.py @@ -17,7 +17,10 @@ def __init__(self, configuration: Optional[core.HttpConfiguration] = None): Args: configuration: Defines the web server to connect to and information about how to connect. If not provided, an instance of - :class:`core.JupyterHttpConfiguration` is used. + :class:`JupyterHttpConfiguration` is used. + + Raises: + ApiException: If unable to communicate with the Data Frame service. """ if configuration is None: configuration = core.JupyterHttpConfiguration() @@ -26,7 +29,14 @@ def __init__(self, configuration: Optional[core.HttpConfiguration] = None): @get("") def api_info(self) -> models.ApiInfo: - """Returns information about available API operations.""" + """Returns information about available API operations. + + Returns: + models.ApiInfo: Information about available API operations. + + Raises: + ApiException: If unable to communicate with the Data Frame service. + """ ... @get( @@ -61,6 +71,10 @@ def list_tables( Returns: models.PagedTables: The list of tables with a continuation token. + + Raises: + ApiException: If unable to communicate with the Data Frame service + or provided an invalid argument. """ ... @@ -73,6 +87,10 @@ def create_table(self, table: models.CreateTableRequest) -> str: Returns: The ID of the newly created table. + + Raises: + ApiException: If unable to communicate with the Data Frame service + or provided an invalid argument. """ ... @@ -85,6 +103,10 @@ def query_tables(self, query: models.QueryTablesRequest) -> models.PagedTables: Returns: models.PagedTables: The list of tables with a continuation token. + + Raises: + ApiException: If unable to communicate with the Data Frame service + or provided an invalid argument. """ ... @@ -97,6 +119,10 @@ def get_table_metadata(self, id: str) -> models.TableMetadata: Returns: models.TableMetadata: The metadata for the table. + + Raises: + ApiException: If unable to communicate with the Data Frame service + or provided an invalid argument. """ ... @@ -107,6 +133,10 @@ def modify_table(self, id: str, update: models.ModifyTableRequest) -> None: Args: id: Unique ID of a DataFrame table. update: The metadata to update. + + Raises: + ApiException: If unable to communicate with the Data Frame service + or provided an invalid argument. """ ... @@ -116,6 +146,10 @@ def delete_table(self, id: str) -> None: Args: id (str): Unique ID of a DataFrame table. + + Raises: + ApiException: If unable to communicate with the Data Frame service + or provided an invalid argument. """ ... @@ -131,6 +165,10 @@ def delete_tables( Returns: A partial success if any tables failed to delete, or None if all tables were deleted successfully. + + Raises: + ApiException: If unable to communicate with the Data Frame service + or provided an invalid argument. """ ... @@ -146,6 +184,10 @@ def modify_tables( Returns: A partial success if any tables failed to be modified, or None if all tables were modified successfully. + + Raises: + ApiException: If unable to communicate with the Data Frame service + or provided an invalid argument. """ ... @@ -185,6 +227,10 @@ def get_table_data( Returns: models.PagedTableRows: The table data and total number of rows with a continuation token. + + Raises: + ApiException: If unable to communicate with the Data Frame service + or provided an invalid argument. """ ... @@ -195,6 +241,10 @@ def append_table_data(self, id: str, data: models.AppendTableDataRequest) -> Non Args: id: Unique ID of a DataFrame table. data: The rows of data to append and any additional options. + + Raises: + ApiException: If unable to communicate with the Data Frame service + or provided an invalid argument. """ ... @@ -210,6 +260,10 @@ def query_table_data( Returns: models.PagedTableRows: The table data and total number of rows with a continuation token. + + Raises: + ApiException: If unable to communicate with the Data Frame service + or provided an invalid argument. """ ... @@ -225,5 +279,9 @@ def query_decimated_data( Returns: models.TableRows: The decimated table data. + + Raises: + ApiException: If unable to communicate with the Data Frame service + or provided an invalid argument. """ ... From 486145a64a3a8bea401fbe7980435d61daa162d7 Mon Sep 17 00:00:00 2001 From: Cameron Waterman Date: Mon, 23 Jan 2023 13:22:46 -0600 Subject: [PATCH 02/10] Fix return type --- nisystemlink/clients/dataframe/_data_frame_client.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/nisystemlink/clients/dataframe/_data_frame_client.py b/nisystemlink/clients/dataframe/_data_frame_client.py index b7a6176..4d5e21a 100644 --- a/nisystemlink/clients/dataframe/_data_frame_client.py +++ b/nisystemlink/clients/dataframe/_data_frame_client.py @@ -32,7 +32,7 @@ def api_info(self) -> models.ApiInfo: """Returns information about available API operations. Returns: - models.ApiInfo: Information about available API operations. + Information about available API operations. Raises: ApiException: If unable to communicate with the Data Frame service. @@ -70,7 +70,7 @@ def list_tables( workspace: List of workspace IDs to filter by. Returns: - models.PagedTables: The list of tables with a continuation token. + The list of tables with a continuation token. Raises: ApiException: If unable to communicate with the Data Frame service From 6ec730e7e728182910e48bc38598561381f9998c Mon Sep 17 00:00:00 2001 From: Cameron Waterman Date: Mon, 23 Jan 2023 13:50:25 -0600 Subject: [PATCH 03/10] Fix return types --- nisystemlink/clients/dataframe/_data_frame_client.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/nisystemlink/clients/dataframe/_data_frame_client.py b/nisystemlink/clients/dataframe/_data_frame_client.py index 4d5e21a..d8493af 100644 --- a/nisystemlink/clients/dataframe/_data_frame_client.py +++ b/nisystemlink/clients/dataframe/_data_frame_client.py @@ -102,7 +102,7 @@ def query_tables(self, query: models.QueryTablesRequest) -> models.PagedTables: query: The request to query tables. Returns: - models.PagedTables: The list of tables with a continuation token. + The list of tables with a continuation token. Raises: ApiException: If unable to communicate with the Data Frame service @@ -118,7 +118,7 @@ def get_table_metadata(self, id: str) -> models.TableMetadata: id (str): Unique ID of a DataFrame table. Returns: - models.TableMetadata: The metadata for the table. + The metadata for the table. Raises: ApiException: If unable to communicate with the Data Frame service @@ -226,7 +226,7 @@ def get_table_data( continuation_token: The token used to paginate results. Returns: - models.PagedTableRows: The table data and total number of rows with a continuation token. + The table data and total number of rows with a continuation token. Raises: ApiException: If unable to communicate with the Data Frame service @@ -259,7 +259,7 @@ def query_table_data( query: The filtering and sorting to apply when reading data. Returns: - models.PagedTableRows: The table data and total number of rows with a continuation token. + The table data and total number of rows with a continuation token. Raises: ApiException: If unable to communicate with the Data Frame service @@ -278,7 +278,7 @@ def query_decimated_data( query: The filtering and decimation options to apply when reading data. Returns: - models.TableRows: The decimated table data. + The decimated table data. Raises: ApiException: If unable to communicate with the Data Frame service From 62f06b71a00469edc4b1e342d66dc730a939c6ff Mon Sep 17 00:00:00 2001 From: Cameron Waterman Date: Mon, 23 Jan 2023 13:51:19 -0600 Subject: [PATCH 04/10] Format --- nisystemlink/clients/dataframe/_data_frame_client.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nisystemlink/clients/dataframe/_data_frame_client.py b/nisystemlink/clients/dataframe/_data_frame_client.py index d8493af..cea0539 100644 --- a/nisystemlink/clients/dataframe/_data_frame_client.py +++ b/nisystemlink/clients/dataframe/_data_frame_client.py @@ -33,7 +33,7 @@ def api_info(self) -> models.ApiInfo: Returns: Information about available API operations. - + Raises: ApiException: If unable to communicate with the Data Frame service. """ From 75e3161a6f7987f270faa93c200a44a5d6ac1b2a Mon Sep 17 00:00:00 2001 From: Cameron Waterman Date: Mon, 23 Jan 2023 13:57:04 -0600 Subject: [PATCH 05/10] Fix JupyterHttpConfiguration link --- nisystemlink/clients/dataframe/_data_frame_client.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/nisystemlink/clients/dataframe/_data_frame_client.py b/nisystemlink/clients/dataframe/_data_frame_client.py index cea0539..6e27dbd 100644 --- a/nisystemlink/clients/dataframe/_data_frame_client.py +++ b/nisystemlink/clients/dataframe/_data_frame_client.py @@ -17,7 +17,7 @@ def __init__(self, configuration: Optional[core.HttpConfiguration] = None): Args: configuration: Defines the web server to connect to and information about how to connect. If not provided, an instance of - :class:`JupyterHttpConfiguration` is used. + :class:`~core.JupyterHttpConfiguration` is used. Raises: ApiException: If unable to communicate with the Data Frame service. @@ -29,7 +29,7 @@ def __init__(self, configuration: Optional[core.HttpConfiguration] = None): @get("") def api_info(self) -> models.ApiInfo: - """Returns information about available API operations. + """Get information about available API operations. Returns: Information about available API operations. From fd9ae07224559f401c292b3422f310a3f6d3c7fa Mon Sep 17 00:00:00 2001 From: Cameron Waterman Date: Mon, 23 Jan 2023 14:00:53 -0600 Subject: [PATCH 06/10] Attempt to fix link --- nisystemlink/clients/dataframe/_data_frame_client.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nisystemlink/clients/dataframe/_data_frame_client.py b/nisystemlink/clients/dataframe/_data_frame_client.py index 6e27dbd..01621a8 100644 --- a/nisystemlink/clients/dataframe/_data_frame_client.py +++ b/nisystemlink/clients/dataframe/_data_frame_client.py @@ -17,7 +17,7 @@ def __init__(self, configuration: Optional[core.HttpConfiguration] = None): Args: configuration: Defines the web server to connect to and information about how to connect. If not provided, an instance of - :class:`~core.JupyterHttpConfiguration` is used. + :class:`JupyterHttpConfiguration ` is used. Raises: ApiException: If unable to communicate with the Data Frame service. From 42481f36762f43d9fb280447ecd5090dc42b577e Mon Sep 17 00:00:00 2001 From: Cameron Waterman Date: Mon, 23 Jan 2023 14:04:44 -0600 Subject: [PATCH 07/10] Use fully qualified path --- nisystemlink/clients/dataframe/_data_frame_client.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nisystemlink/clients/dataframe/_data_frame_client.py b/nisystemlink/clients/dataframe/_data_frame_client.py index 01621a8..108df92 100644 --- a/nisystemlink/clients/dataframe/_data_frame_client.py +++ b/nisystemlink/clients/dataframe/_data_frame_client.py @@ -17,7 +17,7 @@ def __init__(self, configuration: Optional[core.HttpConfiguration] = None): Args: configuration: Defines the web server to connect to and information about how to connect. If not provided, an instance of - :class:`JupyterHttpConfiguration ` is used. + :class:`nisystemlink.clients.core.JupyterHttpConfiguration` is used. Raises: ApiException: If unable to communicate with the Data Frame service. From 27ceee0a177fa7e686a0b2c8018ed7e0b219e90c Mon Sep 17 00:00:00 2001 From: Cameron Waterman Date: Mon, 23 Jan 2023 14:07:04 -0600 Subject: [PATCH 08/10] Shorten link --- nisystemlink/clients/dataframe/_data_frame_client.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nisystemlink/clients/dataframe/_data_frame_client.py b/nisystemlink/clients/dataframe/_data_frame_client.py index 108df92..85668b2 100644 --- a/nisystemlink/clients/dataframe/_data_frame_client.py +++ b/nisystemlink/clients/dataframe/_data_frame_client.py @@ -17,7 +17,7 @@ def __init__(self, configuration: Optional[core.HttpConfiguration] = None): Args: configuration: Defines the web server to connect to and information about how to connect. If not provided, an instance of - :class:`nisystemlink.clients.core.JupyterHttpConfiguration` is used. + :class:`~nisystemlink.clients.core.JupyterHttpConfiguration` is used. Raises: ApiException: If unable to communicate with the Data Frame service. From 888863c461ef4818b94f59ac61124081305966f5 Mon Sep 17 00:00:00 2001 From: Cameron Waterman Date: Mon, 23 Jan 2023 14:10:18 -0600 Subject: [PATCH 09/10] Use explicit title for link --- nisystemlink/clients/dataframe/_data_frame_client.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/nisystemlink/clients/dataframe/_data_frame_client.py b/nisystemlink/clients/dataframe/_data_frame_client.py index 85668b2..465174c 100644 --- a/nisystemlink/clients/dataframe/_data_frame_client.py +++ b/nisystemlink/clients/dataframe/_data_frame_client.py @@ -17,7 +17,8 @@ def __init__(self, configuration: Optional[core.HttpConfiguration] = None): Args: configuration: Defines the web server to connect to and information about how to connect. If not provided, an instance of - :class:`~nisystemlink.clients.core.JupyterHttpConfiguration` is used. + :class:`JupyterHttpConfiguration ` + is used. Raises: ApiException: If unable to communicate with the Data Frame service. From 1027f4f9a1c3d3558683fbb1d07337c0d7923ed0 Mon Sep 17 00:00:00 2001 From: Cameron Waterman Date: Wed, 25 Jan 2023 11:23:09 -0600 Subject: [PATCH 10/10] If -> if --- .../clients/dataframe/_data_frame_client.py | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/nisystemlink/clients/dataframe/_data_frame_client.py b/nisystemlink/clients/dataframe/_data_frame_client.py index 465174c..e4f6aae 100644 --- a/nisystemlink/clients/dataframe/_data_frame_client.py +++ b/nisystemlink/clients/dataframe/_data_frame_client.py @@ -21,7 +21,7 @@ def __init__(self, configuration: Optional[core.HttpConfiguration] = None): is used. Raises: - ApiException: If unable to communicate with the Data Frame service. + ApiException: if unable to communicate with the Data Frame service. """ if configuration is None: configuration = core.JupyterHttpConfiguration() @@ -36,7 +36,7 @@ def api_info(self) -> models.ApiInfo: Information about available API operations. Raises: - ApiException: If unable to communicate with the Data Frame service. + ApiException: if unable to communicate with the Data Frame service. """ ... @@ -74,7 +74,7 @@ def list_tables( The list of tables with a continuation token. Raises: - ApiException: If unable to communicate with the Data Frame service + ApiException: if unable to communicate with the Data Frame service or provided an invalid argument. """ ... @@ -90,7 +90,7 @@ def create_table(self, table: models.CreateTableRequest) -> str: The ID of the newly created table. Raises: - ApiException: If unable to communicate with the Data Frame service + ApiException: if unable to communicate with the Data Frame service or provided an invalid argument. """ ... @@ -106,7 +106,7 @@ def query_tables(self, query: models.QueryTablesRequest) -> models.PagedTables: The list of tables with a continuation token. Raises: - ApiException: If unable to communicate with the Data Frame service + ApiException: if unable to communicate with the Data Frame service or provided an invalid argument. """ ... @@ -122,7 +122,7 @@ def get_table_metadata(self, id: str) -> models.TableMetadata: The metadata for the table. Raises: - ApiException: If unable to communicate with the Data Frame service + ApiException: if unable to communicate with the Data Frame service or provided an invalid argument. """ ... @@ -136,7 +136,7 @@ def modify_table(self, id: str, update: models.ModifyTableRequest) -> None: update: The metadata to update. Raises: - ApiException: If unable to communicate with the Data Frame service + ApiException: if unable to communicate with the Data Frame service or provided an invalid argument. """ ... @@ -149,7 +149,7 @@ def delete_table(self, id: str) -> None: id (str): Unique ID of a DataFrame table. Raises: - ApiException: If unable to communicate with the Data Frame service + ApiException: if unable to communicate with the Data Frame service or provided an invalid argument. """ ... @@ -168,7 +168,7 @@ def delete_tables( tables were deleted successfully. Raises: - ApiException: If unable to communicate with the Data Frame service + ApiException: if unable to communicate with the Data Frame service or provided an invalid argument. """ ... @@ -187,7 +187,7 @@ def modify_tables( tables were modified successfully. Raises: - ApiException: If unable to communicate with the Data Frame service + ApiException: if unable to communicate with the Data Frame service or provided an invalid argument. """ ... @@ -230,7 +230,7 @@ def get_table_data( The table data and total number of rows with a continuation token. Raises: - ApiException: If unable to communicate with the Data Frame service + ApiException: if unable to communicate with the Data Frame service or provided an invalid argument. """ ... @@ -244,7 +244,7 @@ def append_table_data(self, id: str, data: models.AppendTableDataRequest) -> Non data: The rows of data to append and any additional options. Raises: - ApiException: If unable to communicate with the Data Frame service + ApiException: if unable to communicate with the Data Frame service or provided an invalid argument. """ ... @@ -263,7 +263,7 @@ def query_table_data( The table data and total number of rows with a continuation token. Raises: - ApiException: If unable to communicate with the Data Frame service + ApiException: if unable to communicate with the Data Frame service or provided an invalid argument. """ ... @@ -282,7 +282,7 @@ def query_decimated_data( The decimated table data. Raises: - ApiException: If unable to communicate with the Data Frame service + ApiException: if unable to communicate with the Data Frame service or provided an invalid argument. """ ...