diff options
| author | delvh <leon@kske.dev> | 2022-09-20 00:48:48 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-20 00:48:48 +0200 |
| commit | 0c51595eedbb68643af73314ae1ab43eb5c95715 (patch) | |
| tree | 03bef465a6e94f56de299e4d48800c8656713c31 /docs/content/doc/advanced/config-cheat-sheet.en-us.md | |
| parent | d0e3c53815cebea8189afd83bcc6f3d840f3f899 (diff) | |
| download | gitea-0c51595eedbb68643af73314ae1ab43eb5c95715.tar.gz gitea-0c51595eedbb68643af73314ae1ab43eb5c95715.zip | |
Clarify that `ENABLE_SWAGGER` only influences the API docs, not the routes (#21215)
Previously, the docs seemed to suggest that you can disable the API
completely by setting `ENABLE_SWAGGER=false`.
This is not the case.
Diffstat (limited to 'docs/content/doc/advanced/config-cheat-sheet.en-us.md')
| -rw-r--r-- | docs/content/doc/advanced/config-cheat-sheet.en-us.md | 4 |
1 files changed, 2 insertions, 2 deletions
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 459e42ac24..f39c501cbc 100644 --- a/docs/content/doc/advanced/config-cheat-sheet.en-us.md +++ b/docs/content/doc/advanced/config-cheat-sheet.en-us.md @@ -1015,11 +1015,11 @@ Default templates for project boards: ## API (`api`) -- `ENABLE_SWAGGER`: **true**: Enables /api/swagger, /api/v1/swagger etc. endpoints. True or false; default is true. +- `ENABLE_SWAGGER`: **true**: Enables the API documentation endpoints (`/api/swagger`, `/api/v1/swagger`, …). True or false. - `MAX_RESPONSE_ITEMS`: **50**: Max number of items in a page. - `DEFAULT_PAGING_NUM`: **30**: Default paging number of API. - `DEFAULT_GIT_TREES_PER_PAGE`: **1000**: Default and maximum number of items per page for Git trees API. -- `DEFAULT_MAX_BLOB_SIZE`: **10485760**: Default max size of a blob that can be return by the blobs API. +- `DEFAULT_MAX_BLOB_SIZE`: **10485760** (10MiB): Default max size of a blob that can be returned by the blobs API. ## OAuth2 (`oauth2`) |