Skip to content

Commit

Permalink
Adapt documentation to renamed ENABLE_SWAGGER option (#5811)
Browse files Browse the repository at this point in the history
Updates documentation to account for the renamed ENABLE_SWAGGER_ENDPOINT from  #3572 (commit a74426d)

Signed-off-by: Peter Colberg <peter@colberg.org>
  • Loading branch information
petercolberg authored and zeripath committed Jan 23, 2019
1 parent 0b51072 commit 904188c
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/content/doc/advanced/api-usage.en-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/doc/advanced/api-usage.zh-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 认证
Expand Down
2 changes: 1 addition & 1 deletion docs/content/doc/advanced/config-cheat-sheet.en-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`)
Expand Down

0 comments on commit 904188c

Please sign in to comment.