vsphere-automation-cis 0.1.0 → 0.2.0

data/docs/TaggingTagApi.md

@@ -4,12 +4,12 @@ All URIs are relative to *https://<vcenter>/rest*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**add_to_used_by**](TaggingTagApi.md#add_to_used_by) | **POST** /com/vmware/cis/tagging/tag/id:{tag_id}?~action=add-to-used-by | Adds the {@param.name usedByEntity} to the {@link TagModel#usedBy} subscribers {@term set}. If the {@param.name usedByEntity} is already in the {@term set}, then this becomes a no-op. To invoke this {@term operation}, you need the modify {@link TagModel#usedBy} privilege on the tag.
+[**add_to_used_by**](TaggingTagApi.md#add_to_used_by) | **POST** /com/vmware/cis/tagging/tag/id:{tag_id} | Adds the {@param.name usedByEntity} to the {@link TagModel#usedBy} subscribers {@term set}. If the {@param.name usedByEntity} is already in the {@term set}, then this becomes a no-op. To invoke this {@term operation}, you need the modify {@link TagModel#usedBy} privilege on the tag.
 [**create**](TaggingTagApi.md#create) | **POST** /com/vmware/cis/tagging/tag | Creates a tag. To invoke this {@term operation}, you need the create tag privilege on the input category.
 [**delete**](TaggingTagApi.md#delete) | **DELETE** /com/vmware/cis/tagging/tag/id:{tag_id} | Deletes an existing tag. To invoke this {@term operation}, you need the delete privilege on the tag.
 [**get**](TaggingTagApi.md#get) | **GET** /com/vmware/cis/tagging/tag/id:{tag_id} | Fetches the tag information for the given tag identifier. To invoke this {@term operation}, you need the read privilege on the tag in order to view the tag info.
 [**list**](TaggingTagApi.md#list) | **GET** /com/vmware/cis/tagging/tag | Enumerates the tags in the system. To invoke this {@term operation}, you need read privilege on the individual tags. The {@term list} will only contain tags for which you have read privileges.
-[**list_tags_for_category**](TaggingTagApi.md#list_tags_for_category) | **POST** /com/vmware/cis/tagging/tag/id:{category_id}?~action=list-tags-for-category | Enumerates all tags for the given category. To invoke this {@term operation}, you need the read privilege on the given category and the individual tags in that category.
+[**list_tags_for_category**](TaggingTagApi.md#list_tags_for_category) | **POST** /com/vmware/cis/tagging/tag/id:{category_id} | Enumerates all tags for the given category. To invoke this {@term operation}, you need the read privilege on the given category and the individual tags in that category.
 [**list_used_tags**](TaggingTagApi.md#list_used_tags) | **POST** /com/vmware/cis/tagging/tag?~action=list-used-tags | Enumerates all tags for which the {@param.name usedByEntity} is part of the {@link TagModel#usedBy} subscribers {@term set}. To invoke this {@term operation}, you need the read privilege on the individual tags.
 [**remove_from_used_by**](TaggingTagApi.md#remove_from_used_by) | **POST** /com/vmware/cis/tagging/tag/id:{tag_id}?~action=remove-from-used-by | Removes the {@param.name usedByEntity} from the {@link TagModel#usedBy} subscribers set. If the {@param.name usedByEntity} is not using this tag, then this becomes a no-op. To invoke this {@term operation}, you need modify {@link TagModel#usedBy} privilege on the tag.
 [**revoke_propagating_permissions**](TaggingTagApi.md#revoke_propagating_permissions) | **POST** /com/vmware/cis/tagging/tag/id:{tag_id}?~action=revoke-propagating-permissions | Revokes all propagating permissions on the given tag. You should then attach a direct permission with tagging privileges on the given tag. To invoke this {@term operation}, you need tag related privileges (direct or propagating) on the concerned tag.
@@ -17,7 +17,7 @@ Method | HTTP request | Description
 
 
 # **add_to_used_by**
-> add_to_used_by(tag_id, cis_tagging_tag_add_to_used_by)
+> add_to_used_by(tag_id, action, request_body)
 
 Adds the {@param.name usedByEntity} to the {@link TagModel#usedBy} subscribers {@term set}. If the {@param.name usedByEntity} is already in the {@term set}, then this becomes a no-op. To invoke this {@term operation}, you need the modify {@link TagModel#usedBy} privilege on the tag.
 
@@ -25,14 +25,22 @@ Adds the {@param.name usedByEntity} to the {@link TagModel#usedBy} subscribers {
 ```ruby
 # load the gem
 require 'vsphere-automation-cis'
+# 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::CIS::TaggingTagApi.new
 tag_id = 'tag_id_example' # String | The identifier of the input tag.
-cis_tagging_tag_add_to_used_by = VSphereAutomation::CisTaggingTagAddToUsedBy.new # CisTaggingTagAddToUsedBy | 
+action = 'action_example' # String | ~action=add-to-used-by
+request_body = CIS::CisTaggingTagAddToUsedBy.new # CisTaggingTagAddToUsedBy | 
 
 begin
   #Adds the {@param.name usedByEntity} to the {@link TagModel#usedBy} subscribers {@term set}. If the {@param.name usedByEntity} is already in the {@term set}, then this becomes a no-op. To invoke this {@term operation}, you need the modify {@link TagModel#usedBy} privilege on the tag.
-  api_instance.add_to_used_by(tag_id, cis_tagging_tag_add_to_used_by)
+  api_instance.add_to_used_by(tag_id, action, request_body)
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling TaggingTagApi->add_to_used_by: #{e}"
 end
@@ -43,7 +51,8 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **tag_id** | **String**| The identifier of the input tag. | 
- **cis_tagging_tag_add_to_used_by** | [**CisTaggingTagAddToUsedBy**](CisTaggingTagAddToUsedBy.md)|  | 
+ **action** | **String**| ~action=add-to-used-by | 
+ **request_body** | [**CisTaggingTagAddToUsedBy**](CisTaggingTagAddToUsedBy.md)|  | 
 
 ### Return type
 
@@ -51,17 +60,17 @@ nil (empty response body)
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: application/json
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
 # **create**
-> CisTaggingTagCreateResult create(cis_tagging_tag_create)
+> CisTaggingTagCreateResult create(request_body)
 
 Creates a tag. To invoke this {@term operation}, you need the create tag privilege on the input category.
 
@@ -69,13 +78,20 @@ Creates a tag. To invoke this {@term operation}, you need the create tag privile
 ```ruby
 # load the gem
 require 'vsphere-automation-cis'
+# 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::CIS::TaggingTagApi.new
-cis_tagging_tag_create = VSphereAutomation::CisTaggingTagCreate.new # CisTaggingTagCreate | 
+request_body = CIS::CisTaggingTagCreate.new # CisTaggingTagCreate | 
 
 begin
   #Creates a tag. To invoke this {@term operation}, you need the create tag privilege on the input category.
-  result = api_instance.create(cis_tagging_tag_create)
+  result = api_instance.create(request_body)
   p result
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling TaggingTagApi->create: #{e}"
@@ -86,7 +102,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **cis_tagging_tag_create** | [**CisTaggingTagCreate**](CisTaggingTagCreate.md)|  | 
+ **request_body** | [**CisTaggingTagCreate**](CisTaggingTagCreate.md)|  | 
 
 ### Return type
 
@@ -94,12 +110,12 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: application/json
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
@@ -112,6 +128,13 @@ Deletes an existing tag. To invoke this {@term operation}, you need the delete p
 ```ruby
 # load the gem
 require 'vsphere-automation-cis'
+# 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::CIS::TaggingTagApi.new
 tag_id = 'tag_id_example' # String | The identifier of the input tag.
@@ -136,12 +159,12 @@ nil (empty response body)
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
@@ -154,6 +177,13 @@ Fetches the tag information for the given tag identifier. To invoke this {@term
 ```ruby
 # load the gem
 require 'vsphere-automation-cis'
+# 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::CIS::TaggingTagApi.new
 tag_id = 'tag_id_example' # String | The identifier of the input tag.
@@ -179,12 +209,12 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
@@ -197,6 +227,13 @@ Enumerates the tags in the system. To invoke this {@term operation}, you need re
 ```ruby
 # load the gem
 require 'vsphere-automation-cis'
+# 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::CIS::TaggingTagApi.new
 
@@ -218,17 +255,17 @@ This endpoint does not need any parameter.
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
 # **list_tags_for_category**
-> CisTaggingTagListTagsForCategoryResult list_tags_for_category(category_id)
+> CisTaggingTagListTagsForCategoryResult list_tags_for_category(category_id, action)
 
 Enumerates all tags for the given category. To invoke this {@term operation}, you need the read privilege on the given category and the individual tags in that category.
 
@@ -236,13 +273,21 @@ Enumerates all tags for the given category. To invoke this {@term operation}, yo
 ```ruby
 # load the gem
 require 'vsphere-automation-cis'
+# 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::CIS::TaggingTagApi.new
 category_id = 'category_id_example' # String | The identifier of the input category.
+action = 'action_example' # String | ~action=list-tags-for-category
 
 begin
   #Enumerates all tags for the given category. To invoke this {@term operation}, you need the read privilege on the given category and the individual tags in that category.
-  result = api_instance.list_tags_for_category(category_id)
+  result = api_instance.list_tags_for_category(category_id, action)
   p result
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling TaggingTagApi->list_tags_for_category: #{e}"
@@ -254,6 +299,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **category_id** | **String**| The identifier of the input category. | 
+ **action** | **String**| ~action=list-tags-for-category | 
 
 ### Return type
 
@@ -261,17 +307,17 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
 # **list_used_tags**
-> CisTaggingTagListUsedTagsResult list_used_tags(cis_tagging_tag_list_used_tags)
+> CisTaggingTagListUsedTagsResult list_used_tags(request_body)
 
 Enumerates all tags for which the {@param.name usedByEntity} is part of the {@link TagModel#usedBy} subscribers {@term set}. To invoke this {@term operation}, you need the read privilege on the individual tags.
 
@@ -279,13 +325,20 @@ Enumerates all tags for which the {@param.name usedByEntity} is part of the {@li
 ```ruby
 # load the gem
 require 'vsphere-automation-cis'
+# 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::CIS::TaggingTagApi.new
-cis_tagging_tag_list_used_tags = VSphereAutomation::CisTaggingTagListUsedTags.new # CisTaggingTagListUsedTags | 
+request_body = CIS::CisTaggingTagListUsedTags.new # CisTaggingTagListUsedTags | 
 
 begin
   #Enumerates all tags for which the {@param.name usedByEntity} is part of the {@link TagModel#usedBy} subscribers {@term set}. To invoke this {@term operation}, you need the read privilege on the individual tags.
-  result = api_instance.list_used_tags(cis_tagging_tag_list_used_tags)
+  result = api_instance.list_used_tags(request_body)
   p result
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling TaggingTagApi->list_used_tags: #{e}"
@@ -296,7 +349,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **cis_tagging_tag_list_used_tags** | [**CisTaggingTagListUsedTags**](CisTaggingTagListUsedTags.md)|  | 
+ **request_body** | [**CisTaggingTagListUsedTags**](CisTaggingTagListUsedTags.md)|  | 
 
 ### Return type
 
@@ -304,17 +357,17 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: application/json
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
 # **remove_from_used_by**
-> remove_from_used_by(tag_id, cis_tagging_tag_remove_from_used_by)
+> remove_from_used_by(tag_id, request_body)
 
 Removes the {@param.name usedByEntity} from the {@link TagModel#usedBy} subscribers set. If the {@param.name usedByEntity} is not using this tag, then this becomes a no-op. To invoke this {@term operation}, you need modify {@link TagModel#usedBy} privilege on the tag.
 
@@ -322,14 +375,21 @@ Removes the {@param.name usedByEntity} from the {@link TagModel#usedBy} subscrib
 ```ruby
 # load the gem
 require 'vsphere-automation-cis'
+# 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::CIS::TaggingTagApi.new
 tag_id = 'tag_id_example' # String | The identifier of the input tag.
-cis_tagging_tag_remove_from_used_by = VSphereAutomation::CisTaggingTagRemoveFromUsedBy.new # CisTaggingTagRemoveFromUsedBy | 
+request_body = CIS::CisTaggingTagRemoveFromUsedBy.new # CisTaggingTagRemoveFromUsedBy | 
 
 begin
   #Removes the {@param.name usedByEntity} from the {@link TagModel#usedBy} subscribers set. If the {@param.name usedByEntity} is not using this tag, then this becomes a no-op. To invoke this {@term operation}, you need modify {@link TagModel#usedBy} privilege on the tag.
-  api_instance.remove_from_used_by(tag_id, cis_tagging_tag_remove_from_used_by)
+  api_instance.remove_from_used_by(tag_id, request_body)
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling TaggingTagApi->remove_from_used_by: #{e}"
 end
@@ -340,7 +400,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **tag_id** | **String**| The identifier of the input tag. | 
- **cis_tagging_tag_remove_from_used_by** | [**CisTaggingTagRemoveFromUsedBy**](CisTaggingTagRemoveFromUsedBy.md)|  | 
+ **request_body** | [**CisTaggingTagRemoveFromUsedBy**](CisTaggingTagRemoveFromUsedBy.md)|  | 
 
 ### Return type
 
@@ -348,12 +408,12 @@ nil (empty response body)
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: application/json
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
@@ -366,6 +426,13 @@ Revokes all propagating permissions on the given tag. You should then attach a d
 ```ruby
 # load the gem
 require 'vsphere-automation-cis'
+# 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::CIS::TaggingTagApi.new
 tag_id = 'tag_id_example' # String | The identifier of the input tag.
@@ -390,17 +457,17 @@ nil (empty response body)
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
 # **update**
-> update(tag_id, cis_tagging_tag_update)
+> update(tag_id, request_body)
 
 Updates an existing tag. To invoke this {@term operation}, you need the edit privilege on the tag.
 
@@ -408,14 +475,21 @@ Updates an existing tag. To invoke this {@term operation}, you need the edit pri
 ```ruby
 # load the gem
 require 'vsphere-automation-cis'
+# 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::CIS::TaggingTagApi.new
 tag_id = 'tag_id_example' # String | The identifier of the input tag.
-cis_tagging_tag_update = VSphereAutomation::CisTaggingTagUpdate.new # CisTaggingTagUpdate | 
+request_body = CIS::CisTaggingTagUpdate.new # CisTaggingTagUpdate | 
 
 begin
   #Updates an existing tag. To invoke this {@term operation}, you need the edit privilege on the tag.
-  api_instance.update(tag_id, cis_tagging_tag_update)
+  api_instance.update(tag_id, request_body)
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling TaggingTagApi->update: #{e}"
 end
@@ -426,7 +500,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **tag_id** | **String**| The identifier of the input tag. | 
- **cis_tagging_tag_update** | [**CisTaggingTagUpdate**](CisTaggingTagUpdate.md)|  | 
+ **request_body** | [**CisTaggingTagUpdate**](CisTaggingTagUpdate.md)|  | 
 
 ### Return type
 
@@ -434,12 +508,12 @@ nil (empty response body)
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: application/json
- - **Accept**: */*
+ - **Accept**: application/json