Skip to content

Commit

Permalink
Merge pull request #33 from tlewis-ps/master
Browse files Browse the repository at this point in the history
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').
  • Loading branch information
tlewis-ps authored Oct 13, 2020
2 parents 8848861 + ec94067 commit 96161a2
Show file tree
Hide file tree
Showing 1,490 changed files with 125,335 additions and 60,652 deletions.
6 changes: 3 additions & 3 deletions PKG-INFO
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Metadata-Version: 1.9.2
Metadata-Version: 1.10.0
Name: purity_fb
Version: 1.9.2
Summary: Pure Storage FlashBlade REST 1.9 Python SDK.
Version: 1.10.0
Summary: Pure Storage FlashBlade REST 1.10 Python SDK.
License: Apache 2.0
299 changes: 274 additions & 25 deletions README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | name of the object (e.g., a file system or snapshot) | [optional]
**name** | **str** | The name of the object (e.g., a file system or snapshot) | [optional]
**api_token** | [**AdminApiToken**](AdminApiToken.md) | | [optional]
**create_api_token** | **bool** | Create a new API token | [optional]
**api_token_timeout** | **int** | Expire api-token after this period (in milliseconds). | [optional]
Expand Down
20 changes: 10 additions & 10 deletions docs/AdminsApi.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# purity_fb_1dot9.AdminsApi
# purity_fb_1dot10.AdminsApi

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

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


# **list_admins**
Expand Down Expand Up @@ -42,12 +42,12 @@ if res:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**filter** | **str**| The filter to be used for query. | [optional]
**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]
**ids** | **list[str]**| A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional]
**limit** | **int**| limit, should be >= 0 | [optional]
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
**sort** | **str**| The way to order the results. | [optional]
**start** | **int**| start | [optional]
**token** | **str**| token | [optional]
**names** | **list[str]**| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
**sort** | **str**| Sort the response by the specified fields (in descending order if '-' is appended to the field name). | [optional]
**start** | **int**| The offset of the first resource to return from a collection. | [optional]
**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]
**expose** | **bool**| Display the unmasked API token. This is only valid when listing your own token. | [optional] [default to false]

### Return type
Expand Down Expand Up @@ -99,8 +99,8 @@ if res:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**admin** | [**Admin**](Admin.md)| |
**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]
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
**ids** | **list[str]**| A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional]
**names** | **list[str]**| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]

### Return type

Expand Down
20 changes: 10 additions & 10 deletions docs/AdminsCacheApi.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# purity_fb_1dot9.AdminsCacheApi
# purity_fb_1dot10.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.9/admins/cache |
[**list_admin_cache**](AdminsCacheApi.md#list_admin_cache) | **GET** /1.9/admins/cache |
[**delete_admin_cache**](AdminsCacheApi.md#delete_admin_cache) | **DELETE** /1.10/admins/cache |
[**list_admin_cache**](AdminsCacheApi.md#list_admin_cache) | **GET** /1.10/admins/cache |


# **delete_admin_cache**
Expand Down Expand Up @@ -40,8 +40,8 @@ if res:

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

### Return type

Expand Down Expand Up @@ -92,12 +92,12 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**refresh** | **bool**| Whether to refresh the user info from directory service | [optional] [default to false]
**filter** | **str**| The filter to be used for query. | [optional]
**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]
**ids** | **list[str]**| A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional]
**limit** | **int**| limit, should be >= 0 | [optional]
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
**sort** | **str**| The way to order the results. | [optional]
**start** | **int**| start | [optional]
**token** | **str**| token | [optional]
**names** | **list[str]**| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
**sort** | **str**| Sort the response by the specified fields (in descending order if '-' is appended to the field name). | [optional]
**start** | **int**| The offset of the first resource to return from a collection. | [optional]
**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]

### Return type

