From 3ed9eb7f96f50ae185a38474e5b21d4808c6fd94 Mon Sep 17 00:00:00 2001
From: Richard Willis <willis.rh@gmail.com>
Date: Fri, 14 Aug 2020 12:21:06 +0100
Subject: [PATCH] Add introduction section to description

---
 api/mailinabox.yml | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/api/mailinabox.yml b/api/mailinabox.yml
index de8184e0..2db700d9 100644
--- a/api/mailinabox.yml
+++ b/api/mailinabox.yml
@@ -1,7 +1,14 @@
 openapi: 3.0.3
 info:
   title: Mail-in-a-Box
-  description: Mail-in-a-Box API HTTP specification.
+  description: |
+    Mail-in-a-Box API HTTP specification.
+
+    # Introduction
+    This API is documented in [**OpenAPI format**](http://spec.openapis.org/oas/v3.0.3).
+    ([View the full HTTP specification](https://raw.githubusercontent.com/badsyntax/mailinabox/api-spec/api/mailinabox.yml).)
+
+    All endpoints are relative to `https://{host}/admin` and are secured with [`Basic Access` authentication](https://en.wikipedia.org/wiki/Basic_access_authentication).
   contact:
     name: Mail-in-a-Box support
     url: https://mailinabox.email/