Browse Source

Adapt documentation to renamed ENABLE_SWAGGER option (#5811)

Updates documentation to account for the renamed ENABLE_SWAGGER_ENDPOINT from  #3572 (commit a74426d631)

Signed-off-by: Peter Colberg <peter@colberg.org>
tags/v1.9.0-dev
Peter Colberg zeripath 6 years ago
parent
commit
1805189690
3 changed files with 3 additions and 3 deletions
  1. +1
    -1
      docs/content/doc/advanced/api-usage.en-us.md
  2. +1
    -1
      docs/content/doc/advanced/api-usage.zh-cn.md
  3. +1
    -1
      docs/content/doc/advanced/config-cheat-sheet.en-us.md

+ 1
- 1
docs/content/doc/advanced/api-usage.en-us.md View File

@@ -17,7 +17,7 @@ menu:


## Enabling/configuring API access ## 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 `MAX_RESPONSE_ITEMS` is set to 50. See [Config Cheat
Sheet](https://docs.gitea.io/en-us/config-cheat-sheet/) for more Sheet](https://docs.gitea.io/en-us/config-cheat-sheet/) for more
information. information.


+ 1
- 1
docs/content/doc/advanced/api-usage.zh-cn.md View File

@@ -17,7 +17,7 @@ menu:


## 开启/配置 API 访问 ## 开启/配置 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/) 中获取更多配置相关信息。 Sheet](https://docs.gitea.io/en-us/config-cheat-sheet/) 中获取更多配置相关信息。


## 通过 API 认证 ## 通过 API 认证


+ 1
- 1
docs/content/doc/advanced/config-cheat-sheet.en-us.md View File

@@ -323,7 +323,7 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`.


## API (`api`) ## 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. - `MAX_RESPONSE_ITEMS`: **50**: Max number of items in a page.


## i18n (`i18n`) ## i18n (`i18n`)


Loading…
Cancel
Save