mirror of
https://github.com/spacebarchat/docs.git
synced 2024-09-19 23:21:40 +02:00
✨ swagger ui
This commit is contained in:
parent
d8600c9278
commit
a383cc5135
@ -1,11 +1,5 @@
|
||||
# API
|
||||
# Routes
|
||||
|
||||
### [Status overview](https://github.com/discord-open-source/discord-api/projects/2)
|
||||
!!swagger openapi.json!!
|
||||
|
||||
This is the fosscord HTTP API Server.
|
||||
|
||||
Every routes has its own [issue](https://github.com/fosscord/fosscord-api/issues?q=is%3Aopen+is%3Aissue+label%3ARoute).
|
||||
|
||||
For documentation, head over to the [Discord docs](https://discord.dev).
|
||||
|
||||
If you want to work on a feature please comment on the corresponding issue so we can assign it you that nobody implements something twice.
|
||||
<!-- !!swagger-http https://raw.githubusercontent.com/fosscord/fosscord-server/master/api/assets/openapi.json!! -->
|
||||
|
24
mkdocs.yml
24
mkdocs.yml
@ -3,8 +3,8 @@ repo_url: https://github.com/fosscord/fosscord
|
||||
edit_uri: https://github.com/fosscord/fosscord-docs/edit/master/docs/
|
||||
site_description: Documentation of Fosscord a free open source selfhostable chat, voice and video discord-compatible platform
|
||||
plugins:
|
||||
- section-index
|
||||
- search
|
||||
- render_swagger
|
||||
theme:
|
||||
name: material
|
||||
logo: assets/logo.png
|
||||
@ -26,28 +26,6 @@ theme:
|
||||
- navigation.sections
|
||||
- navigation.indexes
|
||||
- navigation.top
|
||||
nav:
|
||||
- index.md
|
||||
- resources.md
|
||||
- setup.md
|
||||
- contributing.md
|
||||
- encryption.md
|
||||
- "API":
|
||||
- api/index.md
|
||||
- api/structure.md
|
||||
- api/configuration.md
|
||||
- server_util/database.md
|
||||
- server_util/permissions.md
|
||||
- api/route.md
|
||||
- "Gateway":
|
||||
- gateway/index.md
|
||||
- gateway/structure.md
|
||||
- "Ui Framework":
|
||||
- ui/index.md
|
||||
- ui/contribution_and_installation.md
|
||||
- "Client":
|
||||
- client/index.md
|
||||
- plugins.md
|
||||
markdown_extensions:
|
||||
- pymdownx.highlight
|
||||
- pymdownx.superfences
|
||||
|
Loading…
Reference in New Issue
Block a user