Skip to content

Commit 2cdb2bc

Browse files
author
Phrase
committed
1 parent ed32f9b commit 2cdb2bc

7 files changed

Lines changed: 13 additions & 13 deletions

docs/LinkedKeysApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ Name | Type | Description | Notes
160160
161161
Unlink a child key from a parent key
162162

163-
Unlinks a single child key from a given parent key.
163+
Removes a single child key from a parent key's link group. A link group is the relationship model that keeps child keys synchronized with a parent: while linked, a child key's translations are derived from the parent's content. When you call this endpoint, the child key leaves the group and becomes independent — its existing translations are updated with the parent's current content and then marked unverified, signalling that reviewers should confirm the content is still appropriate for the child's context. Use this endpoint when you need to detach one specific child key while keeping other children linked. To detach multiple children at once, use the batch unlink endpoint. This operation is only available on main projects. It returns 422 when the child key is not currently linked to the specified parent key, or when a translation update fails during the unlink process.
164164

165165
### Example
166166

@@ -181,7 +181,7 @@ with phrase_api.ApiClient(configuration) as api_client:
181181
api_instance = phrase_api.LinkedKeysApi(api_client)
182182
project_id = 'project_id_example' # str | Project ID (required)
183183
id = 'id_example' # str | Parent Translation Key ID (required)
184-
child_key_id = 'child_key_id_example' # str | The ID of the child key to unlink. (required)
184+
child_key_id = '1234abcd1234cdef1234abcd1234cdef' # str | The ID of the child translation key to unlink from the parent. (required)
185185
x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)
186186

187187
try:
@@ -198,7 +198,7 @@ Name | Type | Description | Notes
198198
------------- | ------------- | ------------- | -------------
199199
**project_id** | **str**| Project ID |
200200
**id** | **str**| Parent Translation Key ID |
201-
**child_key_id** | **str**| The ID of the child key to unlink. |
201+
**child_key_id** | **str**| The ID of the child translation key to unlink from the parent. |
202202
**x_phrase_app_otp** | **str**| Two-Factor-Authentication token (optional) | [optional]
203203

204204
### Return type
@@ -217,7 +217,7 @@ void (empty response body)
217217
### HTTP response details
218218
| Status code | Description | Response headers |
219219
|-------------|-------------|------------------|
220-
**200** | OK | - |
220+
**200** | The child key was successfully unlinked from the parent key. The response body is empty. | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> |
221221
**400** | Bad request. The request could not be parsed or a parameter failed validation. Verify the request body, the content type, and the parameter types, then retry. | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> |
222222
**401** | Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry. | - |
223223
**403** | Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions. | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> |

