Bug 22343: API routes for SMTP servers CRUD
[koha.git] / api / v1 / swagger / definitions / smtp_server.json
1 {
2   "type": "object",
3   "properties": {
4     "smtp_server_id": {
5       "type": "integer",
6       "description": "Internal SMTP server identifier",
7       "readOnly": true
8     },
9     "name": {
10       "type": "string",
11       "description": "Name of the SMTP server"
12     },
13     "host": {
14       "type": "string",
15       "description": "SMTP host name"
16     },
17     "port": {
18       "type": "integer",
19       "description": "TCP port number"
20     },
21     "timeout": {
22       "type": "integer",
23       "description": "Maximum time in seconds to wait for server"
24     },
25     "ssl_mode": {
26       "type": "string",
27       "enum": [
28         "disabled",
29         "ssl",
30         "starttls"
31       ],
32       "description": "If SSL/TLS will be used"
33     },
34     "user_name": {
35       "type": [
36         "string",
37         "null"
38       ],
39       "description": "The user name to use for authentication (optional)"
40     },
41     "password": {
42       "type": [
43         "string",
44         "null"
45       ],
46       "description": "The password to use for authentication (optional)"
47     },
48     "debug": {
49       "type": "boolean",
50       "description": "If the SMTP connection is set to debug mode"
51     }
52   },
53   "additionalProperties": false,
54   "required": [
55     "name"
56   ]
57 }