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

Make descriptions consistently end with periods

Browse Source
This commit is contained in:
Richard Willis 2020-08-04 11:33:42 +01:00
parent 354ee1f6af
commit c5ce31ca86
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
api/mailinabox.yml
View File

@ -1,7 +1,7 @@
openapi: 3.0.3 openapi: 3.0.3
info: info:
title: Mail-in-a-Box title: Mail-in-a-Box
description: 'Mail-in-a-Box API HTTP specification.' description: Mail-in-a-Box API HTTP specification.
contact: contact:
name: Mail-in-a-Box support name: Mail-in-a-Box support
url: https://mailinabox.email/ url: https://mailinabox.email/
@ -10,14 +10,14 @@ info:
url: https://creativecommons.org/publicdomain/zero/1.0/legalcode url: https://creativecommons.org/publicdomain/zero/1.0/legalcode
version: '0.46.0' version: '0.46.0'
externalDocs: externalDocs:
description: Find out more about Mail-in-a-box description: Find out more about Mail-in-a-box.
url: https://mailinabox.email/ url: https://mailinabox.email/
servers: servers:
- url: https://{host}/admin - url: https://{host}/admin
variables: variables:
host: host:
default: box.example.com default: box.example.com
description: The API hostname description: The API hostname.
security: security:
- basicAuth: [] - basicAuth: []
tags: tags:
@ -414,7 +414,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/Hostname' $ref: '#/components/schemas/Hostname'
required: true required: true
description: Domain to generate CSR for description: Domain to generate CSR for.
requestBody: requestBody:
required: true required: true
content: content:
@ -628,7 +628,7 @@ paths:
get: get:
tags: tags:
- DNS - DNS
description: Get DNS records for domain and type description: Get DNS records for domain and type.
operationId: getDnsCustomRecordsForDomainAndType operationId: getDnsCustomRecordsForDomainAndType
responses: responses:
200: 200:
@ -731,11 +731,11 @@ paths:
schema: schema:
$ref: '#/components/schemas/Hostname' $ref: '#/components/schemas/Hostname'
required: true required: true
description: DNS record domain description: DNS record domain.
get: get:
tags: tags:
- DNS - DNS
description: Get DNS A records for domain description: Get DNS A records for domain.
operationId: getDnsCustomRecordsForDomainAndTypeA operationId: getDnsCustomRecordsForDomainAndTypeA
responses: responses:
200: 200:
@ -872,7 +872,7 @@ paths:
name: format name: format
schema: schema:
$ref: '#/components/schemas/MailUsersResponseFormat' $ref: '#/components/schemas/MailUsersResponseFormat'
description: The format of the response description: The format of the response.
responses: responses:
200: 200:
description: Successful operation description: Successful operation
@ -1104,7 +1104,7 @@ paths:
name: format name: format
schema: schema:
$ref: '#/components/schemas/MailAliasesResponseFormat' $ref: '#/components/schemas/MailAliasesResponseFormat'
description: The format of the response description: The format of the response.
responses: responses:
200: 200:
description: Successful operation description: Successful operation
@ -1239,14 +1239,14 @@ components:
the users password, or the `api_key` returned from the `getMe` operation. the users password, or the `api_key` returned from the `getMe` operation.
requestBodies: requestBodies:
DNSCustomRecordRequest: DNSCustomRecordRequest:
description: The value of the DNS record description: The value of the DNS record.
required: true required: true
content: content:
text/plain: text/plain:
schema: schema:
type: string type: string
example: 1.2.3.4 example: 1.2.3.4
description: The value of the DNS record description: The value of the DNS record.
schemas: schemas:
MailUsersResponseFormat: MailUsersResponseFormat:
type: string type: string