Skip to content

Commit

Permalink
Merge pull request #12 from yongjianmu/master
Browse files Browse the repository at this point in the history
Added support for Purity//FB REST API 1.5.
  • Loading branch information
yongjianmu authored Sep 26, 2018
2 parents cb6c614 + 2711c38 commit 9e01c37
Show file tree
Hide file tree
Showing 165 changed files with 31,847 additions and 126 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# purity-fb
Client for Purity//FB REST API (1.0 - 1.3), developed by [Pure Storage, Inc](http://www.purestorage.com/). Documentations can be found at [purity-fb.readthedocs.io](http://purity-fb.readthedocs.io/).
Client for Purity//FB REST API (1.0 - 1.5), developed by [Pure Storage, Inc](http://www.purestorage.com/). Documentations can be found at [purity-fb.readthedocs.io](http://purity-fb.readthedocs.io/).

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

- API version: 1.3
- Package version: 1.3.0
- API version: 1.5
- Package version: 1.5.0
- Build package: io.swagger.codegen.languages.PythonClientCodegen
For more information, please visit [http://www.purestorage.com](http://www.purestorage.com)

Expand Down Expand Up @@ -218,6 +218,8 @@ at most 20 retries in total, among which at most 15 connection retries and at mo

- [Admin](docs/Admin.md)
- [AdminApiToken](docs/AdminApiToken.md)
- [AdminCache](docs/AdminCache.md)
- [AdminCacheResponse](docs/AdminCacheResponse.md)
- [AdminResponse](docs/AdminResponse.md)
- [Alert](docs/Alert.md)
- [AlertResponse](docs/AlertResponse.md)
Expand All @@ -237,16 +239,26 @@ at most 20 retries in total, among which at most 15 connection retries and at mo
- [Blade](docs/Blade.md)
- [BladeResponse](docs/BladeResponse.md)
- [Bucket](docs/Bucket.md)
- [BucketPatch](docs/BucketPatch.md)
- [BucketPost](docs/BucketPost.md)
- [BucketResponse](docs/BucketResponse.md)
- [BuiltIn](docs/BuiltIn.md)
- [Certificate](docs/Certificate.md)
- [CertificateResponse](docs/CertificateResponse.md)
- [ClientPerformance](docs/ClientPerformance.md)
- [ClientPerformanceResponse](docs/ClientPerformanceResponse.md)
- [DirectoryService](docs/DirectoryService.md)
- [DirectoryServiceResponse](docs/DirectoryServiceResponse.md)
- [DirectoryServiceRole](docs/DirectoryServiceRole.md)
- [DirectoryServiceRolesResponse](docs/DirectoryServiceRolesResponse.md)
- [DirectoryServiceSettings](docs/DirectoryServiceSettings.md)
- [DirectoryServiceSettingsResponse](docs/DirectoryServiceSettingsResponse.md)
- [Dns](docs/Dns.md)
- [DnsResponse](docs/DnsResponse.md)
- [ErrorResponse](docs/ErrorResponse.md)
- [FileSystem](docs/FileSystem.md)
- [FileSystemPerformance](docs/FileSystemPerformance.md)
- [FileSystemPerformanceResponse](docs/FileSystemPerformanceResponse.md)
- [FileSystemResponse](docs/FileSystemResponse.md)
- [FileSystemSnapshot](docs/FileSystemSnapshot.md)
- [FileSystemSnapshotResponse](docs/FileSystemSnapshotResponse.md)
Expand All @@ -270,12 +282,19 @@ at most 20 retries in total, among which at most 15 connection retries and at mo
- [ObjectStoreUserResponse](docs/ObjectStoreUserResponse.md)
- [Objectstoreaccesskey](docs/Objectstoreaccesskey.md)
- [PaginationInfo](docs/PaginationInfo.md)
- [Policy](docs/Policy.md)
- [PolicyObjects](docs/PolicyObjects.md)
- [PolicyObjectsResponse](docs/PolicyObjectsResponse.md)
- [PolicyPatch](docs/PolicyPatch.md)
- [PolicyReference](docs/PolicyReference.md)
- [PolicyResponse](docs/PolicyResponse.md)
- [ProtocolRule](docs/ProtocolRule.md)
- [PureArray](docs/PureArray.md)
- [PureError](docs/PureError.md)
- [PureObject](docs/PureObject.md)
- [Reference](docs/Reference.md)
- [Resource](docs/Resource.md)
- [ResourceRule](docs/ResourceRule.md)
- [SmbRule](docs/SmbRule.md)
- [Smtp](docs/Smtp.md)
- [SmtpResponse](docs/SmtpResponse.md)
Expand Down
6 changes: 3 additions & 3 deletions docs/AdminsApi.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# purity_fb_1dot4.AdminsApi
# purity_fb_1dot5.AdminsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**list_admins**](AdminsApi.md#list_admins) | **GET** /1.4/admins |
[**update_admins**](AdminsApi.md#update_admins) | **PATCH** /1.4/admins |
[**list_admins**](AdminsApi.md#list_admins) | **GET** /1.5/admins |
[**update_admins**](AdminsApi.md#update_admins) | **PATCH** /1.5/admins |


# **list_admins**
Expand Down
6 changes: 3 additions & 3 deletions docs/AdminsCacheApi.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# purity_fb_1dot4.AdminsCacheApi
# purity_fb_1dot5.AdminsCacheApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_admin_cache**](AdminsCacheApi.md#delete_admin_cache) | **DELETE** /1.4/admins/cache |
[**list_admin_cache**](AdminsCacheApi.md#list_admin_cache) | **GET** /1.4/admins/cache |
[**delete_admin_cache**](AdminsCacheApi.md#delete_admin_cache) | **DELETE** /1.5/admins/cache |
[**list_admin_cache**](AdminsCacheApi.md#list_admin_cache) | **GET** /1.5/admins/cache |


# **delete_admin_cache**
Expand Down
12 changes: 6 additions & 6 deletions docs/AlertWatchersApi.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# purity_fb_1dot4.AlertWatchersApi
# purity_fb_1dot5.AlertWatchersApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_alert_watchers**](AlertWatchersApi.md#create_alert_watchers) | **POST** /1.4/alert-watchers |
[**delete_alert_watchers**](AlertWatchersApi.md#delete_alert_watchers) | **DELETE** /1.4/alert-watchers |
[**list_alert_watchers**](AlertWatchersApi.md#list_alert_watchers) | **GET** /1.4/alert-watchers |
[**test_alert_watchers**](AlertWatchersApi.md#test_alert_watchers) | **GET** /1.4/alert-watchers/test |
[**update_alert_watchers**](AlertWatchersApi.md#update_alert_watchers) | **PATCH** /1.4/alert-watchers |
[**create_alert_watchers**](AlertWatchersApi.md#create_alert_watchers) | **POST** /1.5/alert-watchers |
[**delete_alert_watchers**](AlertWatchersApi.md#delete_alert_watchers) | **DELETE** /1.5/alert-watchers |
[**list_alert_watchers**](AlertWatchersApi.md#list_alert_watchers) | **GET** /1.5/alert-watchers |
[**test_alert_watchers**](AlertWatchersApi.md#test_alert_watchers) | **GET** /1.5/alert-watchers/test |
[**update_alert_watchers**](AlertWatchersApi.md#update_alert_watchers) | **PATCH** /1.5/alert-watchers |


# **create_alert_watchers**
Expand Down
6 changes: 3 additions & 3 deletions docs/AlertsApi.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# purity_fb_1dot4.AlertsApi
# purity_fb_1dot5.AlertsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**list_alerts**](AlertsApi.md#list_alerts) | **GET** /1.4/alerts |
[**update_alerts**](AlertsApi.md#update_alerts) | **PATCH** /1.4/alerts |
[**list_alerts**](AlertsApi.md#list_alerts) | **GET** /1.5/alerts |
[**update_alerts**](AlertsApi.md#update_alerts) | **PATCH** /1.5/alerts |


# **list_alerts**
Expand Down
22 changes: 11 additions & 11 deletions docs/ArraysApi.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# purity_fb_1dot4.ArraysApi
# purity_fb_1dot5.ArraysApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**list_arrays**](ArraysApi.md#list_arrays) | **GET** /1.4/arrays |
[**list_arrays_http_specific_performance**](ArraysApi.md#list_arrays_http_specific_performance) | **GET** /1.4/arrays/http-specific-performance |
[**list_arrays_performance**](ArraysApi.md#list_arrays_performance) | **GET** /1.4/arrays/performance |
[**list_arrays_s3_specific_performance**](ArraysApi.md#list_arrays_s3_specific_performance) | **GET** /1.4/arrays/s3-specific-performance |
[**list_arrays_space**](ArraysApi.md#list_arrays_space) | **GET** /1.4/arrays/space |
[**list_clients_performance**](ArraysApi.md#list_clients_performance) | **GET** /1.4/arrays/clients/performance |
[**update_arrays**](ArraysApi.md#update_arrays) | **PATCH** /1.4/arrays |
[**list_arrays**](ArraysApi.md#list_arrays) | **GET** /1.5/arrays |
[**list_arrays_http_specific_performance**](ArraysApi.md#list_arrays_http_specific_performance) | **GET** /1.5/arrays/http-specific-performance |
[**list_arrays_performance**](ArraysApi.md#list_arrays_performance) | **GET** /1.5/arrays/performance |
[**list_arrays_s3_specific_performance**](ArraysApi.md#list_arrays_s3_specific_performance) | **GET** /1.5/arrays/s3-specific-performance |
[**list_arrays_space**](ArraysApi.md#list_arrays_space) | **GET** /1.5/arrays/space |
[**list_clients_performance**](ArraysApi.md#list_clients_performance) | **GET** /1.5/arrays/clients/performance |
[**update_arrays**](ArraysApi.md#update_arrays) | **PATCH** /1.5/arrays |


# **list_arrays**
Expand All @@ -24,7 +24,7 @@ List arrays
```python
from purity_fb import PurityFb, rest

fb = PurityFb("10.255.9.28") # assume the array IP is 10.255.9.28
fb = PurityFb("10.255.9.28", version=__version__) # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
Expand Down Expand Up @@ -347,7 +347,7 @@ Update arrays
```python
from purity_fb import PurityFb, PureArray, rest

fb = PurityFb("10.255.9.28") # assume the array IP is 10.255.9.28
fb = PurityFb("10.255.9.28", version=__version__) # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
Expand All @@ -359,7 +359,7 @@ if res:
res = fb.arrays.update_arrays(array_settings=array_settings)
print(res)
except rest.ApiException as e:
print("Exception when listing arrays: %s\n" % e)
print("Exception when updating arrays: %s\n" % e)
```

### Parameters
Expand Down
2 changes: 1 addition & 1 deletion docs/AuthenticationApi.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# purity_fb_1dot4.AuthenticationApi
# purity_fb_1dot5.AuthenticationApi

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

Expand Down
4 changes: 2 additions & 2 deletions docs/BladeApi.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# purity_fb_1dot4.BladeApi
# purity_fb_1dot5.BladeApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**list_blades**](BladeApi.md#list_blades) | **GET** /1.4/blades |
[**list_blades**](BladeApi.md#list_blades) | **GET** /1.5/blades |


# **list_blades**
Expand Down
3 changes: 3 additions & 0 deletions docs/Bucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ Name | Type | Description | Notes
**name** | **str** | name of the object (e.g., a file system or snapshot) | [optional]
**created** | **int** | creation timestamp of the object | [optional]
**space** | [**Space**](Space.md) | the space specification of the bucket | [optional]
**account** | [**Reference**](Reference.md) | the account of the bucket | [optional]
**destroyed** | **bool** | is the bucket destroyed? False by default. Modifiable. | [optional]
**time_remaining** | **int** | time in milliseconds before the bucket is eradicated. Null if not destroyed. | [optional]
**object_count** | **int** | the number of object within the bucket. | [optional]

[[Back to Model list]](index.md#documentation-for-models) [[Back to API list]](index.md#endpoint-properties) [[Back to Overview]](index.md)
Expand Down
10 changes: 10 additions & 0 deletions docs/BucketPatch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# BucketPatch

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**destroyed** | **bool** | is the bucket destroyed? False by default. Modifiable. | [optional]

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


10 changes: 10 additions & 0 deletions docs/BucketPost.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# BucketPost

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**account** | [**Reference**](Reference.md) | the account of the bucket | [optional]

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


Loading

0 comments on commit 9e01c37

Please sign in to comment.