Skip to content

[ACL-949] Add show_billed_characters parameter to OpenAPI spec #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Sep 13, 2024
Merged

[ACL-949] Add show_billed_characters parameter to OpenAPI spec #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
fe1823a
[ACL-949] Add show_billed_characters to OpenAPI spec
mike-winters-deepl Sep 10, 2024
be1a5c7
Updates to openapi_gitbook.yaml
mike-winters-deepl Sep 10, 2024
96db7f6
Formatting fixes
mike-winters-deepl Sep 10, 2024
b5b0fc4
Update response info
mike-winters-deepl Sep 10, 2024
4ad107b
Typo fix in GitBook file
mike-winters-deepl Sep 10, 2024
2995d18
Update openapi.json to match openapi.yaml
mike-winters-deepl Sep 10, 2024
71f71bc
Incorporate copy edit feedback
mike-winters-deepl Sep 10, 2024
aabe2b1
Update openapi.json to match openapi.yaml
mike-winters-deepl Sep 10, 2024
6c5a9f7
Rearrange entries in schemas
mike-winters-deepl Sep 13, 2024
bf58bb2
Update openapi.json to match openapi.yaml
mike-winters-deepl Sep 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,9 @@
"context": {
"$ref": "#/components/schemas/Context"
},
"show_billed_characters": {
"$ref": "#/components/schemas/ShowBilledCharacters"
},
"split_sentences": {
"$ref": "#/components/schemas/SplitSentencesOption"
},
Expand Down Expand Up @@ -184,6 +187,9 @@
"context": {
"$ref": "#/components/schemas/Context"
},
"show_billed_characters": {
"$ref": "#/components/schemas/ShowBilledCharacters"
},
"split_sentences": {
"$ref": "#/components/schemas/SplitSentencesOption"
},
Expand Down Expand Up @@ -252,6 +258,10 @@
"text": {
"description": "The translated text.",
"type": "string"
},
"billed_characters": {
"description": "Number of characters counted by DeepL for billing purposes. Only present if the show_billed_characters parameter is set to true.",
"type": "integer"
}
}
}
Expand All @@ -264,7 +274,8 @@
"translations": [
{
"detected_source_language": "EN",
"text": "Hallo, Welt!"
"text": "Hallo, Welt!",
"billed_characters": 42
}
]
}
Expand Down Expand Up @@ -1854,6 +1865,10 @@
],
"default": "0"
},
"ShowBilledCharacters": {
"description": "When true, the response will include the billed_characters parameter, giving the \nnumber of characters from the request that will be counted by DeepL for billing purposes.",
"type": "boolean"
},
"SplitSentencesOption": {
"description": "Sets whether the translation engine should first split the input into sentences. For text translations where \n`tag_handling` is not set to `html`, the default value is `1`, meaning the engine splits on punctuation and on newlines.\n\nFor text translations where `tag_handling=html`, the default value is `nonewlines`, meaning the engine splits on punctuation only, ignoring newlines. \n\nThe use of `nonewlines` as the default value for text translations where `tag_handling=html` is new behavior that was implemented in November 2022, \nwhen HTML handling was moved out of beta. \n\nPossible values are: \n\n * `0` - no splitting at all, whole input is treated as one sentence\n * `1` (default when `tag_handling` is not set to `html`) - splits on punctuation and on newlines\n * `nonewlines` (default when `tag_handling=html`) - splits on punctuation only, ignoring newlines\n\nFor applications that send one sentence per text parameter, we recommend setting `split_sentences` to `0`, in order to prevent the engine from splitting the sentence unintentionally.\n\n\nPlease note that newlines will split sentences when `split_sentences=1`. We recommend cleaning files so they don't contain breaking sentences or setting the parameter `split_sentences` to `nonewlines`.",
"type": "string",
Expand Down
14 changes: 14 additions & 0 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,8 @@ paths:
$ref: '#/components/schemas/TargetLanguageText'
context:
$ref: '#/components/schemas/Context'
show_billed_characters:
$ref: '#/components/schemas/ShowBilledCharacters'
split_sentences:
$ref: '#/components/schemas/SplitSentencesOption'
preserve_formatting:
Expand Down Expand Up @@ -212,6 +214,8 @@ paths:
$ref: '#/components/schemas/TargetLanguageText'
context:
$ref: '#/components/schemas/Context'
show_billed_characters:
$ref: '#/components/schemas/ShowBilledCharacters'
split_sentences:
$ref: '#/components/schemas/SplitSentencesOption'
preserve_formatting:
Expand Down Expand Up @@ -262,12 +266,17 @@ paths:
text:
description: The translated text.
type: string
billed_characters:
description: Number of characters counted by DeepL for billing purposes.
Only present if the show_billed_characters parameter is set to true.
type: integer
examples:
Basic:
value:
translations:
- detected_source_language: EN
text: Hallo, Welt!
billed_characters: 42
Glossary:
value:
translations:
Expand Down Expand Up @@ -1547,6 +1556,11 @@ components:
- '0'
- '1'
default: '0'
ShowBilledCharacters:
description: |-
When true, the response will include the billed_characters parameter, giving the
number of characters from the request that will be counted by DeepL for billing purposes.
type: boolean
SplitSentencesOption:
description: |-
Sets whether the translation engine should first split the input into sentences. For text translations where
Expand Down
28 changes: 21 additions & 7 deletions openapi_gitbook.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@ paths:
$ref: '#/components/schemas/TargetLanguageText'
context:
$ref: '#/components/schemas/Context'
show_billed_characters:
$ref: '#/components/schemas/ShowBilledCharacters'
split_sentences:
$ref: '#/components/schemas/SplitSentencesOption'
preserve_formatting:
Expand Down Expand Up @@ -150,6 +152,8 @@ paths:
$ref: '#/components/schemas/TargetLanguageText'
context:
$ref: '#/components/schemas/Context'
show_billed_characters:
$ref: '#/components/schemas/ShowBilledCharacters'
split_sentences:
$ref: '#/components/schemas/SplitSentencesOption'
preserve_formatting:
Expand Down Expand Up @@ -214,6 +218,11 @@ paths:
description: The translated text.
type: string
example: Hallo, Welt!
billed_characters:
description: Number of characters counted by DeepL for billing purposes.
Only present if the show_billed_characters parameter is set to true.
type: integer
example: 42
400:
$ref: '#/components/responses/BadRequest'
403:
Expand Down Expand Up @@ -1156,6 +1165,13 @@ components:
name: Authorization
in: header
schemas:
Context:
description: |-
Additional context that can influence a translation but is not translated itself.

Characters included in the `context` parameter will not be counted toward billing.
type: string
example: This is context.
CreateGlossaryParameters:
type: object
required:
Expand Down Expand Up @@ -1315,13 +1331,6 @@ components:
using the `splitting_tags` parameter.
type: boolean
default: true
Context:
description: |-
Additional context that can influence a translation but is not translated itself.

Characters included in the `context` parameter will not be counted toward billing.
type: string
example: This is context.
OutlineDetectionOptionStr:
description: |-
Disable the automatic detection of XML structure by setting the `outline_detection` parameter
Expand All @@ -1346,6 +1355,11 @@ components:
- '0'
- '1'
default: '0'
ShowBilledCharacters:
description: |-
When true, the response will include the billed_characters parameter, giving the
number of characters from the request that will be counted by DeepL for billing purposes.
type: boolean
SplitSentencesOption:
description: |-
Sets whether the translation engine should first split the input into sentences.
Expand Down