Browse Source

Api spec cleanup (#1869)

* Fix indentation

* Add parameter definition and remove unused model

* Update version

* Quote example string
tags/v0.52
Richard Willis 5 months ago
parent
commit
f66e609d3f
No account linked to committer's email address
1 changed files with 33 additions and 33 deletions
  1. +33
    -33
      api/mailinabox.yml

+ 33
- 33
api/mailinabox.yml View File

@@ -15,7 +15,7 @@ info:
license:
name: CC0 1.0 Universal
url: https://creativecommons.org/publicdomain/zero/1.0/legalcode
version: 0.47.0
version: 0.51.0
x-logo:
url: https://mailinabox.email/static/logo.png
altText: Mail-in-a-Box logo
@@ -744,30 +744,37 @@ paths:
schema:
type: string
/dns/zonefile/{zone}:
get:
tags:
- DNS
summary: Get DNS zonefile
description: Returns an array of all managed top-level domains.
operationId: getDnsZonefile
x-codeSamples:
- lang: curl
source: |
curl -X GET "https://{host}/admin/dns/zonefile/<zone>" \
-u "<email>:<password>"
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DNSZonefileResponse'
403:
description: Forbidden
content:
text/html:
schema:
type: string
parameters:
- in: path
name: zone
schema:
$ref: '#/components/schemas/Hostname'
required: true
description: Hostname
get:
tags:
- DNS
summary: Get DNS zonefile
description: Returns a DNS zone file for a hostname.
operationId: getDnsZonefile
x-codeSamples:
- lang: curl
source: |
curl -X GET "https://{host}/admin/dns/zonefile/<zone>" \
-u "<email>:<password>"
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DNSZonefileResponse'
403:
description: Forbidden
content:
text/html:
schema:
type: string
/dns/update:
post:
tags:
@@ -1806,7 +1813,7 @@ components:
text/plain:
schema:
type: string
example: 1.2.3.4
example: '1.2.3.4'
description: The value of the DNS record.
example: '1.2.3.4'
schemas:
@@ -2690,13 +2697,6 @@ components:
type: string
MfaEnableSuccessResponse:
type: string
MfaEnableBadRequestResponse:
type: object
required:
- error
properties:
error:
type: string
MfaDisableRequest:
type: object
properties:

Loading…
Cancel
Save