From 00f3e107f3335eeb82db47667c27a1f6e9e4639a Mon Sep 17 00:00:00 2001 From: kevgliss Date: Fri, 27 Aug 2021 14:34:53 -0700 Subject: [PATCH] Adds help menu (#1586) * Adds help menu --- docs/SUMMARY.md | 1 + docs/admin-guide/administration/api.md | 11 +++++++ .../dispatch/src/components/AppToolbar.vue | 32 ++++++++++++++----- 3 files changed, 36 insertions(+), 8 deletions(-) create mode 100644 docs/admin-guide/administration/api.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index a8c3c59edecc..221222f2c72f 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -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) diff --git a/docs/admin-guide/administration/api.md b/docs/admin-guide/administration/api.md new file mode 100644 index 000000000000..b832b13f2535 --- /dev/null +++ b/docs/admin-guide/administration/api.md @@ -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:///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:///api/v1/docs/openapi.json` diff --git a/src/dispatch/static/dispatch/src/components/AppToolbar.vue b/src/dispatch/static/dispatch/src/components/AppToolbar.vue index c35346e13257..768c05bc9f97 100644 --- a/src/dispatch/static/dispatch/src/components/AppToolbar.vue +++ b/src/dispatch/static/dispatch/src/components/AppToolbar.vue @@ -26,7 +26,6 @@ Dark Mode On - Dark Mode Off - -