diff --git a/docs/index.adoc b/docs/index.adoc index e609448..32e1490 100644 --- a/docs/index.adoc +++ b/docs/index.adoc @@ -52,6 +52,8 @@ at runtime. Most functions are mapped to endpoints in the form of `/{function}/{languageCode}`. For example, spelling requests for the Northern Sámi language are to be made to `/speller/se`. +NOTE: The length of the data argument below (the text between the quotes following `"text:"` in the examples below) is limited to 2^15-12 bytes, ie 32 756 bytes. Remember that non-ASCII characters will use at least two bytes each in UTF-8 encoding, so in practice, the usable amount of text varies by language. + Example for checking the spelling of a word with curl on the default server: [source] diff --git a/docs/index.html b/docs/index.html index daab053..6463045 100644 --- a/docs/index.html +++ b/docs/index.html @@ -548,6 +548,18 @@
Most functions are mapped to endpoints in the form of /{function}/{languageCode}
. For example, spelling requests
for the Northern Sámi language are to be made to /speller/se
.
+ Note
+ |
+
+The length of the data argument below (the text between the quotes following "text:" in the examples below) is limited to 2^15-12 bytes, ie 32 756 bytes. Remember that non-ASCII characters will use at least two bytes each in UTF-8 encoding, so in practice, the usable amount of text varies by language.
+ |
+
Example for checking the spelling of a word with curl on the default server: