Skip to content

Commit 2960196

Browse files
chore(developer): update API docs (#586)
1 parent a72a738 commit 2960196

File tree

2 files changed

+181
-21
lines changed

2 files changed

+181
-21
lines changed

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

Lines changed: 92 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26052,6 +26052,8 @@ components:
2605226052
- /includeInContextPseudoLanguage
2605326053
- /labelIds
2605426054
- /excludeLabelIds
26055+
- /labelMatchRule
26056+
- /excludeLabelMatchRule
2605526057
type: object
2605626058
discriminator:
2605726059
propertyName: op
@@ -26094,16 +26096,14 @@ components:
2609426096
BundleCreateForm:
2609526097
required:
2609626098
- name
26097-
- format
2609826099
- sourcePatterns
26099-
- exportPattern
2610026100
properties:
2610126101
name:
2610226102
description: 'Defines name'
2610326103
type: string
2610426104
example: 'Resx bundle'
2610526105
format:
26106-
description: 'Defines export file format'
26106+
description: "Defines export file format. If not provided, files will be exported in their original format.\n\n__Note:__ Required for strings-based projects"
2610726107
type: string
2610826108
example: crowdin-resx
2610926109
sourcePatterns:
@@ -26119,9 +26119,10 @@ components:
2611926119
type: string
2612026120
example: /masterBranch
2612126121
exportPattern:
26122-
description: "Bundle export pattern. Defines bundle name in resulting translations bundle\n\n__Note:__ Can't contain `: * ? \" < > |` symbols"
26122+
description: "Bundle export pattern. Defines bundle name in resulting translations bundle. **Required** if `format` is specified. If `format` is not specified, uses default pattern based on file structure\n\n__Note:__ Can't contain `: * ? \" < > |` symbols"
2612326123
type: string
2612426124
example: strings-%two_letter_code%.resx
26125+
nullable: true
2612526126
isMultilingual:
2612626127
description: 'Export translations in multilingual file'
2612726128
type: boolean
@@ -26139,21 +26140,47 @@ components:
2613926140
type: boolean
2614026141
default: true
2614126142
labelIds:
26142-
description: 'Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)'
26143+
description: "Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)\n\n__Note:__ Can't be used when `format` is `null`"
2614326144
type: array
2614426145
items:
2614526146
type: integer
2614626147
example:
2614726148
- 13
2614826149
- 27
2614926150
excludeLabelIds:
26150-
description: 'Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)'
26151+
description: "Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)\n\n__Note:__ Can't be used when `format` is `null`"
2615126152
type: array
2615226153
items:
2615326154
type: integer
2615426155
example:
2615526156
- 5
2615626157
- 8
26158+
labelMatchRule:
26159+
description: "Match rule for labels:\n- \"all\" - all labels must be present in string\n- \"any\" - any of the labels must be present in string\n\n __Note:__ Can only be used when `labelIds` parameter is provided"
26160+
type: string
26161+
default: all
26162+
enum:
26163+
- all
26164+
- any
26165+
nullable: true
26166+
excludeLabelMatchRule:
26167+
description: "Match rule for excluded labels:\n - \"all\" - all labels must be present in string\n - \"any\" - any of the labels must be present in string\n\n __Note:__ Can only be used when `excludeLabelIds` parameter is provided"
26168+
type: string
26169+
default: all
26170+
enum:
26171+
- all
26172+
- any
26173+
nullable: true
26174+
languageIds:
26175+
description: 'Language Identifiers. Get via [List Supported Languages](#operation/api.languages.getMany). If provided, bundle will only export specified languages. If not provided, bundle will export all project target languages.'
26176+
type: array
26177+
items:
26178+
type: string
26179+
example:
26180+
- uk
26181+
- de
26182+
- fr
26183+
nullable: true
2615726184
type: object
2615826185
BundleCollectionResource:
2615926186
description: 'Bundle Collection Resource'
@@ -26242,6 +26269,7 @@ components:
2624226269
format:
2624326270
type: string
2624426271
example: crowdin-resx
26272+
nullable: true
2624526273
sourcePatterns:
2624626274
type: array
2624726275
items:
@@ -26255,6 +26283,7 @@ components:
2625526283
exportPattern:
2625626284
type: string
2625726285
example: strings-%two_letters_code%.resx
26286+
nullable: true
2625826287
isMultilingual:
2625926288
type: boolean
2626026289
default: false
@@ -26267,6 +26296,20 @@ components:
2626726296
sourceLanguageExportPattern:
2626826297
type: string
2626926298
example: strings-%two_letters_code%.resx
26299+
labelMatchRule:
26300+
type: string
26301+
enum:
26302+
- all
26303+
- any
26304+
example: all
26305+
nullable: true
26306+
excludeLabelMatchRule:
26307+
type: string
26308+
enum:
26309+
- all
26310+
- any
26311+
example: any
26312+
nullable: true
2627026313
labelIds:
2627126314
type: array
2627226315
items:
@@ -26281,6 +26324,15 @@ components:
2628126324
example:
2628226325
- 5
2628326326
- 8
26327+
languageIds:
26328+
type: array
26329+
items:
26330+
type: string
26331+
example:
26332+
- uk
26333+
- de
26334+
- fr
26335+
nullable: true
2628426336
webUrl:
2628526337
type: string
2628626338
example: 'https://crowdin.com/project/test/translations#bundles:100'
@@ -27740,7 +27792,8 @@ components:
2774027792
enum:
2774127793
- default
2774227794
- bundle
27743-
example: bundle
27795+
example: default
27796+
deprecated: true
2774427797
name:
2774527798
description: 'Distribution name'
2774627799
type: string
@@ -27754,6 +27807,7 @@ components:
2775427807
- 24
2775527808
- 25
2775627809
- 38
27810+
deprecated: true
2775727811
bundleIds:
2775827812
description: "Bundles ids. Get via [List Bundles](#operation/api.projects.bundles.getMany)\n\n__Note:__ Required for `bundle` export mode"
2775927813
type: array
@@ -44925,6 +44979,7 @@ components:
4492544979
- /fields
4492644980
- '/fields/{fieldSlug}'
4492744981
- /generateCostEstimate
44982+
- /generateTranslationCost
4492844983
- /reportSettingsTemplateId
4492944984
x-doc-sections:
4493044985
- file-based
@@ -45011,6 +45066,7 @@ components:
4501145066
- /excludeLabelIds
4501245067
- /excludeLabelMatchRule
4501345068
- /generateCostEstimate
45069+
- /generateTranslationCost
4501445070
- /reportSettingsTemplateId
4501545071
x-doc-sections:
4501645072
- file-based
@@ -45426,8 +45482,13 @@ components:
4542645482
type: boolean
4542745483
default: false
4542845484
example: false
45485+
generateTranslationCost:
45486+
description: 'Generate translation cost report for the task. Requires `reportSettingsTemplateId`'
45487+
type: boolean
45488+
default: false
45489+
example: false
4542945490
reportSettingsTemplateId:
45430-
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.reports.settings-templates.getMany). Required when `generateCostEstimate` is `true`'
45491+
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.reports.settings-templates.getMany). Required when `generateCostEstimate` or `generateTranslationCost` is `true`'
4543145492
type: integer
4543245493
example: 1
4543345494
nullable: true
@@ -45546,8 +45607,13 @@ components:
4554645607
type: boolean
4554745608
default: false
4554845609
example: false
45610+
generateTranslationCost:
45611+
description: 'Generate translation cost report for the task. Requires `reportSettingsTemplateId`'
45612+
type: boolean
45613+
default: false
45614+
example: false
4554945615
reportSettingsTemplateId:
45550-
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.reports.settings-templates.getMany). Required when `generateCostEstimate` is `true`'
45616+
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.reports.settings-templates.getMany). Required when `generateCostEstimate` or `generateTranslationCost` is `true`'
4555145617
type: integer
4555245618
example: 1
4555345619
nullable: true
@@ -45673,8 +45739,13 @@ components:
4567345739
type: boolean
4567445740
default: false
4567545741
example: false
45742+
generateTranslationCost:
45743+
description: 'Generate translation cost report for the task. Requires `reportSettingsTemplateId`'
45744+
type: boolean
45745+
default: false
45746+
example: false
4567645747
reportSettingsTemplateId:
45677-
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.reports.settings-templates.getMany). Required when `generateCostEstimate` is `true`'
45748+
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.reports.settings-templates.getMany). Required when `generateCostEstimate` or `generateTranslationCost` is `true`'
4567845749
type: integer
4567945750
example: 1
4568045751
nullable: true
@@ -45769,8 +45840,13 @@ components:
4576945840
type: boolean
4577045841
default: false
4577145842
example: false
45843+
generateTranslationCost:
45844+
description: 'Generate translation cost report for the task. Requires `reportSettingsTemplateId`'
45845+
type: boolean
45846+
default: false
45847+
example: false
4577245848
reportSettingsTemplateId:
45773-
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.reports.settings-templates.getMany). Required when `generateCostEstimate` is `true`'
45849+
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.reports.settings-templates.getMany). Required when `generateCostEstimate` or `generateTranslationCost` is `true`'
4577445850
type: integer
4577545851
example: 1
4577645852
nullable: true
@@ -46334,6 +46410,11 @@ components:
4633446410
generateCostEstimate:
4633546411
type: boolean
4633646412
example: true
46413+
nullable: true
46414+
generateTranslationCost:
46415+
type: boolean
46416+
example: true
46417+
nullable: true
4633746418
reportSettingsTemplateId:
4633846419
type: integer
4633946420
example: 1

0 commit comments

Comments
 (0)