external/mailinabox
1
0
Fork 0
mirror of https://github.com/mail-in-a-box/mailinabox.git synced 2025-04-20 02:52:11 +00:00
Code Issues Releases Wiki Activity

Remove contact email and add example text/html responses

Browse Source
This commit is contained in:
Richard Willis 2020-08-15 08:41:28 +01:00
parent 3ed9eb7f96
commit aa9b9618e2
1 changed files with 49 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
api/mailinabox.yml
View File

@ -12,7 +12,6 @@ info:
contact: contact:
name: Mail-in-a-Box support name: Mail-in-a-Box support
url: https://mailinabox.email/ url: https://mailinabox.email/
email: contact@mailinabox.email
license: license:
name: CC0 1.0 Universal name: CC0 1.0 Universal
url: https://creativecommons.org/publicdomain/zero/1.0/legalcode url: https://creativecommons.org/publicdomain/zero/1.0/legalcode
@ -144,6 +143,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/SystemVersionResponse' $ref: '#/components/schemas/SystemVersionResponse'
example: v0.46
403: 403:
description: Forbidden description: Forbidden
content: content:
@ -169,6 +169,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/SystemVersionUpstreamResponse' $ref: '#/components/schemas/SystemVersionUpstreamResponse'
example: v0.47
403: 403:
description: Forbidden description: Forbidden
content: content:
@ -194,6 +195,9 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/SystemUpdatesResponse' $ref: '#/components/schemas/SystemUpdatesResponse'
example: |
libgnutls30 (3.5.18-1ubuntu1.4)
libxau6 (1:1.0.8-1ubuntu1)
403: 403:
description: Forbidden description: Forbidden
content: content:
@ -219,6 +223,10 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/SystemUpdatePackagesResponse' $ref: '#/components/schemas/SystemUpdatePackagesResponse'
example: |
Calculating upgrade...
The following packages will be upgraded:
cloud-init grub-common
403: 403:
description: Forbidden description: Forbidden
content: content:
@ -261,7 +269,7 @@ paths:
- System - System
summary: Update system privacy summary: Update system privacy
description: | description: |
Updates system privacy (new-version) check status. Updates system privacy (new-version checks).
Request: Request:
@ -296,6 +304,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/SystemPrivacyUpdateResponse' $ref: '#/components/schemas/SystemPrivacyUpdateResponse'
example: OK
400: 400:
description: Bad request description: Bad request
content: content:
@ -357,6 +366,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/SystemRebootResponse' $ref: '#/components/schemas/SystemRebootResponse'
example: No reboot is required, so it is not allowed.
403: 403:
description: Forbidden description: Forbidden
content: content:
@ -473,6 +483,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/SystemBackupConfigUpdateResponse' $ref: '#/components/schemas/SystemBackupConfigUpdateResponse'
example: OK
400: 400:
description: Bad request description: Bad request
content: content:
@ -546,6 +557,12 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/SSLCSRGenerateResponse' $ref: '#/components/schemas/SSLCSRGenerateResponse'
example: |
-----BEGIN CERTIFICATE REQUEST-----
MIICaDCCAVACAQAwIzELMAkGA1UEBhMCQlMxFDASBgNVBAMMC2V4YW1wbGUuY29t
...
JmFDQESSfUxLPHLC660Wnf3GmrP/duZHpPC+qTe8b1AlQ7zDT3cOaAQ+Mb0=
-----END CERTIFICATE REQUEST-----
400: 400:
description: Bad request description: Bad request
content: content:
@ -591,6 +608,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/SSLCertificateInstallResponse' $ref: '#/components/schemas/SSLCertificateInstallResponse'
example: OK
400: 400:
description: Bad request description: Bad request
content: content:
@ -683,6 +701,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/DNSSecondaryNameserverAddResponse' $ref: '#/components/schemas/DNSSecondaryNameserverAddResponse'
example: 'updated DNS: example.com'
400: 400:
description: Bad request description: Bad request
content: content:
@ -846,6 +865,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/DNSCustomRecordUpsertResponse' $ref: '#/components/schemas/DNSCustomRecordUpsertResponse'
example: 'updated DNS: example.com'
400: 400:
description: Bad request description: Bad request
content: content:
@ -881,6 +901,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/DNSCustomRecordUpsertResponse' $ref: '#/components/schemas/DNSCustomRecordUpsertResponse'
example: 'updated DNS: example.com'
400: 400:
description: Bad request description: Bad request
content: content:
@ -916,6 +937,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/DNSCustomRecordRemoveResponse' $ref: '#/components/schemas/DNSCustomRecordRemoveResponse'
example: 'updated DNS: example.com'
400: 400:
description: Bad request description: Bad request
content: content:
@ -983,6 +1005,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/DNSCustomRecordUpsertResponse' $ref: '#/components/schemas/DNSCustomRecordUpsertResponse'
example: 'updated DNS: example.com'
400: 400:
description: Bad request description: Bad request
content: content:
@ -1018,6 +1041,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/DNSCustomRecordUpsertResponse' $ref: '#/components/schemas/DNSCustomRecordUpsertResponse'
example: 'updated DNS: example.com'
400: 400:
description: Bad request description: Bad request
content: content:
@ -1053,6 +1077,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/DNSCustomRecordRemoveResponse' $ref: '#/components/schemas/DNSCustomRecordRemoveResponse'
example: 'updated DNS: example.com'
400: 400:
description: Bad request description: Bad request
content: content:
@ -1130,6 +1155,9 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/MailUsersSimpleResponse' $ref: '#/components/schemas/MailUsersSimpleResponse'
example: |
user1@example.com
user2@example.com
403: 403:
description: Forbidden description: Forbidden
content: content:
@ -1177,6 +1205,9 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/MailUserAddResponse' $ref: '#/components/schemas/MailUserAddResponse'
example: |
mail user added
updated DNS: OpenDKIM configuration
400: 400:
description: Bad request description: Bad request
content: content:
@ -1218,6 +1249,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/MailUserRemoveResponse' $ref: '#/components/schemas/MailUserRemoveResponse'
example: OK
400: 400:
description: Bad request description: Bad request
content: content:
@ -1261,6 +1293,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/MailUserAddPrivilegeResponse' $ref: '#/components/schemas/MailUserAddPrivilegeResponse'
example: OK
400: 400:
description: Bad request description: Bad request
content: content:
@ -1304,6 +1337,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/MailUserRemovePrivilegeResponse' $ref: '#/components/schemas/MailUserRemovePrivilegeResponse'
example: OK
400: 400:
description: Bad request description: Bad request
content: content:
@ -1347,6 +1381,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/MailUserSetPasswordResponse' $ref: '#/components/schemas/MailUserSetPasswordResponse'
example: OK
400: 400:
description: Bad request description: Bad request
content: content:
@ -1385,6 +1420,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/MailUserPrivilegesResponse' $ref: '#/components/schemas/MailUserPrivilegesResponse'
example: admin
403: 403:
description: Forbidden description: Forbidden
content: content:
@ -1410,6 +1446,9 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/MailDomainsResponse' $ref: '#/components/schemas/MailDomainsResponse'
example: |
example1.com
example2.com
403: 403:
description: Forbidden description: Forbidden
content: content:
@ -1446,6 +1485,9 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/MailAliasesSimpleResponse' $ref: '#/components/schemas/MailAliasesSimpleResponse'
example: |
abuse@example.com administrator@example.com
admin@example.com administrator@example.com
403: 403:
description: Forbidden description: Forbidden
content: content:
@ -1511,6 +1553,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/MailAliasUpsertResponse' $ref: '#/components/schemas/MailAliasUpsertResponse'
example: alias updated
400: 400:
description: Bad request description: Bad request
content: content:
@ -1552,6 +1595,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/MailAliasRemoveResponse' $ref: '#/components/schemas/MailAliasRemoveResponse'
example: alias removed
400: 400:
description: Bad request description: Bad request
content: content:
@ -1611,6 +1655,7 @@ paths:
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/WebUpdateResponse' $ref: '#/components/schemas/WebUpdateResponse'
example: web updated
403: 403:
description: Forbidden description: Forbidden
content: content:
@ -1627,8 +1672,8 @@ components:
format `Authorization: Basic {access-token}`. format `Authorization: Basic {access-token}`.
The `access-token` is comprised of the Base64 encoding of `username:password`. The `access-token` is comprised of the Base64 encoding of `username:password`.
The `password` can either be the users password, or the `api_key` returned from The `username` is the mail user's email address, and `password` can either be the mail user's
the `getMe` operation. password, or the `api_key` returned from the `getMe` operation.
When using `curl`, you can supply user credentials using the `-u` or `--user` parameter. When using `curl`, you can supply user credentials using the `-u` or `--user` parameter.
requestBodies: requestBodies: