Skip to content

Fixes issues with required params in responses. #4

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

Merged
apecoraro merged 1 commit into from
Jun 7, 2016
Merged

Fixes issues with required params in responses. #4

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
  •  
  •  
  •  
67 changes: 52 additions & 15 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/AntivirusApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ isi_sdk.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk.AntivirusApi()
antivirus_policy = isi_sdk.AntivirusPolicy() # AntivirusPolicy |
antivirus_policy = isi_sdk.AntivirusPolicyCreateParams() # AntivirusPolicyCreateParams |

try:
api_response = api_instance.create_antivirus_policy(antivirus_policy)
Expand All @@ -62,7 +62,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**antivirus_policy** | [**AntivirusPolicy**](AntivirusPolicy.md)| |
**antivirus_policy** | [**AntivirusPolicyCreateParams**](AntivirusPolicyCreateParams.md)| |

### Return type

Expand Down Expand Up @@ -149,7 +149,7 @@ isi_sdk.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk.AntivirusApi()
antivirus_server = isi_sdk.AntivirusServer() # AntivirusServer |
antivirus_server = isi_sdk.AntivirusServerCreateParams() # AntivirusServerCreateParams |

try:
api_response = api_instance.create_antivirus_server(antivirus_server)
Expand All @@ -162,7 +162,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**antivirus_server** | [**AntivirusServer**](AntivirusServer.md)| |
**antivirus_server** | [**AntivirusServerCreateParams**](AntivirusServerCreateParams.md)| |

### Return type

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

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | A description for the policy. | [optional]
**enabled** | **bool** | Whether the policy is enabled. | [optional]
**force_run** | **bool** | Forces the scan to run regardless of whether the files were recently scanned. | [optional]
**impact** | **str** | The priority of the antivirus scan job. Must be a valid job engine impact policy, or null to use the default impact. | [optional]
**name** | **str** | The name of the policy. | [optional]
**paths** | **list[str]** | Paths to include in the scan. | [optional]
**recursion_depth** | **int** | The depth to recurse in directories. The default of -1 gives unlimited recursion. | [optional]
**schedule** | **str** | The schedule for running scans in isi date format. Examples include: 'every Friday' or 'every day at 4:00'. A null value means the policy is manually scheduled. | [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)


4 changes: 2 additions & 2 deletions docs/AntivirusQuarantine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**file** | **str** | Path of this file, starting with /ifs. |
**last_istag** | **str** | The ICAP Service Tag (ISTag) recorded for this file during the last scan, or null if no tag was recorded. For more information about ISTags, see https://tools.ietf.org/html/rfc3507. |
**last_scan** | **int** | The date and time this file was last scanned for viruses, as a UNIX timestamp. If null, the file has never been scanned. |
**last_istag** | **str** | The ICAP Service Tag (ISTag) recorded for this file during the last scan, or null if no tag was recorded. For more information about ISTags, see https://tools.ietf.org/html/rfc3507. | [optional]
**last_scan** | **int** | The date and time this file was last scanned for viruses, as a UNIX timestamp. If null, the file has never been scanned. | [optional]
**quarantined** | **bool** | If true, this file is quarantined. If false, the file is not quarantined. |
**scan_result** | **str** | The result of the last scan on this file. This string is usually one of: never_scanned, clean, quarantined, repaired, truncated, infected_no_action_taken, skipped_per_settings. However, a longer string starting with 'unknown_status' and describing the details can also appear in uncommon edge cases. |
**scan_status** | **str** | The scanning status of this file. If 'current', the file was scanned with the most up-to-date virus defintions. If 'not_current', it has either not been scanned, been modified since the last scan, or the virus definitions are not current. |
Expand Down
12 changes: 12 additions & 0 deletions docs/AntivirusServerCreateParams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# AntivirusServerCreateParams

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | A description for the server. | [optional]
**enabled** | **bool** | Whether the server is enabled. | [optional]
**url** | **str** | The icap url for the server. This should have a format of: icap://host.domain:port/path | [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)


12 changes: 6 additions & 6 deletions docs/AuthApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ isi_sdk.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk.AuthApi()
auth_role = isi_sdk.AuthRole() # AuthRole |
auth_role = isi_sdk.AuthRoleCreateParams() # AuthRoleCreateParams |

try:
api_response = api_instance.create_auth_role(auth_role)
Expand All @@ -228,7 +228,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**auth_role** | [**AuthRole**](AuthRole.md)| |
**auth_role** | [**AuthRoleCreateParams**](AuthRoleCreateParams.md)| |

### Return type

Expand Down Expand Up @@ -479,7 +479,7 @@ isi_sdk.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk.AuthApi()
providers_file_item = isi_sdk.ProvidersFileIdParams() # ProvidersFileIdParams |
providers_file_item = isi_sdk.ProvidersFileItem() # ProvidersFileItem |

try:
api_response = api_instance.create_providers_file_item(providers_file_item)
Expand All @@ -492,7 +492,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**providers_file_item** | [**ProvidersFileIdParams**](ProvidersFileIdParams.md)| |
**providers_file_item** | [**ProvidersFileItem**](ProvidersFileItem.md)| |

