Skip to content

Commit 96161a2

Browse files
tlewis-pstlewis-ps
authored
Merge pull request #33 from tlewis-ps/master
This commit contains changes for releasing v1.10.0 of the Python REST SDK ### Package version 1.10.0 - This release of the purity_fb Python REST SDK accompanies the 3.1.0 release of Purity//FB. #### New SDK Features - Welcome Banner - Object Lifecycle Rules - RBAC Roles - Syslog Servers - Import S3 Access Keys Be sure to visit the [Purity//FB REST API 1.x Release Notes](https://support.purestorage.com/FlashBlade/Purity_FB/PurityFB_REST_API/01_Purity_FB_REST_API_Release_Notes) for complete descriptions and other relevant information for these features. #### Fixes - Removed the parameter `ids` for the function `list_object_store_access_keys`. This optional parameter was mistakenly added in a previous version, but was not supported. In addition to the the above, this commit also contains documentation fixes which remove several invalid references and links (such as those to 'str.md').
2 parents 8848861 + ec94067 commit 96161a2

1,490 files changed

Lines changed: 125335 additions & 60652 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎PKG-INFO‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Metadata-Version: 1.9.2
1+
Metadata-Version: 1.10.0
22
Name: purity_fb
3-
Version: 1.9.2
4-
Summary: Pure Storage FlashBlade REST 1.9 Python SDK.
3+
Version: 1.10.0
4+
Summary: Pure Storage FlashBlade REST 1.10 Python SDK.
55
License: Apache 2.0

‎README.md‎

Lines changed: 274 additions & 25 deletions
Large diffs are not rendered by default.

‎docs/Admin.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**name** | **str** | name of the object (e.g., a file system or snapshot) | [optional]
6+
**name** | **str** | The name of the object (e.g., a file system or snapshot) | [optional]
77
**api_token** | [**AdminApiToken**](AdminApiToken.md) | | [optional]
88
**create_api_token** | **bool** | Create a new API token | [optional]
99
**api_token_timeout** | **int** | Expire api-token after this period (in milliseconds). | [optional]

‎docs/AdminsApi.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# purity_fb_1dot9.AdminsApi
1+
# purity_fb_1dot10.AdminsApi
22

33
All URIs are relative to *https://purity_fb_server/api*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**list_admins**](AdminsApi.md#list_admins) | **GET** /1.9/admins |
8-
[**update_admins**](AdminsApi.md#update_admins) | **PATCH** /1.9/admins |
7+
[**list_admins**](AdminsApi.md#list_admins) | **GET** /1.10/admins |
8+
[**update_admins**](AdminsApi.md#update_admins) | **PATCH** /1.10/admins |
99

1010

1111
# **list_admins**
@@ -42,12 +42,12 @@ if res:
4242
Name | Type | Description | Notes
4343
------------- | ------------- | ------------- | -------------
4444
**filter** | **str**| The filter to be used for query. | [optional]
45-
**ids** | [**list[str]**](str.md)| A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional]
45+
**ids** | **list[str]**| A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional]
4646
**limit** | **int**| limit, should be >= 0 | [optional]
47-
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
48-
**sort** | **str**| The way to order the results. | [optional]
49-
**start** | **int**| start | [optional]
50-
**token** | **str**| token | [optional]
47+
**names** | **list[str]**| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
48+
**sort** | **str**| Sort the response by the specified fields (in descending order if '-' is appended to the field name). | [optional]
49+
**start** | **int**| The offset of the first resource to return from a collection. | [optional]
50+
**token** | **str**| An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. | [optional]
5151
**expose** | **bool**| Display the unmasked API token. This is only valid when listing your own token. | [optional] [default to false]
5252

5353
### Return type
@@ -99,8 +99,8 @@ if res:
9999
Name | Type | Description | Notes
100100
------------- | ------------- | ------------- | -------------
101101
**admin** | [**Admin**](Admin.md)| |
102-
**ids** | [**list[str]**](str.md)| A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional]
103-
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
102+
**ids** | **list[str]**| A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional]
103+
**names** | **list[str]**| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
104104

105105
### Return type
106106

‎docs/AdminsCacheApi.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# purity_fb_1dot9.AdminsCacheApi
1+
# purity_fb_1dot10.AdminsCacheApi
22

