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/help | |
| 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/help')
| -rw-r--r-- | docs/content/doc/help/faq.en-us.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/content/doc/help/faq.en-us.md b/docs/content/doc/help/faq.en-us.md index 970a6866a6..f71cd734a5 100644 --- a/docs/content/doc/help/faq.en-us.md +++ b/docs/content/doc/help/faq.en-us.md @@ -126,13 +126,13 @@ A "login prohibited" user is a user that is not allowed to log in to Gitea anymo ## What is Swagger? -[Swagger](https://swagger.io/) is what Gitea uses for its API. +[Swagger](https://swagger.io/) is what Gitea uses for its API documentation. -All Gitea instances have the built-in API, though it can be disabled by setting `ENABLE_SWAGGER` to `false` in the `api` section of your `app.ini` +All Gitea instances have the built-in API and there is no way to disable it completely. +You can, however, disable showing its documentation by setting `ENABLE_SWAGGER` to `false` in the `api` section of your `app.ini`. +For more information, refer to Gitea's [API docs]({{< relref "doc/developers/api-usage.en-us.md" >}}). -For more information, refer to Gitea's [API docs]({{< relref "doc/developers/api-usage.en-us.md" >}}) - -[Swagger Example](https://try.gitea.io/api/swagger) +You can see the latest API (for example) on <https://try.gitea.io/api/swagger>. ## Adjusting your server for public/private use |