Skip to content

Update to purefusion-1.3.0 #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
purestorage-fusion wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update to purefusion-1.3.0 #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
12 changes: 8 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ Pure Fusion is fully API-driven. Most APIs which change the system (POST, PATCH,

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

- API version: 1.2
- Package version: 1.2.0
- API version: 1.3
- Package version: 1.3.0
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

## Requirements.
Expand Down Expand Up @@ -212,7 +212,7 @@ except ApiException as e:

## Documentation for API Endpoints

All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.2*
All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.3*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
Expand All @@ -239,6 +239,7 @@ Class | Method | HTTP request | Description
*HostAccessPoliciesApi* | [**get_host_access_policy**](docs/HostAccessPoliciesApi.md#get_host_access_policy) | **GET** /host-access-policies/{host_access_policy_name} | Gets a specific Host Access Policy.
*HostAccessPoliciesApi* | [**get_host_access_policy_by_id**](docs/HostAccessPoliciesApi.md#get_host_access_policy_by_id) | **GET** /resources/host-access-policies/{host_access_policy_id} | Gets a specific Host Access Policy.
*HostAccessPoliciesApi* | [**list_host_access_policies**](docs/HostAccessPoliciesApi.md#list_host_access_policies) | **GET** /host-access-policies | Gets a list of all Host Access Policies.
*HostAccessPoliciesApi* | [**update_host_access_policy**](docs/HostAccessPoliciesApi.md#update_host_access_policy) | **PATCH** /host-access-policies/{host_access_policy_name} | Updates a Host Access Policy.
*IdentityManagerApi* | [**create_api_client**](docs/IdentityManagerApi.md#create_api_client) | **POST** /api-clients | Creates an API Client
*IdentityManagerApi* | [**delete_api_client**](docs/IdentityManagerApi.md#delete_api_client) | **DELETE** /api-clients/{api_client_id} | Deletes a specific API Client
*IdentityManagerApi* | [**get_api_client**](docs/IdentityManagerApi.md#get_api_client) | **GET** /api-clients/{api_client_id} | Gets a specific API Client
Expand All @@ -258,6 +259,7 @@ Class | Method | HTTP request | Description
*OperationsApi* | [**get_operation**](docs/OperationsApi.md#get_operation) | **GET** /operations/{id} | Gets a specific Operation.
*OperationsApi* | [**get_operation_by_id**](docs/OperationsApi.md#get_operation_by_id) | **GET** /resources/operations/{id} | Gets a specific Operation.
*OperationsApi* | [**list_operations**](docs/OperationsApi.md#list_operations) | **GET** /operations | Gets a list of Operations matching the criteria.
*OperationsApi* | [**update_operation**](docs/OperationsApi.md#update_operation) | **PATCH** /operations/{id} | Updates a specific Operation.
*PlacementGroupsApi* | [**create_placement_group**](docs/PlacementGroupsApi.md#create_placement_group) | **POST** /tenants/{tenant_name}/tenant-spaces/{tenant_space_name}/placement-groups | Creates a Placement Group.
*PlacementGroupsApi* | [**delete_placement_group**](docs/PlacementGroupsApi.md#delete_placement_group) | **DELETE** /tenants/{tenant_name}/tenant-spaces/{tenant_space_name}/placement-groups/{placement_group_name} | Deletes a specific Placement Group.
*PlacementGroupsApi* | [**get_placement_group**](docs/PlacementGroupsApi.md#get_placement_group) | **GET** /tenants/{tenant_name}/tenant-spaces/{tenant_space_name}/placement-groups/{placement_group_name} | Gets a specific Placement Group.
Expand Down Expand Up @@ -332,10 +334,10 @@ Class | Method | HTTP request | Description
*TenantsApi* | [**list_tenants**](docs/TenantsApi.md#list_tenants) | **GET** /tenants | Gets a list of all Tenants.
*TenantsApi* | [**query_tenants**](docs/TenantsApi.md#query_tenants) | **GET** /resources/tenants | Get all Tenants in the org. Provide a filter to search for specific Tenants.
*TenantsApi* | [**update_tenant**](docs/TenantsApi.md#update_tenant) | **PATCH** /tenants/{tenant_name} | Updates a Tenant.
*VolumeSnapshotsApi* | [**query_volume_snapshots**](docs/VolumeSnapshotsApi.md#query_volume_snapshots) | **GET** /resources/volume-snapshots | Get all Volume Snapshots in the org. Provide a filter to search for specific volume snapshots.
*VolumeSnapshotsApi* | [**get_volume_snapshot**](docs/VolumeSnapshotsApi.md#get_volume_snapshot) | **GET** /tenants/{tenant_name}/tenant-spaces/{tenant_space_name}/snapshots/{snapshot_name}/volume-snapshots/{volume_snapshot_name} | Gets a specific Volume Snapshot.
*VolumeSnapshotsApi* | [**get_volume_snapshot_by_id**](docs/VolumeSnapshotsApi.md#get_volume_snapshot_by_id) | **GET** /resources/volume-snapshots/{volume_snapshot_id} | Gets a specific Volume Snapshot.
*VolumeSnapshotsApi* | [**list_volume_snapshots**](docs/VolumeSnapshotsApi.md#list_volume_snapshots) | **GET** /tenants/{tenant_name}/tenant-spaces/{tenant_space_name}/snapshots/{snapshot_name}/volume-snapshots | Gets a list of all Volume snapshots in a Snapshot.
*VolumeSnapshotsApi* | [**query_volume_snapshots**](docs/VolumeSnapshotsApi.md#query_volume_snapshots) | **GET** /resources/volume-snapshots | Get all Volume Snapshots in the org. Provide a filter to search for specific volume snapshots.
*VolumesApi* | [**create_volume**](docs/VolumesApi.md#create_volume) | **POST** /tenants/{tenant_name}/tenant-spaces/{tenant_space_name}/volumes | Creates a Volume.
*VolumesApi* | [**delete_volume**](docs/VolumesApi.md#delete_volume) | **DELETE** /tenants/{tenant_name}/tenant-spaces/{tenant_space_name}/volumes/{volume_name} | Eradicate a specific volume. Volume has to be destroyed before it can be eradicated.
*VolumesApi* | [**get_volume**](docs/VolumesApi.md#get_volume) | **GET** /tenants/{tenant_name}/tenant-spaces/{tenant_space_name}/volumes/{volume_name} | Gets a specific Volume.
Expand Down Expand Up @@ -370,6 +372,7 @@ Class | Method | HTTP request | Description
- [HostAccessPoliciesPost](docs/HostAccessPoliciesPost.md)
- [HostAccessPolicy](docs/HostAccessPolicy.md)
- [HostAccessPolicyList](docs/HostAccessPolicyList.md)
- [HostAccessPolicyPatch](docs/HostAccessPolicyPatch.md)
- [HostAccessPolicyRef](docs/HostAccessPolicyRef.md)
- [Iscsi](docs/Iscsi.md)
- [ListResponseFields](docs/ListResponseFields.md)
Expand All @@ -395,6 +398,7 @@ Class | Method | HTTP request | Description
- [OneOfProtectionPolicyPostObjectivesItems](docs/OneOfProtectionPolicyPostObjectivesItems.md)
- [Operation](docs/Operation.md)
- [OperationList](docs/OperationList.md)
- [OperationPatch](docs/OperationPatch.md)
- [OperationRequest](docs/OperationRequest.md)
- [OperationResult](docs/OperationResult.md)
- [OperationState](docs/OperationState.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/ArraysApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# fusion.ArraysApi

All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.2*
All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.3*

Method | HTTP request | Description
------------- | ------------- | -------------
Expand Down
2 changes: 1 addition & 1 deletion docs/AvailabilityZonesApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# fusion.AvailabilityZonesApi

All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.2*
All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.3*

Method | HTTP request | Description
------------- | ------------- | -------------
Expand Down
2 changes: 1 addition & 1 deletion docs/DefaultApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# fusion.DefaultApi

All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.2*
All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.3*

Method | HTTP request | Description
------------- | ------------- | -------------
Expand Down
2 changes: 1 addition & 1 deletion docs/HardwareTypesApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# fusion.HardwareTypesApi

All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.2*
All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.3*

Method | HTTP request | Description
------------- | ------------- | -------------
Expand Down
61 changes: 60 additions & 1 deletion docs/HostAccessPoliciesApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# fusion.HostAccessPoliciesApi

All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.2*
All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.3*

Method | HTTP request | Description
------------- | ------------- | -------------
Expand All @@ -9,6 +9,7 @@ Method | HTTP request | Description
[**get_host_access_policy**](HostAccessPoliciesApi.md#get_host_access_policy) | **GET** /host-access-policies/{host_access_policy_name} | Gets a specific Host Access Policy.
[**get_host_access_policy_by_id**](HostAccessPoliciesApi.md#get_host_access_policy_by_id) | **GET** /resources/host-access-policies/{host_access_policy_id} | Gets a specific Host Access Policy.
[**list_host_access_policies**](HostAccessPoliciesApi.md#list_host_access_policies) | **GET** /host-access-policies | Gets a list of all Host Access Policies.
[**update_host_access_policy**](HostAccessPoliciesApi.md#update_host_access_policy) | **PATCH** /host-access-policies/{host_access_policy_name} | Updates a Host Access Policy.

# **create_host_access_policy**
> Operation create_host_access_policy(body, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
Expand Down Expand Up @@ -288,3 +289,61 @@ Name | Type | Description | Notes

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_host_access_policy**
> Operation update_host_access_policy(body, host_access_policy_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

Updates a Host Access Policy.

### Example
```python
from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.HostAccessPoliciesApi(fusion.ApiClient(configuration))
body = fusion.HostAccessPolicyPatch() # HostAccessPolicyPatch |
host_access_policy_name = 'host_access_policy_name_example' # str | The Host policy name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
# Updates a Host Access Policy.
api_response = api_instance.update_host_access_policy(body, host_access_policy_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling HostAccessPoliciesApi->update_host_access_policy: %s\n" % e)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**HostAccessPolicyPatch**](HostAccessPolicyPatch.md)| |
**host_access_policy_name** | **str**| The Host policy name |
**x_request_id** | **str**| The Request ID supplied with the request, used to perform operations idempotently. | [optional]
**authorization** | **str**| Access token (in JWT format) required to use any API endpoint. | [optional]
**x_correlation_id** | **str**| The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. | [optional]

### Return type

[**Operation**](Operation.md)

### Authorization

[accessToken](../README.md#accessToken), [oauth](../README.md#oauth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

8 changes: 8 additions & 0 deletions docs/HostAccessPolicyPatch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# HostAccessPolicyPatch

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

2 changes: 1 addition & 1 deletion docs/IdentityManagerApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# fusion.IdentityManagerApi

All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.2*
All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.3*

Method | HTTP request | Description
------------- | ------------- | -------------
Expand Down
2 changes: 1 addition & 1 deletion docs/ListResponseFields.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **int** | count of items in the list |
**more_items_remaining** | **bool** | True if not all items in the search were returned in the provided array. | [optional]
**more_items_remaining** | **bool** | True if not all items in the search were returned in the provided array. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

2 changes: 1 addition & 1 deletion docs/NetworkInterfaceGroupsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# fusion.NetworkInterfaceGroupsApi

All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.2*
All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.3*

Method | HTTP request | Description
------------- | ------------- | -------------
Expand Down
2 changes: 1 addition & 1 deletion docs/NetworkInterfacesApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# fusion.NetworkInterfacesApi

All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.2*
All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.3*

Method | HTTP request | Description
------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions docs/Operation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Name | Type | Description | Notes
**created_at** | **int** | The time that the operation was created, in milliseconds since the Unix epoch. |
**started_at** | **int** | The time that the operation was admitted, in milliseconds since the Unix epoch. |
**ended_at** | **int** | The time that the operation ended with status Succeeded or Failed, in milliseconds since the Unix epoch. |
**cancelation** | **str** | The cancelation status of the operation, one of five values. CancelNone means no cancelation has been requested or occured. CancelRequested means the user or system has requested to cancel the operation; it may or may not happen. CancelInProgress means the system has accepted the request to cancel and is trying to do so; once an operation is in Canceling status, it will fail. CancelSuccessful means an operation has failed with a CANCELED error code. CancelUnsuccessful means cancel was requested, but the system could not cancel the operation -- it may have failed with an error code other than CANCELED; or it may have succeeded. |
**update_fields** | **dict(str, str)** | Key/value pairs of the fields this operation is updating, if it is an Update operation. E.g. destroyed:true or size:1048576. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
9 changes: 9 additions & 0 deletions docs/OperationPatch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# OperationPatch

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cancel** | [**NullableBoolean**](NullableBoolean.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

61 changes: 60 additions & 1 deletion docs/OperationsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# fusion.OperationsApi

All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.2*
All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.3*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_operation**](OperationsApi.md#get_operation) | **GET** /operations/{id} | Gets a specific Operation.
[**get_operation_by_id**](OperationsApi.md#get_operation_by_id) | **GET** /resources/operations/{id} | Gets a specific Operation.
[**list_operations**](OperationsApi.md#list_operations) | **GET** /operations | Gets a list of Operations matching the criteria.
[**update_operation**](OperationsApi.md#update_operation) | **PATCH** /operations/{id} | Updates a specific Operation.

# **get_operation**
> Operation get_operation(id, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
Expand Down Expand Up @@ -202,3 +203,61 @@ Name | Type | Description | Notes

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_operation**
> Operation update_operation(body, id, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

Updates a specific Operation.

### Example
```python
from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.OperationsApi(fusion.ApiClient(configuration))
body = fusion.OperationPatch() # OperationPatch |
id = 'id_example' # str | The Operation ID
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
# Updates a specific Operation.
api_response = api_instance.update_operation(body, id, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OperationsApi->update_operation: %s\n" % e)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**OperationPatch**](OperationPatch.md)| |
**id** | **str**| The Operation ID |
**x_request_id** | **str**| The Request ID supplied with the request, used to perform operations idempotently. | [optional]
**authorization** | **str**| Access token (in JWT format) required to use any API endpoint. | [optional]
**x_correlation_id** | **str**| The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. | [optional]

### Return type

[**Operation**](Operation.md)

### Authorization

[accessToken](../README.md#accessToken), [oauth](../README.md#oauth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

2 changes: 1 addition & 1 deletion docs/PlacementGroupsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# fusion.PlacementGroupsApi

All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.2*
All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.3*

Method | HTTP request | Description
------------- | ------------- | -------------
Expand Down
2 changes: 1 addition & 1 deletion docs/ProtectionPoliciesApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# fusion.ProtectionPoliciesApi

All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.2*
All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.3*

Method | HTTP request | Description
------------- | ------------- | -------------
Expand Down
2 changes: 1 addition & 1 deletion docs/RegionsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# fusion.RegionsApi

All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.2*
All URIs are relative to *https://api.pure1.purestorage.com/fusion/api/1.3*

Method | HTTP request | Description
------------- | ------------- | -------------
Expand Down
Loading