api/v1/swagger/paths/config_smtp_servers.yaml

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