33
All URIs are relative to *https://purity_fb_server/api*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**delete_admin_cache**](AdminsCacheApi.md#delete_admin_cache) | **DELETE** /1.9/admins/cache |
8-
[**list_admin_cache**](AdminsCacheApi.md#list_admin_cache) | **GET** /1.9/admins/cache |
7+
[**delete_admin_cache**](AdminsCacheApi.md#delete_admin_cache) | **DELETE** /1.10/admins/cache |
8+
[**list_admin_cache**](AdminsCacheApi.md#list_admin_cache) | **GET** /1.10/admins/cache |
99

1010

1111
# **delete_admin_cache**
@@ -40,8 +40,8 @@ if res:
4040

4141
Name | Type | Description | Notes
4242
------------- | ------------- | ------------- | -------------
43-
**ids** | [**list[str]**](str.md)| A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional]
44-
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
43+
**ids** | **list[str]**| A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional]
44+
**names** | **list[str]**| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
4545

4646
### Return type
4747

@@ -92,12 +92,12 @@ Name | Type | Description | Notes
9292
------------- | ------------- | ------------- | -------------
9393
**refresh** | **bool**| Whether to refresh the user info from directory service | [optional] [default to false]
9494
**filter** | **str**| The filter to be used for query. | [optional]
95-
**ids** | [**list[str]**](str.md)| A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional]
95+
**ids** | **list[str]**| A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional]
9696
**limit** | **int**| limit, should be >= 0 | [optional]
97-
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
98-
**sort** | **str**| The way to order the results. | [optional]
99-
**start** | **int**| start | [optional]
100-
**token** | **str**| token | [optional]
97+
**names** | **list[str]**| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
98+
**sort** | **str**| Sort the response by the specified fields (in descending order if '-' is appended to the field name). | [optional]
99+
**start** | **int**| The offset of the first resource to return from a collection. | [optional]
100+
**token** | **str**| An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. | [optional]
101101

102102
### Return type
103103

‎docs/Alert.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**name** | **str** | name of the object (e.g., a file system or snapshot) | [optional]
7-
**created** | **int** | creation timestamp of the object | [optional]
6+
**name** | **str** | The name of the object (e.g., a file system or snapshot) | [optional]
7+
**created** | **int** | Creation timestamp of the object | [optional]
88
**index** | **int** | the unique index of the alert | [optional]
99
**code** | **int** | alert code | [optional]
1010
**severity** | **str** | Severity of the alert. Possible values are info, warning and critical. | [optional]

‎docs/AlertWatcherTest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**name** | **str** | name of the object (e.g., a file system or snapshot) | [optional]
6+
**name** | **str** | The name of the object (e.g., a file system or snapshot) | [optional]
77
**accepted** | **bool** | is the email accepted? | [optional]
88
**error** | **str** | error message (if failed) | [optional]
99

‎docs/AlertWatchersApi.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# purity_fb_1dot9.AlertWatchersApi
1+
# purity_fb_1dot10.AlertWatchersApi
22

