From 872e9accdc959e8fc8a400518bb74ba8fb0cf30c Mon Sep 17 00:00:00 2001 From: Cameron Waterman Date: Thu, 26 Jan 2023 06:56:47 -0800 Subject: [PATCH] fix: Fix various documentation issues (#42) --- .../clients/dataframe/_data_frame_client.py | 75 +++++++++++++++++-- 1 file changed, 67 insertions(+), 8 deletions(-) diff --git a/nisystemlink/clients/dataframe/_data_frame_client.py b/nisystemlink/clients/dataframe/_data_frame_client.py index 1d5b9d9..e4f6aae 100644 --- a/nisystemlink/clients/dataframe/_data_frame_client.py +++ b/nisystemlink/clients/dataframe/_data_frame_client.py @@ -17,7 +17,11 @@ 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 +30,14 @@ 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. + + Raises: + ApiException: if unable to communicate with the Data Frame service. + """ ... @get( @@ -60,7 +71,11 @@ 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 + or provided an invalid argument. """ ... @@ -73,6 +88,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. """ ... @@ -84,7 +103,11 @@ 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 + or provided an invalid argument. """ ... @@ -96,7 +119,11 @@ 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 + or provided an invalid argument. """ ... @@ -107,6 +134,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 +147,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 +166,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 +185,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. """ ... @@ -184,7 +227,11 @@ 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 + or provided an invalid argument. """ ... @@ -195,6 +242,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. """ ... @@ -209,7 +260,11 @@ 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 + or provided an invalid argument. """ ... @@ -224,6 +279,10 @@ 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 + or provided an invalid argument. """ ...