Skip to content

Commit 6148339

Browse files
chore(developer): update API docs (#589)
1 parent fd81454 commit 6148339

File tree

4 files changed

+189
-167
lines changed

4 files changed

+189
-167
lines changed

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

Lines changed: 47 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -19348,6 +19348,7 @@ components:
1934819348
- open_ai
1934919349
- azure_open_ai
1935019350
- google_gemini
19351+
- google_gemini_ai_studio
1935119352
- mistral_ai
1935219353
- anthropic
1935319354
- x_ai
@@ -19363,6 +19364,8 @@ components:
1936319364
$ref: '#/components/schemas/ai.provider.credentials.azure_open_ai'
1936419365
-
1936519366
$ref: '#/components/schemas/ai.provider.credentials.google_gemini'
19367+
-
19368+
$ref: '#/components/schemas/ai.provider.credentials.google_gemini_ai_studio'
1936619369
-
1936719370
$ref: '#/components/schemas/ai.provider.credentials.mistral_ai'
1936819371
-
@@ -19382,7 +19385,7 @@ components:
1938219385
type: boolean
1938319386
default: true
1938419387
useSystemCredentials:
19385-
description: "Enables the paid service AI provider via Crowdin.\n\n__Note__: Set to true if `credentials` is not provided. Not supported for `custom_ai`, `x_ai`, `watsonx` and `deepseek` types."
19388+
description: "Enables the paid service AI provider via Crowdin.\n\n__Note__: Set to true if `credentials` is not provided. Not supported for `custom_ai`, `x_ai`, `watsonx`, `deepseek` and `google_gemini_ai_studio` types."
1938619389
type: boolean
1938719390
default: false
1938819391
type: object
@@ -19495,7 +19498,7 @@ components:
1949519498
type: string
1949619499
type: object
1949719500
ai.provider.credentials.google_gemini:
19498-
title: 'Google Gemini'
19501+
title: 'Google Gemini (Vertex AI)'
1949919502
required:
1950019503
- project
1950119504
- region
@@ -19511,6 +19514,15 @@ components:
1951119514
description: 'Service account key'
1951219515
type: object
1951319516
type: object
19517+
ai.provider.credentials.google_gemini_ai_studio:
19518+
title: 'Google Gemini (AI Studio)'
19519+
required:
19520+
- apiKey
19521+
properties:
19522+
apiKey:
19523+
description: 'API key from Google AI Studio'
19524+
type: string
19525+
type: object
1951419526
ai.provider.credentials.mistral_ai:
1951519527
title: 'Mistral AI'
1951619528
required:
@@ -40908,7 +40920,6 @@ components:
4090840920
$ref: '#/components/schemas/Term'
4090940921
Term:
4091040922
title: Term
40911-
description: 'Class TermResponseModel'
4091240923
properties:
4091340924
id:
4091440925
type: integer
@@ -41197,7 +41208,7 @@ components:
4119741208
type: object
4119841209
TmLanguageScheme:
4119941210
title: 'Tm Schema'
41200-
description: "Defines data columns mapping. The passed value should be an associative array containing both language id and column number:\n * `{languageId}` – Crowdin id for the specified language. Get via [List Supported Languages](#operation/api.languages.getMany)\n * `{columnNumber}` – a column number. Please note, that column numbering starts at 0\n\n __Note:__ Required for CSV or XLS/XLSX files"
41211+
description: "Defines data columns mapping. The passed value should be an associative array containing both language id and column number:\n* `{languageId}` – Crowdin id for the specified language. Get via [List Supported Languages](#operation/api.languages.getMany)\n* `{columnNumber}` – a column number. Please note, that column numbering starts at 0\n\n__Note:__ Required for CSV or XLS/XLSX files"
4120141212
type: object
4120241213
example:
4120341214
en: 0
@@ -41211,7 +41222,7 @@ components:
4121141222
- storageId
4121241223
properties:
4121341224
storageId:
41214-
description: "Storage Identifier. Get via [List Storages](#operation/api.storages.getMany)\n\n Supported file formats:\n * TMX\n * CSV\n * XLS/XLSX\n\n See TMX 1.4b Specification"
41225+
description: "Storage Identifier. Get via [List Storages](#operation/api.storages.getMany)\n\nSupported file formats:\n* TMX\n* CSV\n* XLS/XLSX\n\nSee TMX 1.4b Specification"
4121541226
type: integer
4121641227
format: int64
4121741228
firstLineContainsHeader:
@@ -41346,17 +41357,20 @@ components:
4134641357
userId:
4134741358
type: integer
4134841359
example: 2
41360+
nullable: true
4134941361
name:
4135041362
type: string
4135141363
example: "Knowledge Base's TM"
4135241364
languageId:
4135341365
type: string
4135441366
example: fr
41367+
nullable: true
4135541368
languageIds:
4135641369
type: array
4135741370
items:
4135841371
type: string
4135941372
example: el
41373+
nullable: true
4136041374
segmentsCount:
4136141375
description: 'Translation units count'
4136241376
type: integer
@@ -41371,13 +41385,15 @@ components:
4137141385
items:
4137241386
type: integer
4137341387
example: 2
41388+
nullable: true
4137441389
webUrl:
4137541390
type: string
4137641391
example: 'https://crowdin.com/profile/username/resources/traslation-memory/1'
4137741392
createdAt:
4137841393
type: string
4137941394
format: date-time
4138041395
example: '2019-09-16T13:42:04+00:00'
41396+
nullable: true
4138141397
type: object
4138241398
TmConcordance:
4138341399
title: Tm
@@ -41420,7 +41436,6 @@ components:
4142041436
nullable: true
4142141437
type: object
4142241438
TmExport:
41423-
description: 'Class TmExportResponseModel'
4142441439
properties:
4142541440
identifier:
4142641441
type: string
@@ -41456,13 +41471,14 @@ components:
4145641471
type: string
4145741472
format: date-time
4145841473
example: '2019-09-23T11:26:54+00:00'
41474+
nullable: true
4145941475
finishedAt:
4146041476
type: string
4146141477
format: date-time
4146241478
example: '2019-09-23T11:26:54+00:00'
41479+
nullable: true
4146341480
type: object
4146441481
TmImport:
41465-
description: 'Class TmImportResponseModel'
4146641482
properties:
4146741483
identifier:
4146841484
type: string
@@ -41509,6 +41525,7 @@ components:
4150941525
type: string
4151041526
format: date-time
4151141527
example: '2019-09-23T11:51:08+00:00'
41528+
nullable: true
4151241529
finishedAt:
4151341530
type: string
4151441531
format: date-time
@@ -41561,23 +41578,23 @@ components:
4156141578
CrowdinTranslationCreateDirectoryBuildForm:
4156241579
properties:
4156341580
targetLanguageIds:
41564-
description: "Specify target languages for build. Get via [List Supported Languages](#operation/api.languages.getMany)\n\n Leave this field empty to build all target languages"
41581+
description: "Specify target languages for build. Get via [List Supported Languages](#operation/api.languages.getMany)\n\nLeave this field empty to build all target languages"
4156541582
type: array
4156641583
items:
4156741584
type: string
4156841585
example: uk
4156941586
skipUntranslatedStrings:
41570-
description: "Defines whether to export only translated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedFiles=true` in same request\n\n [More info](https://support.crowdin.com/project-settings/export/)"
41587+
description: "Defines whether to export only translated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedFiles=true` in same request\n\n[More info](https://support.crowdin.com/project-settings/export/)"
4157141588
type: boolean
4157241589
default: false
4157341590
example: false
4157441591
skipUntranslatedFiles:
41575-
description: "Defines whether to export only translated file\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=true` in same request\n\n [More info](https://support.crowdin.com/project-settings/export/)"
41592+
description: "Defines whether to export only translated file\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=true` in same request\n\n[More info](https://support.crowdin.com/project-settings/export/)"
4157641593
type: boolean
4157741594
default: false
4157841595
example: false
4157941596
exportApprovedOnly:
41580-
description: "Defines whether to export only approved strings\n\n [More info](https://support.crowdin.com/project-settings/export/)"
41597+
description: "Defines whether to export only approved strings\n\n[More info](https://support.crowdin.com/project-settings/export/)"
4158141598
type: boolean
4158241599
default: false
4158341600
example: false
@@ -41600,15 +41617,15 @@ components:
4160041617
type: string
4160141618
example: uk
4160241619
skipUntranslatedStrings:
41603-
description: "Defines whether to export only translated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedFiles=true` in same request\n\n [More info](https://support.crowdin.com/project-settings/export/)"
41620+
description: "Defines whether to export only translated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedFiles=true` in same request\n\n[More info](https://support.crowdin.com/project-settings/export/)"
4160441621
type: boolean
4160541622
example: false
4160641623
skipUntranslatedFiles:
41607-
description: "Defines whether to export only translated files\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=true` in same request\n\n [More info](https://support.crowdin.com/project-settings/export/)"
41624+
description: "Defines whether to export only translated files\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=true` in same request\n\n[More info](https://support.crowdin.com/project-settings/export/)"
4160841625
type: boolean
4160941626
example: false
4161041627
exportApprovedOnly:
41611-
description: "Defines whether to export only approved strings\n\n [More info](https://support.crowdin.com/project-settings/export/)"
41628+
description: "Defines whether to export only approved strings\n\n[More info](https://support.crowdin.com/project-settings/export/)"
4161241629
type: boolean
4161341630
example: false
4161441631
type: object
@@ -41649,17 +41666,17 @@ components:
4164941666
type: integer
4165041667
example: 1
4165141668
skipUntranslatedStrings:
41652-
description: "Defines whether to export only translated strings\n\n__Note:__ Can't be used with `skipUntranslatedFiles` in same request\n\n [More info](https://support.crowdin.com/project-settings/export/)"
41669+
description: "Defines whether to export only translated strings\n\n__Note:__ Can't be used with `skipUntranslatedFiles` in same request\n\n[More info](https://support.crowdin.com/project-settings/export/)"
4165341670
type: boolean
4165441671
default: false
4165541672
example: false
4165641673
skipUntranslatedFiles:
41657-
description: "Defines whether to export only translated file\n\n__Note:__ Can't be used with `skipUntranslatedStrings` in same request\n\n [More info](https://support.crowdin.com/project-settings/export/)"
41674+
description: "Defines whether to export only translated file\n\n__Note:__ Can't be used with `skipUntranslatedStrings` in same request\n\n[More info](https://support.crowdin.com/project-settings/export/)"
4165841675
type: boolean
4165941676
default: false
4166041677
example: false
4166141678
exportApprovedOnly:
41662-
description: "Defines whether to export only approved strings\n\n [More info](https://support.crowdin.com/project-settings/export/)"
41679+
description: "Defines whether to export only approved strings\n\n[More info](https://support.crowdin.com/project-settings/export/)"
4166341680
type: boolean
4166441681
default: false
4166541682
example: false
@@ -41924,7 +41941,6 @@ components:
4192441941
$ref: '#/components/schemas/TranslationImportReport'
4192541942
AbstractDirectoryBuildResponseModel:
4192641943
title: 'Directory Build'
41927-
description: 'Class AbstractDirectoryBuildResponseModel'
4192841944
properties:
4192941945
id:
4193041946
type: integer
@@ -41963,7 +41979,6 @@ components:
4196341979
type: object
4196441980
AbstractProjectBuildResponse:
4196541981
title: 'Project Build'
41966-
description: 'Class AbstractProjectBuildResponseModel'
4196741982
properties:
4196841983
id:
4196941984
type: integer
@@ -42006,9 +42021,14 @@ components:
4200642021
allOf:
4200742022
-
4200842023
$ref: '#/components/schemas/AbstractDirectoryBuildResponseModel'
42024+
-
42025+
properties:
42026+
attributes:
42027+
$ref: '#/components/schemas/CrowdinDirectoryBuildAttributesResponseModel'
42028+
type: object
4200942029
-
4201042030
$ref: '#/components/schemas/AbstractDirectoryBuildResponseModel'
42011-
CrowdinDirectoryBuildResponseModel:
42031+
CrowdinDirectoryBuildAttributesResponseModel:
4201242032
title: 'Build Attributes'
4201342033
properties:
4201442034
directoryId:
@@ -42047,6 +42067,9 @@ components:
4204742067
$ref: '#/components/schemas/CrowdinBuildAttributesResponseModel'
4204842068
-
4204942069
$ref: '#/components/schemas/CrowdinPseudoBuildAttributesResponseModel'
42070+
type: object
42071+
-
42072+
$ref: '#/components/schemas/AbstractProjectBuildResponse'
4205042073
CrowdinBuildAttributesResponseModel:
4205142074
title: 'Build Attributes'
4205242075
properties:
@@ -42177,10 +42200,11 @@ components:
4217742200
type: string
4217842201
format: date-time
4217942202
example: '2025-09-23T11:51:08+00:00'
42203+
nullable: true
4218042204
finishedAt:
4218142205
type: string
4218242206
format: date-time
42183-
example: null
42207+
example: '2025-09-23T11:51:08+00:00'
4218442208
nullable: true
4218542209
type: object
4218642210
StringBasedTranslationFileImport:
@@ -42255,10 +42279,11 @@ components:
4225542279
type: string
4225642280
format: date-time
4225742281
example: '2025-09-23T11:51:08+00:00'
42282+
nullable: true
4225842283
finishedAt:
4225942284
type: string
4226042285
format: date-time
42261-
example: null
42286+
example: '2025-09-23T11:51:08+00:00'
4226242287
nullable: true
4226342288
type: object
4226442289
TranslationFileImport:
@@ -44638,29 +44663,6 @@ components:
4463844663
- 3
4463944664
- 4
4464044665
- 5
44641-
SourceLanguageId:
44642-
name: sourceLanguageId
44643-
in: query
44644-
description: 'Defines Source Language in language pair. Get via [List Supported Languages](#operation/api.languages.getMany)'
44645-
schema:
44646-
type: string
44647-
TargetLanguageId:
44648-
name: targetLanguageId
44649-
in: query
44650-
description: 'Defines Target Language in language pair. Get via [List Supported Languages](#operation/api.languages.getMany)'
44651-
schema:
44652-
type: string
44653-
Format:
44654-
name: format
44655-
in: query
44656-
description: 'Defines TMs file format'
44657-
schema:
44658-
type: string
44659-
default: tmx
44660-
enum:
44661-
- tmx
44662-
- csv
44663-
- xlsx
4466444666
TranslationExportProgressBranchId:
4466544667
name: branchId
4466644668
in: query

0 commit comments

Comments
 (0)