Skip to content

docs: add swagger.json file location to FAQ #22489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 17, 2023
Merged

docs: add swagger.json file location to FAQ #22489

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5abf740
docs: add swagger.json file location to FAQ
jolheiser Jan 17, 2023
deef612
review: fix br
jolheiser Jan 17, 2023
18dd8da
Merge branch 'main' into swagger-file
zeripath Jan 17, 2023
27c6c90
Merge branch 'main' into swagger-file
jolheiser Jan 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/content/doc/help/faq.en-us.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,8 @@ All Gitea instances have the built-in API and there is no way to disable it comp
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" >}}).

You can see the latest API (for example) on <https://try.gitea.io/api/swagger>.
You can see the latest API (for example) on <https://try.gitea.io/api/swagger>.
You can also see an example of the `swagger.json` file at <https://try.gitea.io/swagger.v1.json>.

## Adjusting your server for public/private use

Expand Down