### Return type

Expand Down Expand Up @@ -3825,7 +3825,7 @@ isi_sdk.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk.AuthApi()
mapping_users_rules = isi_sdk.MappingUsersRulesRules() # MappingUsersRulesRules |
mapping_users_rules = isi_sdk.MappingUsersRulesExtended() # MappingUsersRulesExtended |

try:
api_instance.update_mapping_users_rules(mapping_users_rules)
Expand All @@ -3837,7 +3837,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**mapping_users_rules** | [**MappingUsersRulesRules**](MappingUsersRulesRules.md)| |
**mapping_users_rules** | [**MappingUsersRulesExtended**](MappingUsersRulesExtended.md)| |

### Return type

Expand Down
18 changes: 9 additions & 9 deletions docs/AuthGroupExtended.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**gid** | **int** | Specifies the numeric group identifier. | [optional]
**dn** | **str** | Specifies the distinguished name for the user. |
**dns_domain** | **str** | Specifies the DNS domain. |
**domain** | **str** | Specifies the domain that the object is part of. |
**generated_gid** | **bool** | If true, the GID was generated. |
**dn** | **str** | Specifies the distinguished name for the user. | [optional]
**dns_domain** | **str** | Specifies the DNS domain. | [optional]
**domain** | **str** | Specifies the domain that the object is part of. | [optional]
**generated_gid** | **bool** | If true, the GID was generated. | [optional]
**gid** | [**GroupMember**](GroupMember.md) | Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'. | [optional]
**id** | **str** | Specifies the user or group ID. |
**member_of** | [**list[GroupMember]**](GroupMember.md) | |
**member_of** | [**list[GroupMember]**](GroupMember.md) | | [optional]
**name** | **str** | Specifies a user or group name. |
**provider** | **str** | Specifies the authentication provider that the object belongs to. |
**sam_account_name** | **str** | Specifies a user or group name. |
**sid** | [**GroupMember**](GroupMember.md) | Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'. |
**provider** | **str** | Specifies the authentication provider that the object belongs to. | [optional]
**sam_account_name** | **str** | Specifies a user or group name. | [optional]
**sid** | [**GroupMember**](GroupMember.md) | Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'. | [optional]
**type** | **str** | Specifies the object type. |

