Skip to content

Commit 05e4cf4

Browse files
committed
docs(API): Mention upload limits on upload endpoint docs
1 parent 501bd0f commit 05e4cf4

File tree

3 files changed

+10
-2
lines changed

3 files changed

+10
-2
lines changed

doc/compiled.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1812,6 +1812,7 @@
18121812
"type": "integer"
18131813
},
18141814
"translation_keys_unmentioned": {
1815+
"description": "The number of translation keys in the project that were not mentioned in the upload.\n\nNote: this field is not calculated (and shows 0) if the upload contains more than 10,000 keys.\n",
18151816
"type": "integer"
18161817
},
18171818
"translations_created": {
@@ -14669,7 +14670,7 @@
1466914670
"/projects/{project_id}/uploads": {
1467014671
"post": {
1467114672
"summary": "Upload a new file",
14672-
"description": "Upload a new language file. Creates necessary resources in your project.",
14673+
"description": "Upload a new language file. Creates necessary resources in your project.\n\nNote: be aware of [upload limits](https://support.phrase.com/hc/en-us/articles/8548271212188-Phrase-Strings-Limits#file-size-upload-limits-0-0).\n",
1467314674
"operationId": "upload/create",
1467414675
"tags": [
1467514676
"Uploads"

paths/uploads/create.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
summary: Upload a new file
2-
description: Upload a new language file. Creates necessary resources in your project.
2+
description: |
3+
Upload a new language file. Creates necessary resources in your project.
4+
5+
Note: be aware of [upload limits](https://support.phrase.com/hc/en-us/articles/8548271212188-Phrase-Strings-Limits#file-size-upload-limits-0-0).
36
operationId: upload/create
47
tags:
58
- Uploads

schemas/upload.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ upload:
3535
translation_keys_updated:
3636
type: integer
3737
translation_keys_unmentioned:
38+
description: |
39+
The number of translation keys in the project that were not mentioned in the upload.
40+
41+
Note: this field is not calculated (and shows 0) if the upload contains more than 10,000 keys.
3842
type: integer
3943
translations_created:
4044
type: integer

0 commit comments

Comments
 (0)