Skip to content

Commit

Permalink
Adds help menu (#1586)
Browse files Browse the repository at this point in the history
* Adds help menu
  • Loading branch information
kevgliss authored Aug 27, 2021
1 parent d980e4d commit 00f3e10
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 8 deletions.
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
- [Definitions](admin-guide/administration/knowledge/definition.md)
- [Terms](admin-guide/administration/knowledge/term.md)
- [CLI](admin-guide/administration/cli.md)
- [API](admin-guide/administration/api.md)
- [Server](admin-guide/administration/server.md)
- [User](admin-guide/administration/user.md)
- [Contributing](contributing/README.md)
Expand Down
11 changes: 11 additions & 0 deletions docs/admin-guide/administration/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
description: Overview of the Dispatch API.
---

# API

Dispatch's API documentation is generated automatically. To see your installations available API visit `https://<your-dispatch-domain>/api/v1/docs`

While we don't currently maintain or distribute API clients, because we generate our API documentation via the OpenAPI spec it is available to any client generation libraries that can read the spec. You can find the raw spec for your installation at:

`https://<your-dispatch-domain>/api/v1/docs/openapi.json`
32 changes: 24 additions & 8 deletions src/dispatch/static/dispatch/src/components/AppToolbar.vue
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
</template>
<span>Dark Mode On</span>
</v-tooltip>

<v-tooltip v-else bottom>
<template v-slot:activator="{ on }">
<v-btn v-on="on" small icon @click="toggleDarkTheme">
Expand All @@ -35,15 +34,32 @@
</template>
<span>Dark Mode Off</span>
</v-tooltip>
<v-tooltip bottom>
<template v-slot:activator="{ on }">
<v-btn icon v-on="on" @click="handleFullScreen()">
<v-icon>fullscreen</v-icon>
<v-menu offset-y>
<template v-slot:activator="{ on, attrs }">
<v-btn icon v-bind="attrs" v-on="on">
<v-icon>help_outline</v-icon>
</v-btn>
</template>
<span>Fullscreen</span>
</v-tooltip>
<v-menu bottom left transition="scale-transition" origin="top right">
<v-list dense>
<v-list-item href="/api/v1/docs" target="_blank">
<v-list-item-title>API Documentation</v-list-item-title>
<v-list-item-action>
<v-list-item-icon>
<v-icon small>open_in_new</v-icon>
</v-list-item-icon>
</v-list-item-action>
</v-list-item>
<v-list-item href="https://hawkins.gitbook.io/dispatch/" target="_blank">
<v-list-item-title>App Documentation</v-list-item-title>
<v-list-item-action>
<v-list-item-icon>
<v-icon small>open_in_new</v-icon>
</v-list-item-icon>
</v-list-item-action>
</v-list-item>
</v-list>
</v-menu>
<v-menu offset-y>
<template v-slot:activator="{ on }">
<v-btn icon large text v-on="on">
<v-avatar size="30px">
Expand Down

0 comments on commit 00f3e10

Please sign in to comment.