You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api/openapi.yaml
+20-7Lines changed: 20 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -34780,8 +34780,10 @@ paths:
34780
34780
- Linked Keys
34781
34781
x-accepts: application/json
34782
34782
post:
34783
-
description: Creates links between a given parent key and one or more child
34784
-
keys.
34783
+
description: |
34784
+
Designates a translation key as a parent and links one or more child keys to it. Once linked, child keys receive a special reference marker as their translation content, signalling that their translations are derived from the parent. Use this when you want to group related keys — for example, a short label and its long-form variant — so translators see them in context together.
34785
+
34786
+
Pass an empty child_key_ids array to mark the key as a parent without linking any children yet. Both the parent key and every child key must belong to the main project; branch keys cannot participate in key links. A child key can have at most one parent at a time; attempting to link a child that already has a parent returns a 422 error with code CHILD_IS_ALREADY_LINKED. Parent and child key plurality must match — linking a plural child to a non-plural parent (or vice versa) also returns a 422.
**childKeyIds** | **List<String>** | The IDs of the child keys to link to the parent key. Can be left empty, to only mark the given translation-key as parent |
9
+
**childKeyIds** | **List<String>** | Codes of the keys to link as children. Pass an empty array to mark the parent key without linking any children. |
Copy file name to clipboardExpand all lines: docs/LinkedKeysApi.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -101,7 +101,7 @@ Name | Type | Description | Notes
101
101
102
102
Link child keys to a parent key
103
103
104
-
Creates links between a given parentkey and one or more child keys.
104
+
Designates a translation key as a parent and links one or more child keys to it. Once linked, child keys receive a special reference marker as their translation content, signalling that their translations are derived from the parent. Use this when you want to group related keys — for example, a short label and its long-form variant — so translators see them in context together. Pass an empty child_key_ids array to mark the key as a parent without linking any children yet. Both the parent key and every child key must belong to the main project; branch keys cannot participate in key links. A child key can have at most one parent at a time; attempting to link a child that already has a parent returns a 422 error with code CHILD_IS_ALREADY_LINKED. Parent and child key plurality must match — linking a plural child to a non-plural parent (or vice versa) also returns a 422.
105
105
106
106
### Example
107
107
```java
@@ -172,7 +172,7 @@ Name | Type | Description | Notes
172
172
### HTTP response details
173
173
| Status code | Description | Response headers |
174
174
|-------------|-------------|------------------|
175
-
**201** | Created | - |
175
+
**201** | Key link reference created. | - |
176
176
**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> |
177
177
**401** | Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry. | - |
178
178
**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> |
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
229
-
<tr><td> 201 </td><td> Created </td><td> - </td></tr>
229
+
<tr><td> 201 </td><td> Key link reference created. </td><td> - </td></tr>
230
230
<tr><td> 400 </td><td> 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. </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
231
231
<tr><td> 401 </td><td> Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry. </td><td> - </td></tr>
232
232
<tr><td> 403 </td><td> 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. </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
@@ -296,7 +296,7 @@ private okhttp3.Call keyLinksCreateValidateBeforeCall(String projectId, String i
296
296
297
297
/**
298
298
* Link child keys to a parent key
299
-
* Creates links between a given parentkey and one or more child keys.
299
+
* Designates a translation key as a parent and links one or more child keys to it. Once linked, child keys receive a special reference marker as their translation content, signalling that their translations are derived from the parent. Use this when you want to group related keys — for example, a short label and its long-form variant — so translators see them in context together. Pass an empty child_key_ids array to mark the key as a parent without linking any children yet. Both the parent key and every child key must belong to the main project; branch keys cannot participate in key links. A child key can have at most one parent at a time; attempting to link a child that already has a parent returns a 422 error with code CHILD_IS_ALREADY_LINKED. Parent and child key plurality must match — linking a plural child to a non-plural parent (or vice versa) also returns a 422.
300
300
* @param projectId Project ID (required)
301
301
* @param id Parent Translation Key ID (required)
302
302
* @param keyLinksCreateParameters (required)
@@ -306,7 +306,7 @@ private okhttp3.Call keyLinksCreateValidateBeforeCall(String projectId, String i
306
306
* @http.response.details
307
307
<table summary="Response Details" border="1">
308
308
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
309
-
<tr><td> 201 </td><td> Created </td><td> - </td></tr>
309
+
<tr><td> 201 </td><td> Key link reference created. </td><td> - </td></tr>
310
310
<tr><td> 400 </td><td> 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. </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
311
311
<tr><td> 401 </td><td> Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry. </td><td> - </td></tr>
312
312
<tr><td> 403 </td><td> 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. </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
* Creates links between a given parentkey and one or more child keys.
325
+
* Designates a translation key as a parent and links one or more child keys to it. Once linked, child keys receive a special reference marker as their translation content, signalling that their translations are derived from the parent. Use this when you want to group related keys — for example, a short label and its long-form variant — so translators see them in context together. Pass an empty child_key_ids array to mark the key as a parent without linking any children yet. Both the parent key and every child key must belong to the main project; branch keys cannot participate in key links. A child key can have at most one parent at a time; attempting to link a child that already has a parent returns a 422 error with code CHILD_IS_ALREADY_LINKED. Parent and child key plurality must match — linking a plural child to a non-plural parent (or vice versa) also returns a 422.
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
335
-
<tr><td> 201 </td><td> Created </td><td> - </td></tr>
335
+
<tr><td> 201 </td><td> Key link reference created. </td><td> - </td></tr>
336
336
<tr><td> 400 </td><td> 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. </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
337
337
<tr><td> 401 </td><td> Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry. </td><td> - </td></tr>
338
338
<tr><td> 403 </td><td> 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. </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
@@ -349,7 +349,7 @@ public ApiResponse<KeyLink> keyLinksCreateWithHttpInfo(String projectId, String
349
349
350
350
/**
351
351
* Link child keys to a parent key (asynchronously)
352
-
* Creates links between a given parentkey and one or more child keys.
352
+
* Designates a translation key as a parent and links one or more child keys to it. Once linked, child keys receive a special reference marker as their translation content, signalling that their translations are derived from the parent. Use this when you want to group related keys — for example, a short label and its long-form variant — so translators see them in context together. Pass an empty child_key_ids array to mark the key as a parent without linking any children yet. Both the parent key and every child key must belong to the main project; branch keys cannot participate in key links. A child key can have at most one parent at a time; attempting to link a child that already has a parent returns a 422 error with code CHILD_IS_ALREADY_LINKED. Parent and child key plurality must match — linking a plural child to a non-plural parent (or vice versa) also returns a 422.
353
353
* @param projectId Project ID (required)
354
354
* @param id Parent Translation Key ID (required)
355
355
* @param keyLinksCreateParameters (required)
@@ -360,7 +360,7 @@ public ApiResponse<KeyLink> keyLinksCreateWithHttpInfo(String projectId, String
360
360
* @http.response.details
361
361
<table summary="Response Details" border="1">
362
362
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
363
-
<tr><td> 201 </td><td> Created </td><td> - </td></tr>
363
+
<tr><td> 201 </td><td> Key link reference created. </td><td> - </td></tr>
364
364
<tr><td> 400 </td><td> 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. </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
365
365
<tr><td> 401 </td><td> Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry. </td><td> - </td></tr>
366
366
<tr><td> 403 </td><td> 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. </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
0 commit comments