Skip to content

Commit 0807a0f

Browse files
azornberg-psazornberg-ps
authored
Merge pull request #19 from purestorage/release-python-rest-client-v1-8-for-2-4-0
Release the python REST client for REST version 1.8
2 parents 782d0e9 + c288abc commit 0807a0f

File tree

365 files changed

+44208
-1264
lines changed

Some content is hidden

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

365 files changed

+44208
-1264
lines changed

‎PKG-INFO‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Metadata-Version: 1.4
1+
Metadata-Version: 1.8.0
22
Name: purity_fb
3-
Version: 1.7.0
3+
Version: 1.8.0
44
Summary: A python client for Purity//FB REST API.
55
License: Apache 2.0

‎docs/AdminCache.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +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]
6+
**id** | **str** | A non-modifiable, globally unique ID chosen by the system. | [optional]
7+
**name** | **str** | The name of the object (e.g., a file system or snapshot). | [optional]
78
**role** | **str** | the role of the user | [optional]
89
**time** | **int** | Time the role was cached in milliseconds since UNIX epoch | [optional]
910

‎docs/AdminCacheResponse.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**pagination_info** | [**PaginationInfo**](PaginationInfo.md) | pagination information, only available in GET requests | [optional]
7-
**items** | [**list[AdminCache]**](AdminCache.md) | a list of admin cache entries | [optional]
7+
**items** | [**list[AdminCache]**](AdminCache.md) | A list of admin cache entry objects. | [optional]
88

