Release 1.67.1 Added REST Pure1-1.5

Author: fa-ui-bot

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "py-pure-client"
-version = "1.67.0"
+version = "1.67.1"
 description = "Pure Storage Python clients for FlashArray, FlashBlade, and Pure1 APIs"
 authors = [
     { name = "Pure Storage", email = "support@purestorage.com" }

pypureclient/_version.py

@@ -1,3 +1,3 @@
 __name__ = 'py-pure-client'
-__version__ = '1.67.0'
+__version__ = '1.67.1'
 __default_user_agent__ = 'pure/{}/{}'.format(__name__, __version__)

pypureclient/flasharray/FA_2_0/api/authorization_api.py

@@ -26,6 +26,7 @@
 from pypureclient.flasharray.FA_2_0.models.api_version_response import ApiVersionResponse
 from pypureclient.flasharray.FA_2_0.models.oauth_token_response import OauthTokenResponse
 from pypureclient.flasharray.FA_2_0.models.username_response import UsernameResponse
+from typing import Optional
 from pypureclient.flasharray.FA_2_0.api_client import ApiClient as _TransportApiClient
 from pypureclient.flasharray.FA_2_0.api_response import ApiResponse
 from pypureclient.flasharray.FA_2_0.exceptions import (  # noqa: F401
@@ -50,14 +51,9 @@ def api20_login_post_with_http_info(
         x_request_id: Annotated[Optional[StrictStr], Field(description="Supplied by client during request or generated by server.")] = None,
         **kwargs
     ) -> ApiResponse:  # noqa: E501
-        """POST login (placeholder)  # noqa: E501
-
-        Exchange an API token for a session token.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
+        """POST login (placeholder)
 
-        >>> thread = api.api20_login_post_with_http_info(api_token, x_request_id, async_req=True)
-        >>> result = thread.get()
+        Exchange an API token for a session token.
 
         :param api_token: API token for a user.
         :type api_token: str
@@ -170,14 +166,9 @@ def api20_logout_post_with_http_info(
         x_request_id: Annotated[Optional[StrictStr], Field(description="Supplied by client during request or generated by server.")] = None,
         **kwargs
     ) -> ApiResponse:  # noqa: E501
-        """POST logout (placeholder)  # noqa: E501
-
-        Invalidate a session token.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
+        """POST logout (placeholder)
 
-        >>> thread = api.api20_logout_post_with_http_info(x_auth_token, x_request_id, async_req=True)
-        >>> result = thread.get()
+        Invalidate a session token.
 
         :param x_auth_token: Session token for a user.
         :type x_auth_token: str
@@ -283,14 +274,9 @@ def api_api_version_get_with_http_info(
         x_request_id: Annotated[Optional[StrictStr], Field(description="Supplied by client during request or generated by server.")] = None,
         **kwargs
     ) -> ApiResponse:  # noqa: E501
-        """List available API versions  # noqa: E501
+        """List available API versions
 
-        Returns a list of available API versions. No authentication is required to access this endpoint.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-
-        >>> thread = api.api_api_version_get_with_http_info(x_request_id, async_req=True)
-        >>> result = thread.get()
+        Returns a list of available API versions. No authentication is required to access this endpoint.
 
         :param x_request_id: Supplied by client during request or generated by server.
         :type x_request_id: str
@@ -399,14 +385,9 @@ def oauth210_token_post_with_http_info(
         x_request_id: Annotated[Optional[StrictStr], Field(description="Supplied by client during request or generated by server.")] = None,
         **kwargs
     ) -> ApiResponse:  # noqa: E501
-        """Get access token  # noqa: E501
-
-        Exchanges an ID Token for an OAuth 2.0 access token.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
+        """Get access token
 
-        >>> thread = api.oauth210_token_post_with_http_info(grant_type, subject_token, subject_token_type, x_request_id, async_req=True)
-        >>> result = thread.get()
+        Exchanges an ID Token for an OAuth 2.0 access token.
 
         :param grant_type: The method by which the access token will be obtained. The Pure Storage REST API supports the OAuth 2.0 \\\"token exchange\\\" grant type, which indicates that a token exchange is being performed. Set `grant_type` to `urn:ietf:params:oauth:grant-type:token-exchange`. (required)
         :type grant_type: str

pypureclient/flasharray/FA_2_0/api/connections_api.py

@@ -26,6 +26,7 @@
 from pypureclient.flasharray.FA_2_0.models.connection_get_response import ConnectionGetResponse
 from pypureclient.flasharray.FA_2_0.models.connection_post import ConnectionPost
 from pypureclient.flasharray.FA_2_0.models.connection_response import ConnectionResponse
+from typing import Optional
 from pypureclient.flasharray.FA_2_0.api_client import ApiClient as _TransportApiClient
 from pypureclient.flasharray.FA_2_0.api_response import ApiResponse
 from pypureclient.flasharray.FA_2_0.exceptions import (  # noqa: F401
@@ -53,14 +54,9 @@ def api20_connections_delete_with_http_info(
         volume_names: Annotated[Optional[conlist(StrictStr)], Field(description="Performs the operation on the volume specified. Enter multiple names in comma-separated format. For example, `vol01,vol02`. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple volume names and host names; instead, at least one of the objects (e.g., `volume_names`) must be set to only one name (e.g., `vol01`).")] = None,
         **kwargs
     ) -> ApiResponse:  # noqa: E501
-        """Break a connection between a volume and its host or host group  # noqa: E501
-
-        Break the connection between a volume and its associated host or host group. The `volume_names` and `host_names` or `host_group_names` query parameters are required.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
+        """Break a connection between a volume and its host or host group
 
-        >>> thread = api.api20_connections_delete_with_http_info(authorization, x_request_id, host_group_names, host_names, volume_names, async_req=True)
-        >>> result = thread.get()
+        Break the connection between a volume and its associated host or host group. The `volume_names` and `host_names` or `host_group_names` query parameters are required.
 
         :param authorization: Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
         :type authorization: str
@@ -197,14 +193,9 @@ def api20_connections_get_with_http_info(
         volume_names: Annotated[Optional[conlist(StrictStr)], Field(description="Performs the operation on the volume specified. Enter multiple names in comma-separated format. For example, `vol01,vol02`. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple volume names and host names; instead, at least one of the objects (e.g., `volume_names`) must be set to only one name (e.g., `vol01`).")] = None,
         **kwargs
     ) -> ApiResponse:  # noqa: E501
-        """List volume connections  # noqa: E501
+        """List volume connections
 
-        Return a list of connections between a volume and its hosts and host groups, and the LUNs used by the associated hosts to address these volumes.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-
-        >>> thread = api.api20_connections_get_with_http_info(authorization, x_request_id, filter, host_group_names, host_names, limit, offset, protocol_endpoint_names, sort, total_item_count, volume_names, async_req=True)
-        >>> result = thread.get()
+        Return a list of connections between a volume and its hosts and host groups, and the LUNs used by the associated hosts to address these volumes.
 
         :param authorization: Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
         :type authorization: str
@@ -380,14 +371,9 @@ def api20_connections_post_with_http_info(
         connection: Optional[ConnectionPost] = None,
         **kwargs
     ) -> ApiResponse:  # noqa: E501
-        """Create a connection between a volume and host or host group  # noqa: E501
-
-        Create a connection between a volume and a host or host group. The `volume_names` and `host_names` or `host_group_names` query parameters are required.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
+        """Create a connection between a volume and host or host group
 
-        >>> thread = api.api20_connections_post_with_http_info(authorization, x_request_id, host_group_names, host_names, volume_names, connection, async_req=True)
-        >>> result = thread.get()
+        Create a connection between a volume and a host or host group. The `volume_names` and `host_names` or `host_group_names` query parameters are required.
 
         :param authorization: Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
         :type authorization: str

pypureclient/flasharray/FA_2_0/api/host_groups_api.py

@@ -29,6 +29,7 @@
 from pypureclient.flasharray.FA_2_0.models.member_no_id_all_get_response import MemberNoIdAllGetResponse
 from pypureclient.flasharray.FA_2_0.models.resource_performance_no_id_by_array_get_response import ResourcePerformanceNoIdByArrayGetResponse
 from pypureclient.flasharray.FA_2_0.models.resource_performance_no_id_get_response import ResourcePerformanceNoIdGetResponse
+from typing import Optional
 from pypureclient.flasharray.FA_2_0.api_client import ApiClient as _TransportApiClient
 from pypureclient.flasharray.FA_2_0.api_response import ApiResponse
 from pypureclient.flasharray.FA_2_0.exceptions import (  # noqa: F401
@@ -54,14 +55,9 @@ def api20_host_groups_delete_with_http_info(
         names: Annotated[Optional[conlist(StrictStr)], Field(description="Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.")] = None,
         **kwargs
     ) -> ApiResponse:  # noqa: E501
-        """Delete a host group  # noqa: E501
-
-        Delete a host group. The `names` query parameter is required.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
+        """Delete a host group
 
-        >>> thread = api.api20_host_groups_delete_with_http_info(authorization, x_request_id, names, async_req=True)
-        >>> result = thread.get()
+        Delete a host group. The `names` query parameter is required.
 
         :param authorization: Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
         :type authorization: str
@@ -181,14 +177,9 @@ def api20_host_groups_get_with_http_info(
         total_item_count: Annotated[Optional[StrictBool], Field(description="If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.")] = None,
         **kwargs
     ) -> ApiResponse:  # noqa: E501
-        """List host groups  # noqa: E501
+        """List host groups
 
-        Return a list of host groups.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-
-        >>> thread = api.api20_host_groups_get_with_http_info(authorization, x_request_id, filter, limit, names, offset, sort, total_item_count, async_req=True)
-        >>> result = thread.get()
+        Return a list of host groups.
 
         :param authorization: Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
         :type authorization: str
@@ -346,14 +337,9 @@ def api20_host_groups_hosts_get_with_http_info(
         total_item_count: Annotated[Optional[StrictBool], Field(description="If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.")] = None,
         **kwargs
     ) -> ApiResponse:  # noqa: E501
-        """List host groups associated with hosts  # noqa: E501
-
-        Returns a list of host groups that are associated with hosts.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
+        """List host groups associated with hosts
 
-        >>> thread = api.api20_host_groups_hosts_get_with_http_info(authorization, x_request_id, filter, group_names, limit, member_names, offset, sort, total_item_count, async_req=True)
-        >>> result = thread.get()
+        Returns a list of host groups that are associated with hosts.
 
         :param authorization: Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
         :type authorization: str
@@ -513,14 +499,9 @@ def api20_host_groups_patch_with_http_info(
         names: Annotated[Optional[conlist(StrictStr)], Field(description="Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.")] = None,
         **kwargs
     ) -> ApiResponse:  # noqa: E501
-        """Manage a host group  # noqa: E501
+        """Manage a host group
 
-        Manage a host group. The `names` query parameter is required.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-
-        >>> thread = api.api20_host_groups_patch_with_http_info(host_group, authorization, x_request_id, names, async_req=True)
-        >>> result = thread.get()
+        Manage a host group. The `names` query parameter is required.
 
         :param host_group: (required)
         :type host_group: HostGroupPatch
@@ -660,14 +641,9 @@ def api20_host_groups_performance_by_array_get_with_http_info(
         total_only: Annotated[Optional[StrictBool], Field(description="If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.")] = None,
         **kwargs
     ) -> ApiResponse:  # noqa: E501
-        """List host group performance data by array  # noqa: E501
-
-        Return real-time and historical performance data, real-time latency data, and average I/O size data. The data returned is for each volume that is connected to a host group on the current array and for each volume that is connected to a host group on any remote arrays that are visible to the current array. The data is displayed as a total across all host groups on each array and by individual host group.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
+        """List host group performance data by array
 
-        >>> thread = api.api20_host_groups_performance_by_array_get_with_http_info(authorization, x_request_id, filter, limit, names, offset, sort, total_item_count, total_only, async_req=True)
-        >>> result = thread.get()
+        Return real-time and historical performance data, real-time latency data, and average I/O size data. The data returned is for each volume that is connected to a host group on the current array and for each volume that is connected to a host group on any remote arrays that are visible to the current array. The data is displayed as a total across all host groups on each array and by individual host group.
 
         :param authorization: Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
         :type authorization: str
@@ -831,14 +807,9 @@ def api20_host_groups_performance_get_with_http_info(
         total_only: Annotated[Optional[StrictBool], Field(description="If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.")] = None,
         **kwargs
     ) -> ApiResponse:  # noqa: E501
-        """List host group performance data  # noqa: E501
+        """List host group performance data
 
-        Return real-time and historical performance data, real-time latency data, and average I/O sizes across all volumes, displayed both by host group and as a total across all host groups.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-
-        >>> thread = api.api20_host_groups_performance_get_with_http_info(authorization, x_request_id, filter, limit, names, offset, sort, total_item_count, total_only, async_req=True)
-        >>> result = thread.get()
+        Return real-time and historical performance data, real-time latency data, and average I/O sizes across all volumes, displayed both by host group and as a total across all host groups.
 
         :param authorization: Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
         :type authorization: str
@@ -996,14 +967,9 @@ def api20_host_groups_post_with_http_info(
         names: Annotated[Optional[conlist(StrictStr)], Field(description="Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.")] = None,
         **kwargs
     ) -> ApiResponse:  # noqa: E501
-        """Create a host group  # noqa: E501
-
-        Create a host group. The `names` query parameter is required.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
+        """Create a host group
 
-        >>> thread = api.api20_host_groups_post_with_http_info(authorization, x_request_id, names, async_req=True)
-        >>> result = thread.get()
+        Create a host group. The `names` query parameter is required.
 
         :param authorization: Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
         :type authorization: str