vsphere-automation-vapi 0.4.5 → 0.4.6

data/docs/RestNavigationRootApi.md

@@ -1,61 +0,0 @@
-# VSphereAutomation::VAPI::RestNavigationRootApi
-
-All URIs are relative to *https://<vcenter>/rest*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get**](RestNavigationRootApi.md#get) | **GET** /com/vmware/vapi/rest/navigation/root | Retrieves information about a vAPI REST {@link Root}.
-
-
-# **get**
-> VapiRestNavigationRootResult get(opts)
-
-Retrieves information about a vAPI REST {@link Root}.
-
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-vapi'
-# setup authorization
-VSphereAutomation::Configuration.new.tap do |config|
-  # Configure API key authorization: api_key
-  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
-end
-
-api_instance = VSphereAutomation::VAPI::RestNavigationRootApi.new
-opts = {
-  base_url: 'base_url_example' # String | Base URL.
-}
-
-begin
-  #Retrieves information about a vAPI REST {@link Root}.
-  result = api_instance.get(opts)
-  p result
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling RestNavigationRootApi->get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **base_url** | **String**| Base URL. | [optional] 
-
-### Return type
-
-[**VapiRestNavigationRootResult**](VapiRestNavigationRootResult.md)
-
-### Authorization
-
-[api_key](../README.md#api_key)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-

data/docs/RestNavigationServiceApi.md

@@ -1,63 +0,0 @@
-# VSphereAutomation::VAPI::RestNavigationServiceApi
-
-All URIs are relative to *https://<vcenter>/rest*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**list**](RestNavigationServiceApi.md#list) | **GET** /com/vmware/vapi/rest/navigation/service | Gets list of all vAPI REST {@link Service}s for a vAPI REST {@link Component}.
-
-
-# **list**
-> VapiRestNavigationServiceListResult list(component_id, opts)
-
-Gets list of all vAPI REST {@link Service}s for a vAPI REST {@link Component}.
-
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-vapi'
-# setup authorization
-VSphereAutomation::Configuration.new.tap do |config|
-  # Configure API key authorization: api_key
-  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
-end
-
-api_instance = VSphereAutomation::VAPI::RestNavigationServiceApi.new
-component_id = 'component_id_example' # String | Component identifier.
-opts = {
-  base_url: 'base_url_example' # String | Base URL.
-}
-
-begin
-  #Gets list of all vAPI REST {@link Service}s for a vAPI REST {@link Component}.
-  result = api_instance.list(component_id, opts)
-  p result
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling RestNavigationServiceApi->list: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **component_id** | **String**| Component identifier. | 
- **base_url** | **String**| Base URL. | [optional] 
-
-### Return type
-
-[**VapiRestNavigationServiceListResult**](VapiRestNavigationServiceListResult.md)
-
-### Authorization
-
-[api_key](../README.md#api_key)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-

data/docs/VapiMetadataAuthenticationAuthenticationInfo.md

@@ -1,10 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataAuthenticationAuthenticationInfo
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**scheme_type** | [**VapiMetadataAuthenticationAuthenticationInfoSchemeType**](VapiMetadataAuthenticationAuthenticationInfoSchemeType.md) |  | 
-**session_manager** | **String** | In a session aware authentication scheme, a session manager is required that supports {@code create}, {@code delete} and {@code keepAlive} {@term operations}. The fully qualified {@term service} name of the session manager is provided in {@link AuthenticationInfo#sessionManager} {@term field}. This {@term service} is responsible for handling sessions. | [optional] 
-**scheme** | **String** | String identifier of the authentication scheme. <p> Following are the supported authentication schemes by the infrastructure: <ul> <li>The identifier {@code vapi.std.security.saml_hok_token} for SAML holder of key token based authentication mechanism. </li> <li>The identifier {@code vapi.std.security.bearer_token} for SAML bearer token based authentication mechanism. </li> <li>The identifier {@code vapi.std.security.session_id} for session based authentication mechanism. </li> <li>The identifier {@code vapi.std.security.user_pass} for username and password based authentication mechanism. </li> </ul> | 
-
-

data/docs/VapiMetadataAuthenticationAuthenticationInfoSchemeType.md

@@ -1,7 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataAuthenticationAuthenticationInfoSchemeType
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-

data/docs/VapiMetadataAuthenticationComponentData.md

@@ -1,9 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataAuthenticationComponentData
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**info** | [**VapiMetadataAuthenticationComponentInfo**](VapiMetadataAuthenticationComponentInfo.md) |  | 
-**fingerprint** | **String** | Fingerprint of the metadata of the component. <p> Authentication information could change when there is an infrastructure update. Since the data present in {@link ComponentData#info} could be quite large, {@name #fingerprint} provides a convenient way to check if the data for a particular component is updated. <p> You should store the fingerprint associated with a component. After an update, by invoking the {@link vapi.metadata.authentication.Component#fingerprint} {@term operation}, you can retrieve the new fingerprint for the component. If the new fingerprint and the previously stored fingerprint do not match, clients can then use the {@link vapi.metadata.authentication.Component#get} to retrieve the new authentication information for the component. | 
-
-

data/docs/VapiMetadataAuthenticationComponentFingerprintResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataAuthenticationComponentFingerprintResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | **String** |  | 
-
-

data/docs/VapiMetadataAuthenticationComponentInfo.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataAuthenticationComponentInfo
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**packages** | [**Array<VapiMetadataAuthenticationComponentInfoPackages>**](VapiMetadataAuthenticationComponentInfoPackages.md) | Authentication information of all the package elements. The key in the {@term map} is the identifier of the package element and the value in the {@term map} is the authentication information for the package element. <p> For an explanation of authentication information containment within package elements, see {@link vapi.metadata.authentication.Package}. | 
-
-

data/docs/VapiMetadataAuthenticationComponentInfoPackages.md

@@ -1,9 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataAuthenticationComponentInfoPackages
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**key** | **String** |  | [optional] 
-**value** | [**VapiMetadataAuthenticationPackageInfo**](VapiMetadataAuthenticationPackageInfo.md) |  | [optional] 
-
-

data/docs/VapiMetadataAuthenticationComponentListResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataAuthenticationComponentListResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | **Array<String>** |  | 
-
-

data/docs/VapiMetadataAuthenticationComponentResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataAuthenticationComponentResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | [**VapiMetadataAuthenticationComponentData**](VapiMetadataAuthenticationComponentData.md) |  | 
-
-

data/docs/VapiMetadataAuthenticationOperationInfo.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataAuthenticationOperationInfo
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**schemes** | [**Array<VapiMetadataAuthenticationAuthenticationInfo>**](VapiMetadataAuthenticationAuthenticationInfo.md) | List of authentication schemes used by an operation element. The authentication scheme specified on the service element corresponding to this operation element is ignored. | 
-
-

data/docs/VapiMetadataAuthenticationPackageInfo.md

@@ -1,9 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataAuthenticationPackageInfo
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**schemes** | [**Array<VapiMetadataAuthenticationAuthenticationInfo>**](VapiMetadataAuthenticationAuthenticationInfo.md) | List of authentication schemes to be used for all the operation elements contained in this package element. If a particular service or operation element has no explicit authentications defined in the authentication defintion file, these authentication schemes are used for authenticating the user. | 
-**services** | [**Array<VapiMetadataAuthenticationPackageInfoServices>**](VapiMetadataAuthenticationPackageInfoServices.md) | Information about all service elements contained in this package element that contain authentication information. The key in the {@term map} is the identifier of the service element and the value in the {@term map} is the authentication information for the service element. <p> For an explanation of authentication information containment within service elements, see {@link vapi.metadata.authentication.Service}. | 
-
-

data/docs/VapiMetadataAuthenticationPackageInfoServices.md

@@ -1,9 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataAuthenticationPackageInfoServices
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**key** | **String** |  | [optional] 
-**value** | [**VapiMetadataAuthenticationServiceInfo**](VapiMetadataAuthenticationServiceInfo.md) |  | [optional] 
-
-

data/docs/VapiMetadataAuthenticationPackageListResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataAuthenticationPackageListResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | **Array<String>** |  | 
-
-

data/docs/VapiMetadataAuthenticationPackageResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataAuthenticationPackageResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | [**VapiMetadataAuthenticationPackageInfo**](VapiMetadataAuthenticationPackageInfo.md) |  | 
-
-

data/docs/VapiMetadataAuthenticationServiceInfo.md

@@ -1,9 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataAuthenticationServiceInfo
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**schemes** | [**Array<VapiMetadataAuthenticationAuthenticationInfo>**](VapiMetadataAuthenticationAuthenticationInfo.md) | List of authentication schemes to be used for all the operation elements contained in this service element. The authentication scheme specified on the package element corresponding to this service element is ignored. | 
-**operations** | [**Array<VapiMetadataAuthenticationServiceInfoOperations>**](VapiMetadataAuthenticationServiceInfoOperations.md) | Information about all operation elements contained in this service element that contain authentication information. The key in the {@term map} is the identifier of the operation element and the value in the {@term map} is the authentication information for the operation element. <p> For an explanation of containment of authentication information within operation elements, see {@link vapi.metadata.authentication.service.Operation}. | 
-
-

data/docs/VapiMetadataAuthenticationServiceInfoOperations.md

@@ -1,9 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataAuthenticationServiceInfoOperations
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**key** | **String** |  | [optional] 
-**value** | [**VapiMetadataAuthenticationOperationInfo**](VapiMetadataAuthenticationOperationInfo.md) |  | [optional] 
-
-

data/docs/VapiMetadataAuthenticationServiceListResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataAuthenticationServiceListResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | **Array<String>** |  | 
-
-

data/docs/VapiMetadataAuthenticationServiceOperationGet.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataAuthenticationServiceOperationGet
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**operation_id** | **String** | Identifier of the operation element. | 
-
-

data/docs/VapiMetadataAuthenticationServiceOperationListResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataAuthenticationServiceOperationListResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | **Array<String>** |  | 
-
-

data/docs/VapiMetadataAuthenticationServiceOperationResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataAuthenticationServiceOperationResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | [**VapiMetadataAuthenticationOperationInfo**](VapiMetadataAuthenticationOperationInfo.md) |  | 
-
-

data/docs/VapiMetadataAuthenticationServiceResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataAuthenticationServiceResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | [**VapiMetadataAuthenticationServiceInfo**](VapiMetadataAuthenticationServiceInfo.md) |  | 
-
-

data/docs/VapiMetadataCliCommandFingerprintResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataCliCommandFingerprintResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | **String** |  | 
-
-

data/docs/VapiMetadataCliCommandFormatterType.md

@@ -1,7 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataCliCommandFormatterType
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-

data/docs/VapiMetadataCliCommandGenericType.md

@@ -1,7 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataCliCommandGenericType
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-

data/docs/VapiMetadataCliCommandGet.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataCliCommandGet
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**identity** | [**VapiMetadataCliCommandIdentity**](VapiMetadataCliCommandIdentity.md) |  | 
-
-

data/docs/VapiMetadataCliCommandIdentity.md

@@ -1,9 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataCliCommandIdentity
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**path** | **String** | The dot-separated path of the namespace containing the command in the CLI command tree. | 
-**name** | **String** | Name of the command. | 
-
-

data/docs/VapiMetadataCliCommandInfo.md

@@ -1,14 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataCliCommandInfo
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**identity** | [**VapiMetadataCliCommandIdentity**](VapiMetadataCliCommandIdentity.md) |  | 
-**description** | **String** | The text description displayed to the user in help output. | 
-**service_id** | **String** | The service identifier that contains the operations for this CLI command. | 
-**operation_id** | **String** | The operation identifier corresponding to this CLI command. | 
-**options** | [**Array<VapiMetadataCliCommandOptionInfo>**](VapiMetadataCliCommandOptionInfo.md) | The input for this command. | 
-**formatter** | [**VapiMetadataCliCommandFormatterType**](VapiMetadataCliCommandFormatterType.md) |  | [optional] 
-**output_field_list** | [**Array<VapiMetadataCliCommandOutputInfo>**](VapiMetadataCliCommandOutputInfo.md) | List of output structure name and output field info. | 
-
-

data/docs/VapiMetadataCliCommandListResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataCliCommandListResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | [**Array<VapiMetadataCliCommandIdentity>**](VapiMetadataCliCommandIdentity.md) |  | 
-
-

data/docs/VapiMetadataCliCommandOptionInfo.md

@@ -1,13 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataCliCommandOptionInfo
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**long_option** | **String** | The long option name of the parameter as used by the user. | 
-**short_option** | **String** | The single character value option name. | [optional] 
-**field_name** | **String** | The fully qualified name of the option referred to by the operation element in {@link Info#operationId}. | 
-**description** | **String** | The description of the option to be displayed to the user when they request usage information for a CLI command. | 
-**type** | **String** | The type of option. This is used to display information about what kind of data is expected (string, number, boolean, etc.) for the option when they request usage information for a CLI command. For {@term enumerated type} this stores the fully qualified {@term enumerated type} id. | 
-**generic** | [**VapiMetadataCliCommandGenericType**](VapiMetadataCliCommandGenericType.md) |  | 
-
-

data/docs/VapiMetadataCliCommandOutputFieldInfo.md

@@ -1,9 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataCliCommandOutputFieldInfo
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**field_name** | **String** | Name of the {@term field}. | 
-**display_name** | **String** | Name used by the CLI to display the {@term field}. | 
-
-

data/docs/VapiMetadataCliCommandOutputInfo.md

@@ -1,9 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataCliCommandOutputInfo
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**structure_id** | **String** | Name of the {@term structure}. | 
-**output_fields** | [**Array<VapiMetadataCliCommandOutputFieldInfo>**](VapiMetadataCliCommandOutputFieldInfo.md) | The order in which the {@term fields} of the {@term structure} will be displayed by the CLI as well as the names used to display the {@term fields}. | 
-
-

data/docs/VapiMetadataCliCommandResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::VAPI::VapiMetadataCliCommandResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | [**VapiMetadataCliCommandInfo**](VapiMetadataCliCommandInfo.md) |  | 
-
-