33
All URIs are relative to *https://purity_fb_server/api*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**create_alert_watchers**](AlertWatchersApi.md#create_alert_watchers) | **POST** /1.9/alert-watchers |
8-
[**delete_alert_watchers**](AlertWatchersApi.md#delete_alert_watchers) | **DELETE** /1.9/alert-watchers |
9-
[**list_alert_watchers**](AlertWatchersApi.md#list_alert_watchers) | **GET** /1.9/alert-watchers |
10-
[**test_alert_watchers**](AlertWatchersApi.md#test_alert_watchers) | **GET** /1.9/alert-watchers/test |
11-
[**update_alert_watchers**](AlertWatchersApi.md#update_alert_watchers) | **PATCH** /1.9/alert-watchers |
7+
[**create_alert_watchers**](AlertWatchersApi.md#create_alert_watchers) | **POST** /1.10/alert-watchers |
8+
[**delete_alert_watchers**](AlertWatchersApi.md#delete_alert_watchers) | **DELETE** /1.10/alert-watchers |
9+
[**list_alert_watchers**](AlertWatchersApi.md#list_alert_watchers) | **GET** /1.10/alert-watchers |
10+
[**test_alert_watchers**](AlertWatchersApi.md#test_alert_watchers) | **GET** /1.10/alert-watchers/test |
11+
[**update_alert_watchers**](AlertWatchersApi.md#update_alert_watchers) | **PATCH** /1.10/alert-watchers |
1212

1313

1414
# **create_alert_watchers**
@@ -49,7 +49,7 @@ if res:
4949

5050
Name | Type | Description | Notes
5151
------------- | ------------- | ------------- | -------------
52-
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
52+
**names** | **list[str]**| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
5353
**watcher_settings** | [**AlertWatcherPost**](AlertWatcherPost.md)| | [optional]
5454

5555
### Return type
@@ -98,7 +98,7 @@ if res:
9898

9999
Name | Type | Description | Notes
100100
------------- | ------------- | ------------- | -------------
101-
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
101+
**names** | **list[str]**| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
102102

103103
### Return type
104104

@@ -149,12 +149,12 @@ if res:
149149
Name | Type | Description | Notes
150150
------------- | ------------- | ------------- | -------------
151151
**filter** | **str**| The filter to be used for query. | [optional]
152-
**ids** | [**list[str]**](str.md)| A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional]
152+
**ids** | **list[str]**| A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional]
153153
**limit** | **int**| limit, should be >= 0 | [optional]
154-
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
155-
**sort** | **str**| The way to order the results. | [optional]
156-
**start** | **int**| start | [optional]
157-
**token** | **str**| token | [optional]
154+
**names** | **list[str]**| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
155+
**sort** | **str**| Sort the response by the specified fields (in descending order if '-' is appended to the field name). | [optional]
156+
**start** | **int**| The offset of the first resource to return from a collection. | [optional]
157+
**token** | **str**| An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. | [optional]
158158

159159
### Return type
160160

@@ -202,7 +202,7 @@ if res:
202202

203203
Name | Type | Description | Notes
204204
------------- | ------------- | ------------- | -------------
205-
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
205+
**names** | **list[str]**| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
206206

207207
### Return type
208208

@@ -262,8 +262,8 @@ if res:
262262
Name | Type | Description | Notes
263263
------------- | ------------- | ------------- | -------------
264264
**watcher_settings** | [**AlertWatcher**](AlertWatcher.md)| |
265-
**ids** | [**list[str]**](str.md)| A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional]
266-
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
265+
**ids** | **list[str]**| A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional]
266+
**names** | **list[str]**| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
267267

268268
### Return type
269269

‎docs/AlertsApi.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# purity_fb_1dot9.AlertsApi
1+
# purity_fb_1dot10.AlertsApi
22

33
All URIs are relative to *https://purity_fb_server/api*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**list_alerts**](AlertsApi.md#list_alerts) | **GET** /1.9/alerts |
8-
[**update_alerts**](AlertsApi.md#update_alerts) | **PATCH** /1.9/alerts |
7+
[**list_alerts**](AlertsApi.md#list_alerts) | **GET** /1.10/alerts |
8+
[**update_alerts**](AlertsApi.md#update_alerts) | **PATCH** /1.10/alerts |
99

1010

1111
# **list_alerts**
@@ -40,12 +40,12 @@ if res:
4040
Name | Type | Description | Notes
4141
------------- | ------------- | ------------- | -------------
4242
**filter** | **str**| The filter to be used for query. | [optional]
43-
**ids** | [**list[str]**](str.md)| A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional]
43+
**ids** | **list[str]**| A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional]
4444
**limit** | **int**| limit, should be >= 0 | [optional]
45-
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
46-
**sort** | **str**| The way to order the results. | [optional]
47-
**start** | **int**| start | [optional]
48-
**token** | **str**| token | [optional]
45+
**names** | **list[str]**| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
46+
**sort** | **str**| Sort the response by the specified fields (in descending order if '-' is appended to the field name). | [optional]
47+
**start** | **int**| The offset of the first resource to return from a collection. | [optional]
48+
**token** | **str**| An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. | [optional]
4949

5050
### Return type
5151

@@ -95,7 +95,7 @@ if res:
9595
Name | Type | Description | Notes
9696
------------- | ------------- | ------------- | -------------
9797
**alert_settings** | [**Alert**](Alert.md)| |
98-
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
98+
**names** | **list[str]**| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
9999

100100
### Return type
101101

0 commit comments

Comments
 (0)