Skip to content

Commit 565ec22

Browse files
fix: Update the example for style rules in the API playgrounds (#286)
1 parent 2c6f91c commit 565ec22

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

api-reference/openapi.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2357,6 +2357,19 @@ paths:
23572357
source_language:
23582358
type: string
23592359
description: Optional source language code
2360+
example:
2361+
name: "My style rules"
2362+
language: "de"
2363+
configured_rules:
2364+
style_and_tone:
2365+
abbreviations: "use_abbreviations_and_symbols"
2366+
short_vs_long_words: "use_short_words"
2367+
punctuation:
2368+
apostrophe: "use_curly_apostrophes"
2369+
custom_instructions:
2370+
- label: "Currency custom instruction"
2371+
prompt: "Have currency symbols before the numerical value (e.g. $100, €100)"
2372+
source_language: "en"
23602373
responses:
23612374
201:
23622375
description: Style rule list created successfully
@@ -2575,6 +2588,9 @@ paths:
25752588
source_language:
25762589
type: string
25772590
description: Optional source language code
2591+
example:
2592+
label: "Currency custom instruction"
2593+
prompt: "Have currency symbols before the numerical value (e.g. $100, €100)"
25782594
responses:
25792595
201:
25802596
description: Custom instruction created successfully
@@ -4273,6 +4289,12 @@ components:
42734289
- rephrase_loanword_in_daily_use_chinese_or_japanese_words_if_possible
42744290
- rephrase_loanword_with_another_expression_if_not_established
42754291
- use_loanword_as_is_if_well_established
4292+
example:
4293+
style_and_tone:
4294+
abbreviations: "use_abbreviations_and_symbols"
4295+
short_vs_long_words: "use_short_words"
4296+
punctuation:
4297+
apostrophe: "use_curly_apostrophes"
42764298
Context:
42774299
description: |-
42784300
Additional context that can influence a translation but is not translated itself.

0 commit comments

Comments
 (0)