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 /custom | |
| 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 'custom')
| -rw-r--r-- | custom/conf/app.example.ini | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/custom/conf/app.example.ini b/custom/conf/app.example.ini index 6e1eca7a62..0e0822d4c5 100644 --- a/custom/conf/app.example.ini +++ b/custom/conf/app.example.ini @@ -2153,7 +2153,7 @@ ROUTER = console ;[api] ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -;; Enables Swagger. True or false; default is true. +;; Enables the API documentation endpoints (/api/swagger, /api/v1/swagger, …). True or false. ;ENABLE_SWAGGER = true ;; Max number of items in a page ;MAX_RESPONSE_ITEMS = 50 @@ -2161,7 +2161,7 @@ ROUTER = console ;DEFAULT_PAGING_NUM = 30 ;; Default and maximum number of items per page for git trees api ;DEFAULT_GIT_TREES_PER_PAGE = 1000 -;; Default size of a blob returned by the blobs API (default is 10MiB) +;; Default max size of a blob returned by the blobs API (default is 10MiB) ;DEFAULT_MAX_BLOB_SIZE = 10485760 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |