Skip to content

Commit a72a738

Browse files
github-actions[bot]github-actions[bot]
authored
chore(developer): update API docs (#584)
1 parent ba32d0c commit a72a738

File tree

2 files changed

+227
-29
lines changed

2 files changed

+227
-29
lines changed

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

Lines changed: 115 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22605,6 +22605,8 @@ components:
2260522605
- /includeInContextPseudoLanguage
2260622606
- /labelIds
2260722607
- /excludeLabelIds
22608+
- /labelMatchRule
22609+
- /excludeLabelMatchRule
2260822610
type: object
2260922611
discriminator:
2261022612
propertyName: op
@@ -22647,16 +22649,14 @@ components:
2264722649
BundleCreateForm:
2264822650
required:
2264922651
- name
22650-
- format
2265122652
- sourcePatterns
22652-
- exportPattern
2265322653
properties:
2265422654
name:
2265522655
description: 'Defines name'
2265622656
type: string
2265722657
example: 'Resx bundle'
2265822658
format:
22659-
description: 'Defines export file format'
22659+
description: "Defines export file format. If not provided, files will be exported in their original format.\n\n__Note:__ Required for strings-based projects"
2266022660
type: string
2266122661
example: crowdin-resx
2266222662
sourcePatterns:
@@ -22672,9 +22672,10 @@ components:
2267222672
type: string
2267322673
example: /masterBranch
2267422674
exportPattern:
22675-
description: "Bundle export pattern. Defines bundle name in resulting translations bundle\n\n__Note:__ Can't contain `: * ? \" < > |` symbols"
22675+
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"
2267622676
type: string
2267722677
example: strings-%two_letter_code%.resx
22678+
nullable: true
2267822679
isMultilingual:
2267922680
description: 'Export translations in multilingual file'
2268022681
type: boolean
@@ -22692,21 +22693,47 @@ components:
2269222693
type: boolean
2269322694
default: true
2269422695
labelIds:
22695-
description: 'Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)'
22696+
description: "Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)\n\n__Note:__ Can't be used when `format` is `null`"
2269622697
type: array
2269722698
items:
2269822699
type: integer
2269922700
example:
2270022701
- 13
2270122702
- 27
2270222703
excludeLabelIds:
22703-
description: 'Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)'
22704+
description: "Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)\n\n__Note:__ Can't be used when `format` is `null`"
2270422705
type: array
2270522706
items:
2270622707
type: integer
2270722708
example:
2270822709
- 5
2270922710
- 8
22711+
labelMatchRule:
22712+
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"
22713+
type: string
22714+
default: all
22715+
enum:
22716+
- all
22717+
- any
22718+
nullable: true
22719+
excludeLabelMatchRule:
22720+
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"
22721+
type: string
22722+
default: all
22723+
enum:
22724+
- all
22725+
- any
22726+
nullable: true
22727+
languageIds:
22728+
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.'
22729+
type: array
22730+
items:
22731+
type: string
22732+
example:
22733+
- uk
22734+
- de
22735+
- fr
22736+
nullable: true
2271022737
type: object
2271122738
BundleCollectionResource:
2271222739
description: 'Bundle Collection Resource'
@@ -22795,6 +22822,7 @@ components:
2279522822
format:
2279622823
type: string
2279722824
example: crowdin-resx
22825+
nullable: true
2279822826
sourcePatterns:
2279922827
type: array
2280022828
items:
@@ -22808,6 +22836,7 @@ components:
2280822836
exportPattern:
2280922837
type: string
2281022838
example: strings-%two_letters_code%.resx
22839+
nullable: true
2281122840
isMultilingual:
2281222841
type: boolean
2281322842
default: false
@@ -22820,6 +22849,20 @@ components:
2282022849
sourceLanguageExportPattern:
2282122850
type: string
2282222851
example: strings-%two_letters_code%.resx
22852+
labelMatchRule:
22853+
type: string
22854+
enum:
22855+
- all
22856+
- any
22857+
example: all
22858+
nullable: true
22859+
excludeLabelMatchRule:
22860+
type: string
22861+
enum:
22862+
- all
22863+
- any
22864+
example: any
22865+
nullable: true
2282322866
labelIds:
2282422867
type: array
2282522868
items:
@@ -22834,6 +22877,15 @@ components:
2283422877
example:
2283522878
- 5
2283622879
- 8
22880+
languageIds:
22881+
type: array
22882+
items:
22883+
type: string
22884+
example:
22885+
- uk
22886+
- de
22887+
- fr
22888+
nullable: true
2283722889
webUrl:
2283822890
type: string
2283922891
example: 'https://crowdin.com/project/test/translations#bundles:100'
@@ -24293,7 +24345,8 @@ components:
2429324345
enum:
2429424346
- default
2429524347
- bundle
24296-
example: bundle
24348+
example: default
24349+
deprecated: true
2429724350
name:
2429824351
description: 'Distribution name'
2429924352
type: string
@@ -24307,6 +24360,7 @@ components:
2430724360
- 24
2430824361
- 25
2430924362
- 38
24363+
deprecated: true
2431024364
bundleIds:
2431124365
description: "Bundles ids. Get via [List Bundles](#operation/api.projects.bundles.getMany)\n\n__Note:__ Required for `bundle` export mode"
2431224366
type: array
@@ -38210,6 +38264,7 @@ components:
3821038264
- /excludeLabelIds
3821138265
- /excludeLabelMatchRule
3821238266
- /generateCostEstimate
38267+
- /generateTranslationCost
3821338268
- /reportSettingsTemplateId
3821438269
x-doc-sections:
3821538270
- file-based
@@ -38680,8 +38735,13 @@ components:
3868038735
type: boolean
3868138736
default: false
3868238737
example: false
38738+
generateTranslationCost:
38739+
description: 'Generate translation cost report for the task. Requires `reportSettingsTemplateId`'
38740+
type: boolean
38741+
default: false
38742+
example: false
3868338743
reportSettingsTemplateId:
38684-
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany)[p. Required when `generateCostEstimate` is `true`'
38744+
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany)[p. Required when `generateCostEstimate` or `generateTranslationCost` is `true`'
3868538745
type: integer
3868638746
example: 1
3868738747
nullable: true
@@ -38785,8 +38845,13 @@ components:
3878538845
type: boolean
3878638846
default: false
3878738847
example: false
38848+
generateTranslationCost:
38849+
description: 'Generate translation cost report for the task. Requires `reportSettingsTemplateId`'
38850+
type: boolean
38851+
default: false
38852+
example: false
3878838853
reportSettingsTemplateId:
38789-
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany)[p. Required when `generateCostEstimate` is `true`'
38854+
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany)[p. Required when `generateCostEstimate` or `generateTranslationCost` is `true`'
3879038855
type: integer
3879138856
example: 1
3879238857
nullable: true
@@ -38907,8 +38972,13 @@ components:
3890738972
type: boolean
3890838973
default: false
3890938974
example: false
38975+
generateTranslationCost:
38976+
description: 'Generate translation cost report for the task. Requires `reportSettingsTemplateId`'
38977+
type: boolean
38978+
default: false
38979+
example: false
3891038980
reportSettingsTemplateId:
38911-
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany)[p. Required when `generateCostEstimate` is `true`'
38981+
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany)[p. Required when `generateCostEstimate` or `generateTranslationCost` is `true`'
3891238982
type: integer
3891338983
example: 1
3891438984
nullable: true
@@ -39133,8 +39203,13 @@ components:
3913339203
type: boolean
3913439204
default: false
3913539205
example: false
39206+
generateTranslationCost:
39207+
description: 'Generate translation cost report for the task. Requires `reportSettingsTemplateId`'
39208+
type: boolean
39209+
default: false
39210+
example: false
3913639211
reportSettingsTemplateId:
39137-
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany)[p. Required when `generateCostEstimate` is `true`'
39212+
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany)[p. Required when `generateCostEstimate` or `generateTranslationCost` is `true`'
3913839213
type: integer
3913939214
example: 1
3914039215
nullable: true
@@ -39226,8 +39301,13 @@ components:
3922639301
type: boolean
3922739302
default: false
3922839303
example: false
39304+
generateTranslationCost:
39305+
description: 'Generate translation cost report for the task. Requires `reportSettingsTemplateId`'
39306+
type: boolean
39307+
default: false
39308+
example: false
3922939309
reportSettingsTemplateId:
39230-
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany)[p. Required when `generateCostEstimate` is `true`'
39310+
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany)[p. Required when `generateCostEstimate` or `generateTranslationCost` is `true`'
3923139311
type: integer
3923239312
example: 1
3923339313
nullable: true
@@ -39375,8 +39455,13 @@ components:
3937539455
type: boolean
3937639456
default: false
3937739457
example: false
39458+
generateTranslationCost:
39459+
description: 'Generate translation cost report for the task. Requires `reportSettingsTemplateId`'
39460+
type: boolean
39461+
default: false
39462+
example: false
3937839463
reportSettingsTemplateId:
39379-
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany)[p. Required when `generateCostEstimate` is `true`'
39464+
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany)[p. Required when `generateCostEstimate` or `generateTranslationCost` is `true`'
3938039465
type: integer
3938139466
example: 1
3938239467
nullable: true
@@ -39611,8 +39696,13 @@ components:
3961139696
type: boolean
3961239697
default: false
3961339698
example: false
39699+
generateTranslationCost:
39700+
description: 'Generate translation cost report for the task. Requires `reportSettingsTemplateId`'
39701+
type: boolean
39702+
default: false
39703+
example: false
3961439704
reportSettingsTemplateId:
39615-
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany)[p. Required when `generateCostEstimate` is `true`'
39705+
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany)[p. Required when `generateCostEstimate` or `generateTranslationCost` is `true`'
3961639706
type: integer
3961739707
example: 1
3961839708
nullable: true
@@ -39698,8 +39788,13 @@ components:
3969839788
type: boolean
3969939789
default: false
3970039790
example: false
39791+
generateTranslationCost:
39792+
description: 'Generate translation cost report for the task. Requires `reportSettingsTemplateId`'
39793+
type: boolean
39794+
default: false
39795+
example: false
3970139796
reportSettingsTemplateId:
39702-
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany)[p. Required when `generateCostEstimate` is `true`'
39797+
description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany)[p. Required when `generateCostEstimate` or `generateTranslationCost` is `true`'
3970339798
type: integer
3970439799
example: 1
3970539800
nullable: true
@@ -40284,6 +40379,11 @@ components:
4028440379
generateCostEstimate:
4028540380
type: boolean
4028640381
example: true
40382+
nullable: true
40383+
generateTranslationCost:
40384+
type: boolean
40385+
example: true
40386+
nullable: true
4028740387
reportSettingsTemplateId:
4028840388
type: integer
4028940389
example: 1

0 commit comments

Comments
 (0)