Expand Down
4 changes: 2 additions & 2 deletions docs/Alert.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
## Properties
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]
**name** | **str** | The name of the object (e.g., a file system or snapshot) | [optional]
**created** | **int** | Creation timestamp of the object | [optional]
**index** | **int** | the unique index of the alert | [optional]
**code** | **int** | alert code | [optional]
**severity** | **str** | Severity of the alert. Possible values are info, warning and critical. | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/AlertWatcherTest.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | name of the object (e.g., a file system or snapshot) | [optional]
**name** | **str** | The name of the object (e.g., a file system or snapshot) | [optional]
**accepted** | **bool** | is the email accepted? | [optional]
**error** | **str** | error message (if failed) | [optional]

Expand Down
32 changes: 16 additions & 16 deletions docs/AlertWatchersApi.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# purity_fb_1dot9.AlertWatchersApi
# purity_fb_1dot10.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.9/alert-watchers |
[**delete_alert_watchers**](AlertWatchersApi.md#delete_alert_watchers) | **DELETE** /1.9/alert-watchers |
[**list_alert_watchers**](AlertWatchersApi.md#list_alert_watchers) | **GET** /1.9/alert-watchers |
[**test_alert_watchers**](AlertWatchersApi.md#test_alert_watchers) | **GET** /1.9/alert-watchers/test |
[**update_alert_watchers**](AlertWatchersApi.md#update_alert_watchers) | **PATCH** /1.9/alert-watchers |
[**create_alert_watchers**](AlertWatchersApi.md#create_alert_watchers) | **POST** /1.10/alert-watchers |
[**delete_alert_watchers**](AlertWatchersApi.md#delete_alert_watchers) | **DELETE** /1.10/alert-watchers |
[**list_alert_watchers**](AlertWatchersApi.md#list_alert_watchers) | **GET** /1.10/alert-watchers |
[**test_alert_watchers**](AlertWatchersApi.md#test_alert_watchers) | **GET** /1.10/alert-watchers/test |
[**update_alert_watchers**](AlertWatchersApi.md#update_alert_watchers) | **PATCH** /1.10/alert-watchers |


# **create_alert_watchers**
Expand Down Expand Up @@ -49,7 +49,7 @@ if res:

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

### Return type
Expand Down Expand Up @@ -98,7 +98,7 @@ if res:

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

### Return type

Expand Down Expand Up @@ -149,12 +149,12 @@ if res:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**filter** | **str**| The filter to be used for query. | [optional]
**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]
**ids** | **list[str]**| A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional]
**limit** | **int**| limit, should be >= 0 | [optional]
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
**sort** | **str**| The way to order the results. | [optional]
**start** | **int**| start | [optional]
**token** | **str**| token | [optional]
**names** | **list[str]**| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
**sort** | **str**| Sort the response by the specified fields (in descending order if '-' is appended to the field name). | [optional]
**start** | **int**| The offset of the first resource to return from a collection. | [optional]
**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]

### Return type

Expand Down Expand Up @@ -202,7 +202,7 @@ if res:

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

### Return type

Expand Down Expand Up @@ -262,8 +262,8 @@ if res:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**watcher_settings** | [**AlertWatcher**](AlertWatcher.md)| |
**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]
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
**ids** | **list[str]**| A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional]
**names** | **list[str]**| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]

### Return type

Expand Down
18 changes: 9 additions & 9 deletions docs/AlertsApi.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# purity_fb_1dot9.AlertsApi
# purity_fb_1dot10.AlertsApi

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

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


# **list_alerts**
Expand Down Expand Up @@ -40,12 +40,12 @@ if res:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**filter** | **str**| The filter to be used for query. | [optional]
**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]
**ids** | **list[str]**| A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional]
**limit** | **int**| limit, should be >= 0 | [optional]
**names** | [**list[str]**](str.md)| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
**sort** | **str**| The way to order the results. | [optional]
**start** | **int**| start | [optional]
**token** | **str**| token | [optional]
**names** | **list[str]**| A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional]
**sort** | **str**| Sort the response by the specified fields (in descending order if '-' is appended to the field name). | [optional]
**start** | **int**| The offset of the first resource to return from a collection. | [optional]
**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]

### Return type

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

### Return type

Expand Down
Loading

0 comments on commit 96161a2

Please sign in to comment.