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