1
0
mirror of https://github.com/mail-in-a-box/mailinabox.git synced 2025-04-20 02:52:11 +00:00

Add introduction section to description

This commit is contained in:
Richard Willis 2020-08-14 12:21:06 +01:00
parent 69da179009
commit 3ed9eb7f96

View File

@ -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/