summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPeter Colberg <peter@colberg.org>2019-01-23 15:09:18 -0500
committerzeripath <art27@cantab.net>2019-01-23 20:09:18 +0000
commit904188ce9cf24fd960db383f3672783572692d6e (patch)
treebe37f3e128c1434662748527e0765d4814f181ae
parent0b510725c97452bac57ff0080df10f6177aa2a6e (diff)
downloadgitea-904188ce9cf24fd960db383f3672783572692d6e.tar.gz
gitea-904188ce9cf24fd960db383f3672783572692d6e.zip
Adapt documentation to renamed ENABLE_SWAGGER option (#5811)
Updates documentation to account for the renamed ENABLE_SWAGGER_ENDPOINT from #3572 (commit a74426d631e3311cc3c460ae9917f76f0221f4de) Signed-off-by: Peter Colberg <peter@colberg.org>
-rw-r--r--docs/content/doc/advanced/api-usage.en-us.md2
-rw-r--r--docs/content/doc/advanced/api-usage.zh-cn.md2
-rw-r--r--docs/content/doc/advanced/config-cheat-sheet.en-us.md2
3 files changed, 3 insertions, 3 deletions
diff --git a/docs/content/doc/advanced/api-usage.en-us.md b/docs/content/doc/advanced/api-usage.en-us.md
index 369bae6cac..0000465c49 100644
--- a/docs/content/doc/advanced/api-usage.en-us.md
+++ b/docs/content/doc/advanced/api-usage.en-us.md
@@ -17,7 +17,7 @@ menu:
## Enabling/configuring API access
-By default, `ENABLE_SWAGGER_ENDPOINT` is true, and
+By default, `ENABLE_SWAGGER` is true, and
`MAX_RESPONSE_ITEMS` is set to 50. See [Config Cheat
Sheet](https://docs.gitea.io/en-us/config-cheat-sheet/) for more
information.
diff --git a/docs/content/doc/advanced/api-usage.zh-cn.md b/docs/content/doc/advanced/api-usage.zh-cn.md
index de02a24b0f..0f11e040ba 100644
--- a/docs/content/doc/advanced/api-usage.zh-cn.md
+++ b/docs/content/doc/advanced/api-usage.zh-cn.md
@@ -17,7 +17,7 @@ menu:
## 开启/配置 API 访问
-通常情况下, `ENABLE_SWAGGER_ENDPOINT` 默认开启并且参数 `MAX_RESPONSE_ITEMS` 默认为 50。您可以从 [Config Cheat
+通常情况下, `ENABLE_SWAGGER` 默认开启并且参数 `MAX_RESPONSE_ITEMS` 默认为 50。您可以从 [Config Cheat
Sheet](https://docs.gitea.io/en-us/config-cheat-sheet/) 中获取更多配置相关信息。
## 通过 API 认证
diff --git a/docs/content/doc/advanced/config-cheat-sheet.en-us.md b/docs/content/doc/advanced/config-cheat-sheet.en-us.md
index 0a98774638..775fef6f89 100644
--- a/docs/content/doc/advanced/config-cheat-sheet.en-us.md
+++ b/docs/content/doc/advanced/config-cheat-sheet.en-us.md
@@ -323,7 +323,7 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`.
## API (`api`)
-- `ENABLE_SWAGGER_ENDPOINT`: **true**: Enables /api/swagger, /api/v1/swagger etc. endpoints. True or false; default is true.
+- `ENABLE_SWAGGER`: **true**: Enables /api/swagger, /api/v1/swagger etc. endpoints. True or false; default is true.
- `MAX_RESPONSE_ITEMS`: **50**: Max number of items in a page.
## i18n (`i18n`)