Tomas Cohen Arazi
d6c67eddd3
This patch moves all the REST API spec pieces into YAML. To test: 1. Run: $ kshell k$ prove t/db_dependent/api/v1/* => SUCCESS: Tests pass 2. Apply this patch 3. Repeat 1 => SUCCESS: Tests still pass! 4. Sign off :-D Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com> Signed-off-by: Fridolin Somers <fridolin.somers@biblibre.com>
42 lines
905 B
YAML
42 lines
905 B
YAML
---
|
|
type: object
|
|
properties:
|
|
smtp_server_id:
|
|
type: integer
|
|
description: Internal SMTP server identifier
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
description: Name of the SMTP server
|
|
host:
|
|
type: string
|
|
description: SMTP host name
|
|
port:
|
|
type: integer
|
|
description: TCP port number
|
|
timeout:
|
|
type: integer
|
|
description: Maximum time in seconds to wait for server
|
|
ssl_mode:
|
|
type: string
|
|
enum:
|
|
- disabled
|
|
- ssl
|
|
- starttls
|
|
description: If SSL/TLS will be used
|
|
user_name:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: The user name to use for authentication (optional)
|
|
password:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: The password to use for authentication (optional)
|
|
debug:
|
|
type: boolean
|
|
description: If the SMTP connection is set to debug mode
|
|
additionalProperties: false
|
|
required:
|
|
- name
|