docs/LinkedKeysApi.md in phrase-2.26.0 vs docs/LinkedKeysApi.md in phrase-3.0.0
- old
+ new
@@ -5,11 +5,11 @@
Method | HTTP request | Description
------------- | ------------- | -------------
[**key_links_batch_destroy**](LinkedKeysApi.md#key_links_batch_destroy) | **DELETE** /projects/{project_id}/keys/{id}/key_links | Batch unlink child keys from a parent key
[**key_links_create**](LinkedKeysApi.md#key_links_create) | **POST** /projects/{project_id}/keys/{id}/key_links | Link child keys to a parent key
[**key_links_destroy**](LinkedKeysApi.md#key_links_destroy) | **DELETE** /projects/{project_id}/keys/{id}/key_links/{child_key_id} | Unlink a child key from a parent key
-[**key_links_index**](LinkedKeysApi.md#key_links_index) | **GET** /projects/{project_id}/keys/{id}/key_links | Retrieve all child keys linked to a specific parent key
+[**key_links_index**](LinkedKeysApi.md#key_links_index) | **GET** /projects/{project_id}/keys/{id}/key_links | List child keys of a parent key
## key_links_batch_destroy
@@ -38,12 +38,11 @@
api_instance = Phrase::LinkedKeysApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | Parent Translation Key ID
key_links_batch_destroy_parameters = Phrase::KeyLinksBatchDestroyParameters.new({child_key_ids: ["child_key_id1", "child_key_id2"]}) # KeyLinksBatchDestroyParameters |
opts = {
- x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
- unlink_parent: true # Boolean | Whether to unlink the parent key as well and unmark it as linked-key.
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}
begin
#Batch unlink child keys from a parent key
api_instance.key_links_batch_destroy(project_id, id, key_links_batch_destroy_parameters, opts)
@@ -59,11 +58,10 @@
------------- | ------------- | ------------- | -------------
**project_id** | **String**| Project ID |
**id** | **String**| Parent Translation Key ID |
**key_links_batch_destroy_parameters** | [**KeyLinksBatchDestroyParameters**](KeyLinksBatchDestroyParameters.md)| |
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
- **unlink_parent** | **Boolean**| Whether to unlink the parent key as well and unmark it as linked-key. | [optional]
### Return type
Response<(nil (empty response body))>
@@ -208,11 +206,11 @@
## key_links_index
> KeyLink key_links_index(project_id, id, opts)
-Retrieve all child keys linked to a specific parent key
+List child keys of a parent key
Returns detailed information about a parent key, including its linked child keys.
### Example
@@ -236,10 +234,10 @@
opts = {
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}
begin
- #Retrieve all child keys linked to a specific parent key
+ #List child keys of a parent key
result = api_instance.key_links_index(project_id, id, opts)
pp result
rescue Phrase::ApiError => e
puts "Exception when calling LinkedKeysApi->key_links_index: #{e}"
end