From fb825ae7e0c8f61d150b1c313b8c931c0bc3b7b1 Mon Sep 17 00:00:00 2001 From: Francesco Zardi Date: Thu, 29 Aug 2024 18:09:25 +0200 Subject: [PATCH] fix: documentation for /apisix/admin/check_ssl_exists --- docs/en/latest/api/api.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/en/latest/api/api.md b/docs/en/latest/api/api.md index 2b43da6321..f8221e5920 100644 --- a/docs/en/latest/api/api.md +++ b/docs/en/latest/api/api.md @@ -91,21 +91,20 @@ verify SSL cert and key. ##### Summary -Check whether the SSL exists. +Check whether the SSL exists for all of the specified hosts. ##### Parameters -| Name | Located in | Description | Required | Schema | -| ---- | ---------- | ----------- | -------- | ------ | -| cert | body | cert of SSL | Yes | string | -| key | body | key of SSL | Yes | string | +| Name | Located in | Description | Required | Schema | +| ----- | ---------- | ------------ | -------- | ---------- | +| hosts | body | List of SNIs | Yes | [ string ] | ##### Responses -| Code | Description | Schema | -| ------- | ---------------- | --------------------- | -| 0 | SSL exists | [ApiError](#ApiError) | -| default | unexpected error | [ApiError](#ApiError) | +| Code | Description | Schema | +| ------- | ------------------------------------ | --------------------- | +| 0 | SSL certificate exists for all hosts | [ApiError](#ApiError) | +| default | unexpected error | [ApiError](#ApiError) | ### /apisix/admin/consumers