Line 0
Link Here
|
|
|
1 |
--- |
2 |
/smtp/domain_limits: |
3 |
get: |
4 |
x-mojo-to: Config::SMTP::DomainLimits#list |
5 |
operationId: listDomainLimits |
6 |
tags: |
7 |
- domain_limits |
8 |
summary: List mail domain limits |
9 |
produces: |
10 |
- application/json |
11 |
parameters: |
12 |
- $ref: ../swagger.yaml#/parameters/match |
13 |
- $ref: ../swagger.yaml#/parameters/order_by |
14 |
- $ref: ../swagger.yaml#/parameters/page |
15 |
- $ref: ../swagger.yaml#/parameters/per_page |
16 |
- $ref: ../swagger.yaml#/parameters/q_param |
17 |
- $ref: ../swagger.yaml#/parameters/q_body |
18 |
- $ref: ../swagger.yaml#/parameters/request_id_header |
19 |
responses: |
20 |
"200": |
21 |
description: A list of domain limits |
22 |
schema: |
23 |
type: array |
24 |
items: |
25 |
$ref: "../swagger.yaml#/definitions/smtp_domain_limits" |
26 |
"403": |
27 |
description: Access forbidden |
28 |
schema: |
29 |
$ref: "../swagger.yaml#/definitions/error" |
30 |
"500": |
31 |
description: | |
32 |
Internal server error. Possible `error_code` attribute values: |
33 |
|
34 |
* `internal_server_error` |
35 |
schema: |
36 |
$ref: "../swagger.yaml#/definitions/error" |
37 |
"503": |
38 |
description: Under maintenance |
39 |
schema: |
40 |
$ref: "../swagger.yaml#/definitions/error" |
41 |
x-koha-authorization: |
42 |
permissions: |
43 |
parameters: manage_smtp_servers |
44 |
post: |
45 |
x-mojo-to: Config::SMTP::DomainLimits#add |
46 |
operationId: addDomainLimit |
47 |
tags: |
48 |
- domain_limits |
49 |
summary: Add a new domain limit |
50 |
parameters: |
51 |
- name: body |
52 |
in: body |
53 |
description: A JSON object representing a new domain limit |
54 |
required: true |
55 |
schema: |
56 |
$ref: "../swagger.yaml#/definitions/smtp_domain_limits" |
57 |
consumes: |
58 |
- application/json |
59 |
produces: |
60 |
- application/json |
61 |
responses: |
62 |
"201": |
63 |
description: Created a domain limit |
64 |
schema: |
65 |
$ref: "../swagger.yaml#/definitions/smtp_domain_limits" |
66 |
"400": |
67 |
description: Bad Request |
68 |
schema: |
69 |
$ref: ../swagger.yaml#/definitions/error |
70 |
"403": |
71 |
description: Access forbidden |
72 |
schema: |
73 |
$ref: ../swagger.yaml#/definitions/error |
74 |
"404": |
75 |
description: Object not found |
76 |
schema: |
77 |
$ref: ../swagger.yaml#/definitions/error |
78 |
"409": |
79 |
description: Conflict in creating resource |
80 |
schema: |
81 |
$ref: "../swagger.yaml#/definitions/error" |
82 |
"500": |
83 |
description: | |
84 |
Internal server error. Possible `error_code` attribute values: |
85 |
* `internal_server_error` |
86 |
schema: |
87 |
$ref: ../swagger.yaml#/definitions/error |
88 |
"503": |
89 |
description: Under maintenance |
90 |
schema: |
91 |
$ref: ../swagger.yaml#/definitions/error |
92 |
x-koha-authorization: |
93 |
permissions: |
94 |
parameters: manage_smtp_servers |
95 |
"/smtp/domain_limits/{domain_limit_id}": |
96 |
get: |
97 |
x-mojo-to: Config::SMTP::DomainLimits#get |
98 |
operationId: getDomainLimit |
99 |
tags: |
100 |
- domain_limits |
101 |
summary: Get domain limit |
102 |
parameters: |
103 |
- $ref: ../swagger.yaml#/parameters/domain_limit_id_pp |
104 |
produces: |
105 |
- application/json |
106 |
responses: |
107 |
"200": |
108 |
description: A domain limit |
109 |
schema: |
110 |
$ref: ../swagger.yaml#/definitions/smtp_domain_limits |
111 |
"404": |
112 |
description: Object not found |
113 |
schema: |
114 |
$ref: ../swagger.yaml#/definitions/error |
115 |
"500": |
116 |
description: | |
117 |
Internal server error. Possible `error_code` attribute values: |
118 |
* `internal_server_error` |
119 |
schema: |
120 |
$ref: ../swagger.yaml#/definitions/error |
121 |
"503": |
122 |
description: Under maintenance |
123 |
schema: |
124 |
$ref: ../swagger.yaml#/definitions/error |
125 |
x-koha-authorization: |
126 |
permissions: |
127 |
parameters: manage_smtp_servers |
128 |
put: |
129 |
x-mojo-to: Config::SMTP::DomainLimits#update |
130 |
operationId: updateDomainLimit |
131 |
tags: |
132 |
- domain_limits |
133 |
summary: Update a domain limit |
134 |
parameters: |
135 |
- $ref: ../swagger.yaml#/parameters/domain_limit_id_pp |
136 |
- name: body |
137 |
in: body |
138 |
description: A JSON object representing a new domain limit |
139 |
required: true |
140 |
schema: |
141 |
$ref: "../swagger.yaml#/definitions/smtp_domain_limits" |
142 |
produces: |
143 |
- application/json |
144 |
responses: |
145 |
"200": |
146 |
description: Updated domain limit |
147 |
schema: |
148 |
$ref: ../swagger.yaml#/definitions/smtp_domain_limits |
149 |
"400": |
150 |
description: Bad Request |
151 |
schema: |
152 |
$ref: ../swagger.yaml#/definitions/error |
153 |
"403": |
154 |
description: Access forbidden |
155 |
schema: |
156 |
$ref: ../swagger.yaml#/definitions/error |
157 |
"404": |
158 |
description: Object not found |
159 |
schema: |
160 |
$ref: ../swagger.yaml#/definitions/error |
161 |
"409": |
162 |
description: Conflict in creating resource |
163 |
schema: |
164 |
$ref: "../swagger.yaml#/definitions/error" |
165 |
"500": |
166 |
description: | |
167 |
Internal server error. Possible `error_code` attribute values: |
168 |
* `internal_server_error` |
169 |
schema: |
170 |
$ref: ../swagger.yaml#/definitions/error |
171 |
"503": |
172 |
description: Under maintenance |
173 |
schema: |
174 |
$ref: ../swagger.yaml#/definitions/error |
175 |
x-koha-authorization: |
176 |
permissions: |
177 |
parameters: manage_smtp_servers |
178 |
delete: |
179 |
x-mojo-to: Config::SMTP::DomainLimits#delete |
180 |
operationId: delDomainLimit |
181 |
tags: |
182 |
- domain_limits |
183 |
summary: Delete domain limit |
184 |
parameters: |
185 |
- $ref: ../swagger.yaml#/parameters/domain_limit_id_pp |
186 |
produces: |
187 |
- application/json |
188 |
responses: |
189 |
"204": |
190 |
description: Domain limit deleted |
191 |
"401": |
192 |
description: Authentication required |
193 |
schema: |
194 |
$ref: ../swagger.yaml#/definitions/error |
195 |
"403": |
196 |
description: Access forbidden |
197 |
schema: |
198 |
$ref: ../swagger.yaml#/definitions/error |
199 |
"404": |
200 |
description: Not found |
201 |
schema: |
202 |
$ref: ../swagger.yaml#/definitions/error |
203 |
"500": |
204 |
description: | |
205 |
Internal server error. Possible `error_code` attribute values: |
206 |
* `internal_server_error` |
207 |
"503": |
208 |
description: Under maintenance |
209 |
schema: |
210 |
$ref: ../swagger.yaml#/definitions/error |
211 |
x-koha-authorization: |
212 |
permissions: |
213 |
parameters: manage_smtp_servers |