[[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
2 changes: 1 addition & 1 deletion docs/AuthLogLevelExtended.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**level** | [**AuthLogLevelLevel**](AuthLogLevelLevel.md) | | [optional]
**level** | **str** | Valid auth logging levels | [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)

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

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | Specifies the description of the role. | [optional]
**members** | [**list[GroupMember]**](GroupMember.md) | Specifies the users or groups that have this role. | [optional]
**name** | **str** | Specifies the name of the role. | [optional]
**privileges** | [**list[AuthIdNtokenPrivilegeItem]**](AuthIdNtokenPrivilegeItem.md) | Specifies the privileges granted by this role. | [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)


8 changes: 4 additions & 4 deletions docs/ClusterApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ 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)

# **get_cluster_nodes**
> ClusterNodes get_cluster_nodes()
> ClusterNodesExtended get_cluster_nodes()



Expand Down Expand Up @@ -298,7 +298,7 @@ This endpoint does not need any parameter.

### Return type

[**ClusterNodes**](ClusterNodes.md)
[**ClusterNodesExtended**](ClusterNodesExtended.md)

### Authorization

Expand Down Expand Up @@ -764,7 +764,7 @@ isi_sdk.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk.ClusterApi()
cluster_identity = isi_sdk.ClusterIdentity() # ClusterIdentity |
cluster_identity = isi_sdk.ClusterIdentityExtended() # ClusterIdentityExtended |

try:
api_instance.update_cluster_identity(cluster_identity)
Expand All @@ -776,7 +776,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**cluster_identity** | [**ClusterIdentity**](ClusterIdentity.md)| |
**cluster_identity** | [**ClusterIdentityExtended**](ClusterIdentityExtended.md)| |

### Return type

Expand Down
2 changes: 1 addition & 1 deletion docs/ClusterConfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Name | Type | Description | Notes
**name** | **str** | Cluster name. |
**onefs_version** | [**ClusterConfigOnefsVersion**](ClusterConfigOnefsVersion.md) | | [optional]
**timezone** | [**ClusterConfigTimezone**](ClusterConfigTimezone.md) | The cluster timezone settings. | [optional]
**upgrade_type** | **str** | |
**upgrade_type** | **str** | | [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)

Expand Down
2 changes: 1 addition & 1 deletion docs/ClusterEmailSettings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Name | Type | Description | Notes
**smtp_auth_username** | **str** | Username to authenticate with if SMTP authentication is being used. |
**smtp_port** | **int** | The port on the SMTP server to be used for relaying the notification messages. |
**use_smtp_auth** | **bool** | If true, this cluster will send SMTP authentication credentials to the SMTP relay server in order to send its notification emails. If false, the cluster will attempt to send its notification emails without authentication. |
**user_template** | **str** | Location of a custom template file that can be used to specify the layout of the notification emails. |
**user_template** | **str** | Location of a custom template file that can be used to specify the layout of the notification emails. | [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)

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

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | A description of the cluster. | [optional]
**logon** | [**ClusterIdentityLogonExtended**](ClusterIdentityLogonExtended.md) | The information displayed when a user logs in to the cluster. | [optional]
**name** | **str** | The name of the cluster. | [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)


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

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**motd** | **str** | The message of the day. | [optional]
**motd_header** | **str** | The header to the message of the day. | [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)


2 changes: 1 addition & 1 deletion docs/ClusterNodeExtended.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**drives** | [**list[NodeDrivesNodeDrive]**](NodeDrivesNodeDrive.md) | List of the drives in this node. | [optional]
**state** | [**ClusterNodeState**](ClusterNodeState.md) | Node state information (reported and modifiable). | [optional]
**hardware** | [**ClusterNodeHardware**](ClusterNodeHardware.md) | Node hardware identifying information (static). | [optional]
**id** | **int** | Node ID (Device Number) of this node. | [optional]
**lnn** | **int** | Logical Node Number (LNN) of this node. | [optional]
**partitions** | [**ClusterNodePartitions**](ClusterNodePartitions.md) | Node partition information. | [optional]
**sensors** | [**ClusterNodeSensors**](ClusterNodeSensors.md) | Node sensor information (hardware reported). | [optional]
**state** | [**ClusterNodeStateExtended**](ClusterNodeStateExtended.md) | Node state information (reported and modifiable). | [optional]
**status** | [**ClusterNodeStatus**](ClusterNodeStatus.md) | Node status information (hardware reported). | [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)
Expand Down
17 changes: 17 additions & 0 deletions docs/ClusterNodeExtendedExtended.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# ClusterNodeExtendedExtended

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**drives** | [**list[NodeDrivesNodeDrive]**](NodeDrivesNodeDrive.md) | List of the drives in this node. | [optional]
**hardware** | [**ClusterNodeHardware**](ClusterNodeHardware.md) | Node hardware identifying information (static). | [optional]
**id** | **int** | Node ID (Device Number) of this node. | [optional]
**lnn** | **int** | Logical Node Number (LNN) of this node. | [optional]
**partitions** | [**ClusterNodePartitions**](ClusterNodePartitions.md) | Node partition information. | [optional]
**sensors** | [**ClusterNodeSensors**](ClusterNodeSensors.md) | Node sensor information (hardware reported). | [optional]
**state** | [**ClusterNodeStateExtendedExtended**](ClusterNodeStateExtendedExtended.md) | Node state information (reported and modifiable). | [optional]
**status** | [**ClusterNodeStatus**](ClusterNodeStatus.md) | Node status information (hardware reported). | [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)


6 changes: 3 additions & 3 deletions docs/ClusterNodeStateExtended.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**readonly** | [**Empty**](Empty.md) | Node readonly state. | [optional]
**servicelight** | [**ClusterNodeStateServicelight**](ClusterNodeStateServicelight.md) | Node service light state. | [optional]
**smartfail** | [**ClusterNodeStateSmartfail**](ClusterNodeStateSmartfail.md) | Node smartfail state. | [optional]
**readonly** | [**NodeStateReadonlyExtended**](NodeStateReadonlyExtended.md) | Node readonly state. | [optional]
**servicelight** | [**ClusterNodeStateServicelightExtended**](ClusterNodeStateServicelightExtended.md) | Node service light state. | [optional]
**smartfail** | [**NodeStateSmartfailExtended**](NodeStateSmartfailExtended.md) | Node smartfail state. | [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)

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

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**readonly** | [**NodeStateReadonlyExtended**](NodeStateReadonlyExtended.md) | Node readonly state. | [optional]
**servicelight** | [**ClusterNodeStateServicelightExtendedExtended**](ClusterNodeStateServicelightExtendedExtended.md) | Node service light state. | [optional]
**smartfail** | [**NodeStateSmartfailExtended**](NodeStateSmartfailExtended.md) | Node smartfail state. | [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)


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

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | The node service light state (True = on). | [optional]
**present** | **bool** | This node has a service light. | [optional]
**supported** | **bool** | This node supports a service light. | [optional]
**valid** | **bool** | The node service light state is valid (False = Error). | [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)


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

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | The node service light state (True = on). | [optional]
**present** | **bool** | This node has a service light. | [optional]
**supported** | **bool** | This node supports a service light. | [optional]
**valid** | **bool** | The node service light state is valid (False = Error). | [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)


2 changes: 1 addition & 1 deletion docs/ClusterNodesExtended.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**nodes** | [**list[ClusterNodeExtended]**](ClusterNodeExtended.md) | | [optional]
**nodes** | [**list[ClusterNodeExtendedExtended]**](ClusterNodeExtendedExtended.md) | | [optional]
**total** | **int** | Total number of items available. | [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)
Expand Down
Loading