vsphere-automation-vapi 0.1.0

data/docs/MetadataPrivilegeServiceOperationApi.md

@@ -0,0 +1,98 @@
+# VSphereAutomation::VAPI::MetadataPrivilegeServiceOperationApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get**](MetadataPrivilegeServiceOperationApi.md#get) | **POST** /com/vmware/vapi/metadata/privilege/service/operation/id:{service_id}?~action=get | Retrieves the privilege information about an operation element corresponding to {@param.name operationId} contained in the service element corresponding to {@param.name serviceId}.
+[**list**](MetadataPrivilegeServiceOperationApi.md#list) | **GET** /com/vmware/vapi/metadata/privilege/service/operation | Returns the identifiers for the operation elements contained in the service element corresponding to {@param.name serviceId} that have privilege information.
+
+
+# **get**
+> VapiMetadataPrivilegeServiceOperationResult get(service_id, vapi_metadata_privilege_service_operation_get)
+
+Retrieves the privilege information about an operation element corresponding to {@param.name operationId} contained in the service element corresponding to {@param.name serviceId}.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataPrivilegeServiceOperationApi.new
+service_id = 'service_id_example' # String | Identifier of the service element.
+vapi_metadata_privilege_service_operation_get = VSphereAutomation::VapiMetadataPrivilegeServiceOperationGet.new # VapiMetadataPrivilegeServiceOperationGet | 
+
+begin
+  #Retrieves the privilege information about an operation element corresponding to {@param.name operationId} contained in the service element corresponding to {@param.name serviceId}.
+  result = api_instance.get(service_id, vapi_metadata_privilege_service_operation_get)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataPrivilegeServiceOperationApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **service_id** | **String**| Identifier of the service element. | 
+ **vapi_metadata_privilege_service_operation_get** | [**VapiMetadataPrivilegeServiceOperationGet**](VapiMetadataPrivilegeServiceOperationGet.md)|  | 
+
+### Return type
+
+[**VapiMetadataPrivilegeServiceOperationResult**](VapiMetadataPrivilegeServiceOperationResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **list**
+> VapiMetadataPrivilegeServiceOperationListResult list(service_id)
+
+Returns the identifiers for the operation elements contained in the service element corresponding to {@param.name serviceId} that have privilege information.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataPrivilegeServiceOperationApi.new
+service_id = 'service_id_example' # String | Identifier of the service element.
+
+begin
+  #Returns the identifiers for the operation elements contained in the service element corresponding to {@param.name serviceId} that have privilege information.
+  result = api_instance.list(service_id)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataPrivilegeServiceOperationApi->list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **service_id** | **String**| Identifier of the service element. | 
+
+### Return type
+
+[**VapiMetadataPrivilegeServiceOperationListResult**](VapiMetadataPrivilegeServiceOperationListResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+

data/docs/RestNavigationComponentApi.md

@@ -0,0 +1,54 @@
+# VSphereAutomation::VAPI::RestNavigationComponentApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list**](RestNavigationComponentApi.md#list) | **GET** /com/vmware/vapi/rest/navigation/component | Gets list of all vAPI REST {@link Component}s.
+
+
+# **list**
+> VapiRestNavigationComponentListResult list(opts)
+
+Gets list of all vAPI REST {@link Component}s.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::RestNavigationComponentApi.new
+opts = {
+  base_url: 'base_url_example' # String | Base URL.
+}
+
+begin
+  #Gets list of all vAPI REST {@link Component}s.
+  result = api_instance.list(opts)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling RestNavigationComponentApi->list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **base_url** | **String**| Base URL. | [optional] 
+
+### Return type
+
+[**VapiRestNavigationComponentListResult**](VapiRestNavigationComponentListResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+

data/docs/RestNavigationOptionsApi.md

@@ -0,0 +1,52 @@
+# VSphereAutomation::VAPI::RestNavigationOptionsApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get**](RestNavigationOptionsApi.md#get) | **POST** /com/vmware/vapi/rest/navigation/options?~action=get | Retrieves operations for specific URL.
+
+
+# **get**
+> VapiRestNavigationOptionsResult get(vapi_rest_navigation_options_get)
+
+Retrieves operations for specific URL.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::RestNavigationOptionsApi.new
+vapi_rest_navigation_options_get = VSphereAutomation::VapiRestNavigationOptionsGet.new # VapiRestNavigationOptionsGet | 
+
+begin
+  #Retrieves operations for specific URL.
+  result = api_instance.get(vapi_rest_navigation_options_get)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling RestNavigationOptionsApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **vapi_rest_navigation_options_get** | [**VapiRestNavigationOptionsGet**](VapiRestNavigationOptionsGet.md)|  | 
+
+### Return type
+
+[**VapiRestNavigationOptionsResult**](VapiRestNavigationOptionsResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+

data/docs/RestNavigationResourceApi.md

@@ -0,0 +1,104 @@
+# VSphereAutomation::VAPI::RestNavigationResourceApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get**](RestNavigationResourceApi.md#get) | **GET** /com/vmware/vapi/rest/navigation/resource/id:{type_id}/id:{instance_id} | Gets {@link List} of all {@link Operation}s about a vAPI REST {@link Resource}. Information is searched for by {@param.name typeId} and {@param.name instanceId} is used only in URLs.
+[**list**](RestNavigationResourceApi.md#list) | **GET** /com/vmware/vapi/rest/navigation/resource | Gets list of all vAPI REST {@link Resource}s.
+
+
+# **get**
+> VapiRestNavigationResourceResult get(type_id, instance_id, opts)
+
+Gets {@link List} of all {@link Operation}s about a vAPI REST {@link Resource}. Information is searched for by {@param.name typeId} and {@param.name instanceId} is used only in URLs.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::RestNavigationResourceApi.new
+type_id = 'type_id_example' # String | Resource type id.
+instance_id = 'instance_id_example' # String | Resource instance id.
+opts = {
+  base_url: 'base_url_example' # String | Base URL.
+}
+
+begin
+  #Gets {@link List} of all {@link Operation}s about a vAPI REST {@link Resource}. Information is searched for by {@param.name typeId} and {@param.name instanceId} is used only in URLs.
+  result = api_instance.get(type_id, instance_id, opts)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling RestNavigationResourceApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **type_id** | **String**| Resource type id. | 
+ **instance_id** | **String**| Resource instance id. | 
+ **base_url** | **String**| Base URL. | [optional] 
+
+### Return type
+
+[**VapiRestNavigationResourceResult**](VapiRestNavigationResourceResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **list**
+> VapiRestNavigationResourceListResult list(opts)
+
+Gets list of all vAPI REST {@link Resource}s.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::RestNavigationResourceApi.new
+opts = {
+  base_url: 'base_url_example' # String | Base URL.
+}
+
+begin
+  #Gets list of all vAPI REST {@link Resource}s.
+  result = api_instance.list(opts)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling RestNavigationResourceApi->list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **base_url** | **String**| Base URL. | [optional] 
+
+### Return type
+
+[**VapiRestNavigationResourceListResult**](VapiRestNavigationResourceListResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+

data/docs/RestNavigationRootApi.md

@@ -0,0 +1,54 @@
+# 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'
+
+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
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+

data/docs/RestNavigationServiceApi.md

@@ -0,0 +1,56 @@
+# 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'
+
+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
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+

data/docs/VapiMetadataAuthenticationAuthenticationInfo.md

@@ -0,0 +1,10 @@
+# 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

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