Skip to content

Commit 782d0e9

Browse files
authored
Merge pull request #18 from purestorage/release-python-rest-client-v1-7-for-2-3-4
Release the python REST client for REST version 1.7
2 parents a6e2c9f + d3858cb commit 782d0e9

File tree

176 files changed

+35023
-152
lines changed

Some content is hidden

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

176 files changed

+35023
-152
lines changed

PKG-INFO

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

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# purity-fb
2-
Client for Purity//FB REST API (1.0 - 1.6), developed by [Pure Storage, Inc](http://www.purestorage.com/). Documentations can be found at [purity-fb.readthedocs.io](http://purity-fb.readthedocs.io/).
2+
Client for Purity//FB REST API (1.0 - 1.7), developed by [Pure Storage, Inc](http://www.purestorage.com/). Documentations can be found at [purity-fb.readthedocs.io](http://purity-fb.readthedocs.io/).
33

44
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
55

6-
- API version: 1.6
7-
- Package version: 1.6.1
6+
- API version: 1.7
7+
- Package version: 1.7.0
88
- Build package: io.swagger.codegen.languages.PythonClientCodegen
99
For more information, please visit [http://www.purestorage.com](http://www.purestorage.com)
1010

docs/AdminsApi.md

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

1010

1111
# **list_admins**

docs/AdminsCacheApi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# purity_fb_1dot6.AdminsCacheApi
1+
# purity_fb_1dot7.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.6/admins/cache |
8-
[**list_admin_cache**](AdminsCacheApi.md#list_admin_cache) | **GET** /1.6/admins/cache |
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 |
99

1010

1111
# **delete_admin_cache**

docs/AlertWatchersApi.md

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

1313

1414
# **create_alert_watchers**

docs/AlertsApi.md

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

1010

1111
# **list_alerts**

docs/ArraysApi.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# purity_fb_1dot6.ArraysApi
1+
# purity_fb_1dot7.ArraysApi
22

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

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**list_arrays**](ArraysApi.md#list_arrays) | **GET** /1.6/arrays |
8-
[**list_arrays_http_specific_performance**](ArraysApi.md#list_arrays_http_specific_performance) | **GET** /1.6/arrays/http-specific-performance |
9-
[**list_arrays_performance**](ArraysApi.md#list_arrays_performance) | **GET** /1.6/arrays/performance |
10-
[**list_arrays_s3_specific_performance**](ArraysApi.md#list_arrays_s3_specific_performance) | **GET** /1.6/arrays/s3-specific-performance |
11-
[**list_arrays_space**](ArraysApi.md#list_arrays_space) | **GET** /1.6/arrays/space |
12-
[**list_clients_performance**](ArraysApi.md#list_clients_performance) | **GET** /1.6/arrays/clients/performance |
13-
[**update_arrays**](ArraysApi.md#update_arrays) | **PATCH** /1.6/arrays |
7+
[**list_arrays**](ArraysApi.md#list_arrays) | **GET** /1.7/arrays |
8+
[**list_arrays_http_specific_performance**](ArraysApi.md#list_arrays_http_specific_performance) | **GET** /1.7/arrays/http-specific-performance |
9+
[**list_arrays_performance**](ArraysApi.md#list_arrays_performance) | **GET** /1.7/arrays/performance |
10+
[**list_arrays_s3_specific_performance**](ArraysApi.md#list_arrays_s3_specific_performance) | **GET** /1.7/arrays/s3-specific-performance |
11+
[**list_arrays_space**](ArraysApi.md#list_arrays_space) | **GET** /1.7/arrays/space |
12+
[**list_clients_performance**](ArraysApi.md#list_clients_performance) | **GET** /1.7/arrays/clients/performance |
13+
[**update_arrays**](ArraysApi.md#update_arrays) | **PATCH** /1.7/arrays |
1414

1515

1616
# **list_arrays**

docs/AuthenticationApi.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# purity_fb_1dot6.AuthenticationApi
1+
# purity_fb_1dot7.AuthenticationApi
22

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

@@ -21,11 +21,44 @@ from purity_fb import PurityFb, rest
2121

2222
fb = PurityFb("10.255.9.28") # assume the array IP is 10.255.9.28
2323
fb.disable_verify_ssl()
24+
my_ca_certificate_file = '/net/ssl/fb_ca_certificate.pem'
2425
try:
2526
# login to the array with your API_TOKEN
2627
# use *_with_http_info method to get response header as well as body
2728
res = fb.authentication.login_with_http_info(API_TOKEN)
2829
X_AUTH_TOKEN = res[2]['x-auth-token']
30+
31+
# SSL verification can be turned on later. In order to make a transition from no SSL
32+
# verification to strict SSL verification easier, you may turn on a "Certificate Optional" mode
33+
# that SSL supports. This will allow REST calls to succeed without SSL verification when no
34+
# certificate is provided, but will begin strictly checking the certificate once one has been
35+
# provided, so that there is no disruption.
36+
fb.allow_verify_ssl()
37+
fb.configure_ca_certificate_file(my_ca_certificate_file)
38+
# enable strict verification once the file is configured.
39+
fb.enable_verify_ssl()
40+
41+
# You can also provide the certificate at the same time that you enable strict SSL verification,
42+
# if you have already confirmed that your certificate is correct.
43+
fb.enable_verify_ssl(ca_certs_file_path=my_ca_certificate_file)
44+
except rest.ApiException as e:
45+
print("Exception when logging in to the array: %s\n" % e)
46+
47+
# if you provide the path to a CA certificate(s) file on initialization, then SSL verification will
48+
# be enabled by default
49+
secure_fb = PurityFb("10.255.9.28", ca_certs_file_path=my_ca_certificate_file)
50+
try:
51+
# login to the array with your API_TOKEN
52+
# use *_with_http_info method to get response header as well as body
53+
res = secure_fb.authentication.login_with_http_info(API_TOKEN)
54+
X_AUTH_TOKEN = res[2]['x-auth-token']
55+
56+
# the CA certificate used for SSL verification can be changed later if desired
57+
new_ca_certificate_file = '/net/ssl/replacement_fb_ca_certificate.pem'
58+
secure_fb.configure_ca_certificate_file(new_ca_certificate_file)
59+
60+
# SSL verification can be turned off later if desired
61+
secure_fb.disable_verify_ssl()
2962
except rest.ApiException as e:
3063
print("Exception when logging in to the array: %s\n" % e)
3164
```

docs/BladeApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# purity_fb_1dot6.BladeApi
1+
# purity_fb_1dot7.BladeApi
22

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

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**list_blades**](BladeApi.md#list_blades) | **GET** /1.6/blades |
7+
[**list_blades**](BladeApi.md#list_blades) | **GET** /1.7/blades |
88

99

1010
# **list_blades**

docs/BucketsApi.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# purity_fb_1dot6.BucketsApi
1+
# purity_fb_1dot7.BucketsApi
22

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

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**create_buckets**](BucketsApi.md#create_buckets) | **POST** /1.6/buckets |
8-
[**delete_buckets**](BucketsApi.md#delete_buckets) | **DELETE** /1.6/buckets |
9-
[**list_buckets**](BucketsApi.md#list_buckets) | **GET** /1.6/buckets |
10-
[**update_buckets**](BucketsApi.md#update_buckets) | **PATCH** /1.6/buckets |
7+
[**create_buckets**](BucketsApi.md#create_buckets) | **POST** /1.7/buckets |
8+
[**delete_buckets**](BucketsApi.md#delete_buckets) | **DELETE** /1.7/buckets |
9+
[**list_buckets**](BucketsApi.md#list_buckets) | **GET** /1.7/buckets |
10+
[**update_buckets**](BucketsApi.md#update_buckets) | **PATCH** /1.7/buckets |
1111

1212

1313
# **create_buckets**

0 commit comments

Comments
 (0)