Update `size` description

This commit is contained in:
hrj 2022-04-04 21:47:49 +05:30
parent c71fdbb8de
commit 44432cbd5a
1 changed files with 4 additions and 4 deletions

View File

@ -139,10 +139,10 @@ The service can be accessed using a simple HTTP API.
- image/png
- image/gif
- (More to come)
- `size`: `Map` -
The dimensions of a captcha (Optional). It needs two more fields nested in this parameter
- `height`: `Int`
- `width`: `Int`
- `size`: String -
The dimensions of a captcha. It needs to be a string in the format `"widthxheight"` in pixels, and will be matched
with the `allowedSizes` config setting. Example: `size: "450x200"` which requests an image of width 450 and height
200 pixels.
- Returns:
- `id`: `String` - The uuid of the captcha generated