Skip to content

Commit 93d2858

Browse files
chore(developer): update API docs (#682)
1 parent fa23b77 commit 93d2858

4 files changed

Lines changed: 16 additions & 16 deletions

File tree

src/assets/api/crowdin/file-based.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11729,7 +11729,7 @@ paths:
1172911729
tags:
1173011730
- 'Source Strings'
1173111731
summary: 'List Strings'
11732-
description: '**Required scopes:** `project.source.string` (Read only).'
11732+
description: "**Required scopes:** `project.source.string` (Read only).\n\n__Note:__ For instant translation delivery directly to user devices, please use [OTA](https://support.crowdin.com/content-delivery/). Direct API usage will exceed established rate limits, which suspends further content updates."
1173311733
operationId: api.projects.strings.getMany
1173411734
parameters:
1173511735
-
@@ -13071,7 +13071,7 @@ paths:
1307113071
tags:
1307213072
- 'String/Asset Translations'
1307313073
summary: 'List Language Translations'
13074-
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery to your mobile, web, server, or desktop apps, it is recommended to use [OTA](https://support.crowdin.com/content-delivery/)."
13074+
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery directly to user devices, please use [OTA](https://support.crowdin.com/content-delivery/). Direct API usage will exceed established rate limits, which suspends further content updates."
1307513075
operationId: api.projects.languages.translations.getMany
1307613076
parameters:
1307713077
-
@@ -13207,7 +13207,7 @@ paths:
1320713207
tags:
1320813208
- 'String/Asset Translations'
1320913209
summary: 'List Translations'
13210-
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery to your mobile, web, server, or desktop apps, it is recommended to use [OTA](https://support.crowdin.com/content-delivery/)."
13210+
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery directly to user devices, please use [OTA](https://support.crowdin.com/content-delivery/). Direct API usage will exceed established rate limits, which suspends further content updates."
1321113211
operationId: api.projects.translations.getMany
1321213212
parameters:
1321313213
-
@@ -17250,7 +17250,7 @@ paths:
1725017250
tags:
1725117251
- Translations
1725217252
summary: 'Export Project Translation'
17253-
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery to your mobile, web, server, or desktop apps, it is recommended to use [OTA](https://support.crowdin.com/content-delivery/)."
17253+
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery directly to user devices, please use [OTA](https://support.crowdin.com/content-delivery/). Direct API usage will exceed established rate limits, which suspends further content updates."
1725417254
operationId: api.projects.translations.exports.post
1725517255
parameters:
1725617256
-

src/assets/api/crowdin/string-based.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10378,7 +10378,7 @@ paths:
1037810378
tags:
1037910379
- 'Source Strings'
1038010380
summary: 'List Strings'
10381-
description: '**Required scopes:** `project.source.string` (Read only).'
10381+
description: "**Required scopes:** `project.source.string` (Read only).\n\n__Note:__ For instant translation delivery directly to user devices, please use [OTA](https://support.crowdin.com/content-delivery/). Direct API usage will exceed established rate limits, which suspends further content updates."
1038210382
operationId: api.projects.strings.getMany
1038310383
parameters:
1038410384
-
@@ -11798,7 +11798,7 @@ paths:
1179811798
tags:
1179911799
- 'String Translations'
1180011800
summary: 'List Language Translations'
11801-
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery to your mobile, web, server, or desktop apps, it is recommended to use [OTA](https://support.crowdin.com/content-delivery/)."
11801+
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery directly to user devices, please use [OTA](https://support.crowdin.com/content-delivery/). Direct API usage will exceed established rate limits, which suspends further content updates."
1180211802
operationId: api.projects.languages.translations.getMany
1180311803
parameters:
1180411804
-
@@ -11922,7 +11922,7 @@ paths:
1192211922
tags:
1192311923
- 'String Translations'
1192411924
summary: 'List Translations'
11925-
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery to your mobile, web, server, or desktop apps, it is recommended to use [OTA](https://support.crowdin.com/content-delivery/)."
11925+
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery directly to user devices, please use [OTA](https://support.crowdin.com/content-delivery/). Direct API usage will exceed established rate limits, which suspends further content updates."
1192611926
operationId: api.projects.translations.getMany
1192711927
parameters:
1192811928
-
@@ -15470,7 +15470,7 @@ paths:
1547015470
tags:
1547115471
- Translations
1547215472
summary: 'Export Project Translation'
15473-
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery to your mobile, web, server, or desktop apps, it is recommended to use [OTA](https://support.crowdin.com/content-delivery/)."
15473+
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery directly to user devices, please use [OTA](https://support.crowdin.com/content-delivery/). Direct API usage will exceed established rate limits, which suspends further content updates."
1547415474
operationId: api.projects.translations.exports.post
1547515475
parameters:
1547615476
-

src/assets/api/enterprise/file-based.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13485,7 +13485,7 @@ paths:
1348513485
tags:
1348613486
- 'Source Strings'
1348713487
summary: 'List Strings'
13488-
description: '**Required scopes:** `project.source.string` (Read only).'
13488+
description: "**Required scopes:** `project.source.string` (Read only).\n\n__Note:__ For instant translation delivery directly to user devices, please use [OTA](https://support.crowdin.com/enterprise/content-delivery/). Direct API usage will exceed established rate limits, which suspends further content updates."
1348913489
operationId: api.projects.strings.getMany
1349013490
parameters:
1349113491
-
@@ -15115,7 +15115,7 @@ paths:
1511515115
tags:
1511615116
- 'String/Asset Translations'
1511715117
summary: 'List Language Translations'
15118-
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery to your mobile, web, server, or desktop apps, it is recommended to use [OTA](https://support.crowdin.com/enterprise/content-delivery/)."
15118+
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery directly to user devices, please use [OTA](https://support.crowdin.com/enterprise/content-delivery/). Direct API usage will exceed established rate limits, which suspends further content updates."
1511915119
operationId: api.projects.languages.translations.getMany
1512015120
parameters:
1512115121
-
@@ -15244,7 +15244,7 @@ paths:
1524415244
tags:
1524515245
- 'String/Asset Translations'
1524615246
summary: 'List String/Asset Translations'
15247-
description: "**Required scopes:** `project.translation` (Read only).\n\nFor instant translation delivery to your mobile, web, server, or desktop apps, it is recommended to use [OTA](https://support.crowdin.com/content-delivery/).\n\n__Note:__ This endpoint supports oneOf pattern:\n- **String type**: Use `stringId`\n- **Asset type**: Use `fileId`"
15247+
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery directly to user devices, please use [OTA](https://support.crowdin.com/content-delivery/). Direct API usage will exceed established rate limits, which suspends further content updates.\n\n__Note:__ This endpoint supports oneOf pattern:\n- **String type**: Use `stringId`\n- **Asset type**: Use `fileId`"
1524815248
operationId: api.projects.translations.getMany
1524915249
parameters:
1525015250
-
@@ -19937,7 +19937,7 @@ paths:
1993719937
tags:
1993819938
- Translations
1993919939
summary: 'Export Project Translation'
19940-
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery to your mobile, web, server, or desktop apps, it is recommended to use [OTA](https://support.crowdin.com/enterprise/content-delivery/)."
19940+
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery directly to user devices, please use [OTA](https://support.crowdin.com/enterprise/content-delivery/). Direct API usage will exceed established rate limits, which suspends further content updates."
1994119941
operationId: api.projects.translations.exports.post
1994219942
parameters:
1994319943
-

src/assets/api/enterprise/string-based.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11908,7 +11908,7 @@ paths:
1190811908
tags:
1190911909
- 'Source Strings'
1191011910
summary: 'List Strings'
11911-
description: '**Required scopes:** `project.source.string` (Read only).'
11911+
description: "**Required scopes:** `project.source.string` (Read only).\n\n__Note:__ For instant translation delivery directly to user devices, please use [OTA](https://support.crowdin.com/enterprise/content-delivery/). Direct API usage will exceed established rate limits, which suspends further content updates."
1191211912
operationId: api.projects.strings.getMany
1191311913
parameters:
1191411914
-
@@ -13616,7 +13616,7 @@ paths:
1361613616
tags:
1361713617
- 'String Translations'
1361813618
summary: 'List Language Translations'
13619-
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery to your mobile, web, server, or desktop apps, it is recommended to use [OTA](https://support.crowdin.com/enterprise/content-delivery/)."
13619+
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery directly to user devices, please use [OTA](https://support.crowdin.com/enterprise/content-delivery/). Direct API usage will exceed established rate limits, which suspends further content updates."
1362013620
operationId: api.projects.languages.translations.getMany
1362113621
parameters:
1362213622
-
@@ -13733,7 +13733,7 @@ paths:
1373313733
tags:
1373413734
- 'String Translations'
1373513735
summary: 'List String Translations'
13736-
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery to your mobile, web, server, or desktop apps, it is recommended to use [OTA](https://support.crowdin.com/content-delivery/)."
13736+
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery directly to user devices, please use [OTA](https://support.crowdin.com/content-delivery/). Direct API usage will exceed established rate limits, which suspends further content updates."
1373713737
operationId: api.projects.translations.getMany
1373813738
parameters:
1373913739
-
@@ -17931,7 +17931,7 @@ paths:
1793117931
tags:
1793217932
- Translations
1793317933
summary: 'Export Project Translation'
17934-
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery to your mobile, web, server, or desktop apps, it is recommended to use [OTA](https://support.crowdin.com/enterprise/content-delivery/)."
17934+
description: "**Required scopes:** `project.translation` (Read only).\n\n__Note:__ For instant translation delivery directly to user devices, please use [OTA](https://support.crowdin.com/enterprise/content-delivery/). Direct API usage will exceed established rate limits, which suspends further content updates."
1793517935
operationId: api.projects.translations.exports.post
1793617936
parameters:
1793717937
-

0 commit comments

Comments
 (0)