From 86c35a34256967a7156d5f9de47476ece23e8a70 Mon Sep 17 00:00:00 2001 From: beiyuouo Date: Thu, 11 Aug 2022 13:17:10 +0800 Subject: [PATCH] build: add response --- docs/hcaptcha/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/hcaptcha/README.md b/docs/hcaptcha/README.md index a37b106..ad0c9fb 100644 --- a/docs/hcaptcha/README.md +++ b/docs/hcaptcha/README.md @@ -33,6 +33,21 @@ File: | ----- | ------ | ------------------------ | | `img` | `file` | The challenge image file | +Response: `JSON` + +| Key | Type | Description | +| --------- | -------- | ------------------------------------------------------------------------------ | +| `result` | `list` | The result, e.g. `[true, false, true, false, false, true, false, false, true]` | +| `message` | `string` | The message, e.g. `error information` | + +Status Code: + +| Code | Description | +| ----- | ------------------------------------------------------------------------------------ | +| `200` | Success | +| `400` | Bad Request, some parameters are missing or invalid | +| `500` | Server Error, unexpected error, please open an issue or leave a feedback in comments | + ## Examples ### Python