phrase_api/api/linked_keys_api.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ def key_links_create_with_http_info(self, project_id, id, key_links_create_param
320320
def key_links_destroy(self, project_id, id, child_key_id, **kwargs): # noqa: E501
321321
"""Unlink a child key from a parent key # noqa: E501
322322
323-
Unlinks a single child key from a given parent key. # noqa: E501
323+
Removes a single child key from a parent key's link group. A link group is the relationship model that keeps child keys synchronized with a parent: while linked, a child key's translations are derived from the parent's content. When you call this endpoint, the child key leaves the group and becomes independent — its existing translations are updated with the parent's current content and then marked unverified, signalling that reviewers should confirm the content is still appropriate for the child's context. Use this endpoint when you need to detach one specific child key while keeping other children linked. To detach multiple children at once, use the batch unlink endpoint. This operation is only available on main projects. It returns 422 when the child key is not currently linked to the specified parent key, or when a translation update fails during the unlink process. # noqa: E501
324324
This method makes a synchronous HTTP request by default. To make an
325325
asynchronous HTTP request, please pass async_req=True
326326
>>> thread = api.key_links_destroy(project_id, id, child_key_id, async_req=True)
@@ -329,7 +329,7 @@ def key_links_destroy(self, project_id, id, child_key_id, **kwargs): # noqa: E5
329329
:param async_req bool: execute request asynchronously
330330
:param str project_id: Project ID (required)
331331
:param str id: Parent Translation Key ID (required)
332-
:param str child_key_id: The ID of the child key to unlink. (required)
332+
:param str child_key_id: The ID of the child translation key to unlink from the parent. (required)
333333
:param str x_phrase_app_otp: Two-Factor-Authentication token (optional)
334334
:param _preload_content: if False, the urllib3.HTTPResponse object will
335335
be returned without reading/decoding response
@@ -348,7 +348,7 @@ def key_links_destroy(self, project_id, id, child_key_id, **kwargs): # noqa: E5
348348
def key_links_destroy_with_http_info(self, project_id, id, child_key_id, **kwargs): # noqa: E501
349349
"""Unlink a child key from a parent key # noqa: E501
350350
351-
Unlinks a single child key from a given parent key. # noqa: E501
351+
Removes a single child key from a parent key's link group. A link group is the relationship model that keeps child keys synchronized with a parent: while linked, a child key's translations are derived from the parent's content. When you call this endpoint, the child key leaves the group and becomes independent — its existing translations are updated with the parent's current content and then marked unverified, signalling that reviewers should confirm the content is still appropriate for the child's context. Use this endpoint when you need to detach one specific child key while keeping other children linked. To detach multiple children at once, use the batch unlink endpoint. This operation is only available on main projects. It returns 422 when the child key is not currently linked to the specified parent key, or when a translation update fails during the unlink process. # noqa: E501
352352
This method makes a synchronous HTTP request by default. To make an
353353
asynchronous HTTP request, please pass async_req=True
354354
>>> thread = api.key_links_destroy_with_http_info(project_id, id, child_key_id, async_req=True)
@@ -357,7 +357,7 @@ def key_links_destroy_with_http_info(self, project_id, id, child_key_id, **kwarg
357357
:param async_req bool: execute request asynchronously
358358
:param str project_id: Project ID (required)
359359
:param str id: Parent Translation Key ID (required)
360-
:param str child_key_id: The ID of the child key to unlink. (required)
360+
:param str child_key_id: The ID of the child translation key to unlink from the parent. (required)
361361
:param str x_phrase_app_otp: Two-Factor-Authentication token (optional)
362362
:param _return_http_data_only: response data without head status code
363363
and headers

test/test_key_create_parameters.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ def make_instance(self, include_optional):
4646
data_type = 'number',
4747
tags = 'awesome-feature,needs-proofreading',
4848
max_characters_allowed = 140,
49-
screenshot = '[B@7c5c3132',
49+
screenshot = '[B@3bfd73e7',
5050
remove_screenshot = True,
5151
unformatted = True,
5252
default_translation_content = 'Default translation content',

test/test_key_update_parameters.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ def make_instance(self, include_optional):
4646
data_type = 'number',
4747
tags = 'awesome-feature,needs-proofreading',
4848
max_characters_allowed = 140,
49-
screenshot = '[B@b96fb73',
49+
screenshot = '[B@33225b82',
5050
remove_screenshot = True,
5151
unformatted = True,
5252
xml_space_preserve = True,

test/test_project_create_parameters.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def make_instance(self, include_optional):
4141
main_format = 'yml',
4242
media = 'Python',
4343
shares_translation_memory = True,
44-
project_image = '[B@30f8e8b2',
44+
project_image = '[B@b1078f2',
4545
remove_project_image = True,
4646
account_id = 'abcd1234',
4747
point_of_contact = 'abcd1234',

test/test_project_update_parameters.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ def make_instance(self, include_optional):
4343
main_format = 'yml',
4444
media = 'Python',
4545
shares_translation_memory = True,
46-
project_image = '[B@7c752d6b',
46+
project_image = '[B@767ab988',
4747
remove_project_image = False,
4848
workflow = 'review',
4949
machine_translation_enabled = True,

test/test_screenshot_update_parameters.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ def make_instance(self, include_optional):
4040
branch = 'my-feature-branch',
4141
name = 'A screenshot name',
4242
description = 'A screenshot description',
43-
filename = '[B@7f77a0d6'
43+
filename = '[B@578ce232'
4444
)
4545
else :
4646
return ScreenshotUpdateParameters(

0 commit comments

Comments
 (0)