99
[[Back to Model list]](index.md#documentation-for-models) [[Back to API list]](index.md#endpoint-properties) [[Back to Overview]](index.md)
1010

‎docs/AdminResponse.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**pagination_info** | [**PaginationInfo**](PaginationInfo.md) | pagination information, only available in GET requests | [optional]
7-
**items** | [**list[Admin]**](Admin.md) | a list of administrative account objects | [optional]
7+
**items** | [**list[Admin]**](Admin.md) | A list of administrative account objects. | [optional]
88

99
[[Back to Model list]](index.md#documentation-for-models) [[Back to API list]](index.md#endpoint-properties) [[Back to Overview]](index.md)
1010

‎docs/AdminsApi.md‎

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
# purity_fb_1dot7.AdminsApi
1+
# purity_fb_1dot8.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.7/admins |
8-
[**update_admins**](AdminsApi.md#update_admins) | **PATCH** /1.7/admins |
7+
[**list_admins**](AdminsApi.md#list_admins) | **GET** /1.8/admins |
8+
[**update_admins**](AdminsApi.md#update_admins) | **PATCH** /1.8/admins |
99

1010

1111
# **list_admins**
12-
> AdminResponse list_admins(expose=expose, names=names)
12+
> AdminResponse list_admins(filter=filter, ids=ids, limit=limit, names=names, sort=sort, start=start, token=token, expose=expose)
1313
1414

1515

16-
list all administrative accounts
16+
List all administrative accounts.
1717

1818
### Example
1919
```python
@@ -31,6 +31,8 @@ if res:
3131
res = fb.admins.list_admins()
3232
# list a subset of admin accounts by name
3333
res = fb.admins.list_admins(names=['pureuser'])
34+
# list a subset of admin accounts by id
35+
res = fb.admins.list_admins(ids=['100abf42-0000-4000-8023-000det400090'])
3436
except rest.ApiException as e:
3537
print("Exception when listing admins: %s\n" % e)
3638
```
@@ -39,8 +41,14 @@ if res:
3941

4042
Name | Type | Description | Notes
4143
------------- | ------------- | ------------- | -------------
42-
**expose** | **bool**| display the unmasked API token | [optional] [default to false]
43-
**names** | [**list[str]**](str.md)| A list of names. | [optional]
44+
**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]
46+
**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]
51+
**expose** | **bool**| Display the unmasked API token. This is only valid when listing your own token. | [optional] [default to false]
4452

4553
### Return type
4654

@@ -58,11 +66,11 @@ Name | Type | Description | Notes
5866
[[Back to top]](#) [[Back to API list]](index.md#endpoint-properties) [[Back to Model list]](index.md#documentation-for-models) [[Back to Overview]](index.md)
5967

6068
# **update_admins**
61-
> AdminResponse update_admins(admin, names=names)
69+
> AdminResponse update_admins(admin, ids=ids, names=names)
6270
6371

6472

65-
update administrative account attributes
73+
Update administrative account attributes.
6674

6775
### Example
6876
```python
@@ -80,7 +88,7 @@ if res:
8088
myAdmin = Admin()
8189
myAdmin.old_password = "pureuser"
8290
myAdmin.password = "fakepass"
83-
res = fb.admins.update_admins(myAdmin, names=['pureuser'])
91+
res = fb.admins.update_admins(names=['pureuser'], admin=myAdmin)
8492

8593
except rest.ApiException as e:
8694
print("Exception when changing password: %s\n" % e)
@@ -91,7 +99,8 @@ if res:
9199
Name | Type | Description | Notes
92100
------------- | ------------- | ------------- | -------------
93101
**admin** | [**Admin**](Admin.md)| |
94-
**names** | [**list[str]**](str.md)| A list of names. | [optional]
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]
95104

96105
### Return type
97106

‎docs/AdminsCacheApi.md‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
# purity_fb_1dot7.AdminsCacheApi
1+
# purity_fb_1dot8.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.7/admins/cache |
8-
[**list_admin_cache**](AdminsCacheApi.md#list_admin_cache) | **GET** /1.7/admins/cache |
7+
[**delete_admin_cache**](AdminsCacheApi.md#delete_admin_cache) | **DELETE** /1.8/admins/cache |
8+
[**list_admin_cache**](AdminsCacheApi.md#list_admin_cache) | **GET** /1.8/admins/cache |
99

1010

1111
# **delete_admin_cache**
12-
> delete_admin_cache(names=names)
12+
> delete_admin_cache(ids=ids, names=names)
1313
1414

1515

16-
Delete
16+
Delete specified admin cache entries, or clear the cache.
1717

1818
### Example
1919
```python
@@ -40,7 +40,8 @@ if res:
4040

4141
Name | Type | Description | Notes
4242
------------- | ------------- | ------------- | -------------
43-
**names** | [**list[str]**](str.md)| A list of names. | [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]
44+
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
4445

4546
### Return type
4647

@@ -58,11 +59,11 @@ void (empty response body)
5859
[[Back to top]](#) [[Back to API list]](index.md#endpoint-properties) [[Back to Model list]](index.md#documentation-for-models) [[Back to Overview]](index.md)
5960

6061
# **list_admin_cache**
61-
> AdminCacheResponse list_admin_cache(names, refresh=refresh, filter=filter, limit=limit, sort=sort, start=start, token=token)
62+
> AdminCacheResponse list_admin_cache(refresh=refresh, filter=filter, ids=ids, limit=limit, names=names, sort=sort, start=start, token=token)
6263
6364

6465

65-
A list of admin cache entries
66+
List admin cache entries.
6667

6768
### Example
6869
```python
@@ -78,8 +79,9 @@ if res:
7879
try:
7980
# list admin cache entry
8081
res = fb.admin_cache.list_admin_cache(names=['adminuser'])
81-
# refresh admin cache entry
82-
res = fb.admin_cache.list_admin_cache(names=['adminuser'], refresh=True)
82+
# refresh admin cache entry for user with id '10314f42-020d-7080-8013-000ddt400090'
83+
res = fb.admin_cache.list_admin_cache(ids=['10314f42-020d-7080-8013-000ddt400090'],
84+
refresh=True)
8385
except rest.ApiException as e:
8486
print("Exception when listing admin cache users: %s\n" % e)
8587
```
@@ -88,10 +90,11 @@ if res:
8890

8991
Name | Type | Description | Notes
9092
------------- | ------------- | ------------- | -------------
91-
**names** | [**list[str]**](str.md)| A required list of names. |
9293
**refresh** | **bool**| Whether to refresh the user info from directory service | [optional] [default to false]
9394
**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]
9496
**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]
9598
**sort** | **str**| The way to order the results. | [optional]
9699
**start** | **int**| start | [optional]
97100
**token** | **str**| token | [optional]

‎docs/AlertResponse.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**pagination_info** | [**PaginationInfo**](PaginationInfo.md) | pagination information, only available in GET requests | [optional]
7-
**items** | [**list[Alert]**](Alert.md) | a list of alert objects | [optional]
7+
**items** | [**list[Alert]**](Alert.md) | A list of alert objects. | [optional]
88

99
[[Back to Model list]](index.md#documentation-for-models) [[Back to API list]](index.md#endpoint-properties) [[Back to Overview]](index.md)
1010

‎docs/AlertWatcherResponse.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**pagination_info** | [**PaginationInfo**](PaginationInfo.md) | pagination information, only available in GET requests | [optional]
7-
**items** | [**list[AlertWatcher]**](AlertWatcher.md) | a list of alert watcher objects | [optional]
7+
**items** | [**list[AlertWatcher]**](AlertWatcher.md) | A list of alert watcher objects. | [optional]
88

99
[[Back to Model list]](index.md#documentation-for-models) [[Back to API list]](index.md#endpoint-properties) [[Back to Overview]](index.md)
1010

‎docs/AlertWatchersApi.md‎

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
# purity_fb_1dot7.AlertWatchersApi
1+
# purity_fb_1dot8.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.7/alert-watchers |
8-
[**delete_alert_watchers**](AlertWatchersApi.md#delete_alert_watchers) | **DELETE** /1.7/alert-watchers |
9-
[**list_alert_watchers**](AlertWatchersApi.md#list_alert_watchers) | **GET** /1.7/alert-watchers |
10-
[**test_alert_watchers**](AlertWatchersApi.md#test_alert_watchers) | **GET** /1.7/alert-watchers/test |
11-
[**update_alert_watchers**](AlertWatchersApi.md#update_alert_watchers) | **PATCH** /1.7/alert-watchers |
7+
[**create_alert_watchers**](AlertWatchersApi.md#create_alert_watchers) | **POST** /1.8/alert-watchers |
8+
[**delete_alert_watchers**](AlertWatchersApi.md#delete_alert_watchers) | **DELETE** /1.8/alert-watchers |
9+
[**list_alert_watchers**](AlertWatchersApi.md#list_alert_watchers) | **GET** /1.8/alert-watchers |
10+
[**test_alert_watchers**](AlertWatchersApi.md#test_alert_watchers) | **GET** /1.8/alert-watchers/test |
11+
[**update_alert_watchers**](AlertWatchersApi.md#update_alert_watchers) | **PATCH** /1.8/alert-watchers |
1212

1313

1414
# **create_alert_watchers**
1515
> AlertWatcherResponse create_alert_watchers(names=names)
1616
1717

1818

19-
Create alert watchers
19+
Create alert watchers.
2020

2121
### Example
2222
```python
@@ -41,7 +41,7 @@ if res:
4141

4242
Name | Type | Description | Notes
4343
------------- | ------------- | ------------- | -------------
44-
**names** | [**list[str]**](str.md)| A list of names. | [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]
4545

4646
### Return type
4747

@@ -63,7 +63,7 @@ Name | Type | Description | Notes
6363
6464

6565

66-
Delete alert watchers
66+
Delete alert watchers.
6767

6868
### Example
6969
```python
@@ -81,14 +81,14 @@ if res:
8181
res = fb.alert_watchers.delete_alert_watchers(names=['test@example.com'])
8282
print(res)
8383
except rest.ApiException as e:
84-
print("Exception when creating alert watchers: %s\n" % e)
84+
print("Exception when deleting alert watchers: %s\n" % e)
8585
```
8686

8787
### Parameters
8888

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

9393
### Return type
9494

@@ -106,11 +106,11 @@ void (empty response body)
106106
[[Back to top]](#) [[Back to API list]](index.md#endpoint-properties) [[Back to Model list]](index.md#documentation-for-models) [[Back to Overview]](index.md)
107107

108108
# **list_alert_watchers**
109-
> AlertWatcherResponse list_alert_watchers(names=names, filter=filter, sort=sort, start=start, limit=limit, token=token)
109+
> AlertWatcherResponse list_alert_watchers(filter=filter, ids=ids, limit=limit, names=names, sort=sort, start=start, token=token)
110110
111111

112112

113-
List alert watchers
113+
List alert watchers.
114114

115115
### Example
116116
```python
@@ -136,11 +136,12 @@ if res:
136136

137137
Name | Type | Description | Notes
138138
------------- | ------------- | ------------- | -------------
139-
**names** | [**list[str]**](str.md)| A list of names. | [optional]
140139
**filter** | **str**| The filter to be used for query. | [optional]
140+
**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]
141+
**limit** | **int**| limit, should be >= 0 | [optional]
142+
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
141143
**sort** | **str**| The way to order the results. | [optional]
142144
**start** | **int**| start | [optional]
143-
**limit** | **int**| limit, should be >= 0 | [optional]
144145
**token** | **str**| token | [optional]
145146

146147
### Return type
@@ -189,7 +190,7 @@ if res:
189190

190191
Name | Type | Description | Notes
191192
------------- | ------------- | ------------- | -------------
192-
**names** | [**list[str]**](str.md)| A list of names. | [optional]
193+
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
193194

194195
### Return type
195196

@@ -207,11 +208,11 @@ Name | Type | Description | Notes
207208
[[Back to top]](#) [[Back to API list]](index.md#endpoint-properties) [[Back to Model list]](index.md#documentation-for-models) [[Back to Overview]](index.md)
208209

209210
# **update_alert_watchers**
210-
> AlertWatcherResponse update_alert_watchers(watcher_settings, names=names)
211+
> AlertWatcherResponse update_alert_watchers(watcher_settings, ids=ids, names=names)
211212
212213

213214

214-
Update alert watchers
215+
Update alert watchers.
215216

216217
### Example
217218
```python
@@ -239,7 +240,8 @@ if res:
239240
Name | Type | Description | Notes
240241
------------- | ------------- | ------------- | -------------
241242
**watcher_settings** | [**AlertWatcher**](AlertWatcher.md)| |
242-
**names** | [**list[str]**](str.md)| A list of names. | [optional]
243+
**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]
244+
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
243245

244246
### Return type
245247

‎docs/AlertsApi.md‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
# purity_fb_1dot7.AlertsApi
1+
# purity_fb_1dot8.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.7/alerts |
8-
[**update_alerts**](AlertsApi.md#update_alerts) | **PATCH** /1.7/alerts |
7+
[**list_alerts**](AlertsApi.md#list_alerts) | **GET** /1.8/alerts |
8+
[**update_alerts**](AlertsApi.md#update_alerts) | **PATCH** /1.8/alerts |
99

1010

1111
# **list_alerts**
12-
> AlertResponse list_alerts(names=names, filter=filter, sort=sort, start=start, limit=limit, token=token)
12+
> AlertResponse list_alerts(filter=filter, ids=ids, limit=limit, names=names, sort=sort, start=start, token=token)
1313
1414

1515

16-
List all alerts
16+
List all alerts.
1717

1818
### Example
1919
```python
@@ -39,11 +39,12 @@ if res:
3939

4040
Name | Type | Description | Notes
4141
------------- | ------------- | ------------- | -------------
42-
**names** | [**list[str]**](str.md)| A list of names. | [optional]
4342
**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]
44+
**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]
4446
**sort** | **str**| The way to order the results. | [optional]
4547
**start** | **int**| start | [optional]
46-
**limit** | **int**| limit, should be >= 0 | [optional]
4748
**token** | **str**| token | [optional]
4849

4950
### Return type
@@ -66,7 +67,7 @@ Name | Type | Description | Notes
6667
6768

6869

69-
Update alerts
70+
Update alerts.
7071

7172
### Example
7273
```python
@@ -94,7 +95,7 @@ if res:
9495
Name | Type | Description | Notes
9596
------------- | ------------- | ------------- | -------------
9697
**alert_settings** | [**Alert**](Alert.md)| |
97-
**names** | [**list[str]**](str.md)| A list of names. | [optional]
98+
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
9899

99100
### Return type
100101

0 commit comments

Comments
 (0)