api/v1/swagger/paths/advancededitormacros.json

   1 {
   2   "/advanced_editor/macros": {
   3     "get": {
   4       "x-mojo-to": "AdvancedEditorMacro#list",
   5       "operationId": "listMacro",
   6       "tags": ["advancededitormacro"],
   7       "produces": [
   8         "application/json"
   9       ],
  10       "parameters": [
  11         {
  12           "name": "name",
  13           "in": "query",
  14           "description": "Case insensative search on macro name",
  15           "required": false,
  16           "type": "string"
  17         },
  18         {
  19           "name": "macro_text",
  20           "in": "query",
  21           "description": "Case insensative search on macro text",
  22           "required": false,
  23           "type": "string"
  24         },
  25         {
  26           "name": "patron_id",
  27           "in": "query",
  28           "description": "Search on internal patron_id",
  29           "required": false,
  30           "type": "string"
  31         },
  32         {
  33           "name": "shared",
  34           "in": "query",
  35           "description": "Search on shared macros",
  36           "required": false,
  37           "type": "string"
  38         }
  39       ],
  40       "responses": {
  41         "200": {
  42           "description": "A list of macros",
  43           "schema": {
  44             "type": "array",
  45             "items": {
  46               "$ref": "../definitions.json#/advancededitormacro"
  47             }
  48           }
  49         },
  50         "403": {
  51           "description": "Access forbidden",
  52           "schema": {
  53             "$ref": "../definitions.json#/error"
  54           }
  55         },
  56         "500": {
  57           "description": "Internal error",
  58           "schema": {
  59             "$ref": "../definitions.json#/error"
  60           }
  61         },
  62         "503": {
  63           "description": "Under maintenance",
  64           "schema": {
  65             "$ref": "../definitions.json#/error"
  66           }
  67         }
  68       },
  69       "x-koha-authorization": {
  70         "permissions": {
  71             "editcatalogue": "advanced_editor"
  72         }
  73       }
  74     },
  75     "post": {
  76       "x-mojo-to": "AdvancedEditorMacro#add",
  77       "operationId": "addAdvancedEditorMacro",
  78       "tags": ["advancededitormacro"],
  79       "parameters": [{
  80         "name": "body",
  81         "in": "body",
  82         "description": "A JSON object containing informations about the new macro",
  83         "required": true,
  84         "schema": {
  85           "$ref": "../definitions.json#/advancededitormacro"
  86         }
  87       }],
  88       "produces": [
  89         "application/json"
  90       ],
  91       "responses": {
  92         "201": {
  93           "description": "Macro added",
  94           "schema": {
  95             "$ref": "../definitions.json#/advancededitormacro"
  96           }
  97         },
  98         "401": {
  99           "description": "Authentication required",
 100           "schema": {
 101             "$ref": "../definitions.json#/error"
 102           }
 103         },
 104         "403": {
 105           "description": "Access forbidden",
 106           "schema": {
 107             "$ref": "../definitions.json#/error"
 108           }
 109         },
 110         "500": {
 111           "description": "Internal error",
 112           "schema": {
 113             "$ref": "../definitions.json#/error"
 114           }
 115         },
 116         "503": {
 117           "description": "Under maintenance",
 118           "schema": {
 119             "$ref": "../definitions.json#/error"
 120           }
 121         }
 122       },
 123       "x-koha-authorization": {
 124         "permissions": {
 125           "editcatalogue": "advanced_editor"
 126         }
 127       }
 128     }
 129   },
 130   "/advanced_editor/macros/shared": {
 131     "post": {
 132       "x-mojo-to": "AdvancedEditorMacro#add_shared",
 133       "operationId": "addsharedAdvancedEditorMacro",
 134       "tags": ["advancededitormacro"],
 135       "parameters": [{
 136         "name": "body",
 137         "in": "body",
 138         "description": "A JSON object containing informations about the new macro",
 139         "required": true,
 140         "schema": {
 141           "$ref": "../definitions.json#/advancededitormacro"
 142         }
 143       }],
 144       "produces": [
 145         "application/json"
 146       ],
 147       "responses": {
 148         "201": {
 149           "description": "Macro added",
 150           "schema": {
 151             "$ref": "../definitions.json#/advancededitormacro"
 152           }
 153         },
 154         "401": {
 155           "description": "Authentication required",
 156           "schema": {
 157             "$ref": "../definitions.json#/error"
 158           }
 159         },
 160         "403": {
 161           "description": "Access forbidden",
 162           "schema": {
 163             "$ref": "../definitions.json#/error"
 164           }
 165         },
 166         "500": {
 167           "description": "Internal error",
 168           "schema": {
 169             "$ref": "../definitions.json#/error"
 170           }
 171         },
 172         "503": {
 173           "description": "Under maintenance",
 174           "schema": {
 175             "$ref": "../definitions.json#/error"
 176           }
 177         }
 178       },
 179       "x-koha-authorization": {
 180         "permissions": {
 181           "editcatalogue": {
 182             "advanced_editor": 1,
 183             "create_shared_macros": 1
 184           }
 185         }
 186       }
 187     }
 188   },
 189   "/advanced_editor/macros/{advancededitormacro_id}": {
 190     "get": {
 191       "x-mojo-to": "AdvancedEditorMacro#get",
 192       "operationId": "getAdvancedEditorMacro",
 193       "tags": ["advancededitormacros"],
 194       "parameters": [{
 195         "$ref": "../parameters.json#/advancededitormacro_id_pp"
 196       }],
 197       "produces": [
 198         "application/json"
 199       ],
 200       "responses": {
 201         "200": {
 202           "description": "A macro",
 203           "schema": {
 204             "$ref": "../definitions.json#/advancededitormacro"
 205           }
 206         },
 207         "403": {
 208           "description": "Access forbidden",
 209           "schema": {
 210             "$ref": "../definitions.json#/error"
 211           }
 212         },
 213         "404": {
 214           "description": "AdvancedEditorMacro not found",
 215           "schema": {
 216             "$ref": "../definitions.json#/error"
 217           }
 218         },
 219         "500": {
 220           "description": "Internal error",
 221           "schema": {
 222             "$ref": "../definitions.json#/error"
 223           }
 224         },
 225         "503": {
 226           "description": "Under maintenance",
 227           "schema": {
 228             "$ref": "../definitions.json#/error"
 229           }
 230         }
 231       },
 232       "x-koha-authorization": {
 233         "permissions": {
 234             "editcatalogue": "advanced_editor"
 235         }
 236       }
 237     },
 238     "put": {
 239       "x-mojo-to": "AdvancedEditorMacro#update",
 240       "operationId": "updateAdvancedEditorMacro",
 241       "tags": ["advancededitormacros"],
 242       "parameters": [{
 243         "$ref": "../parameters.json#/advancededitormacro_id_pp"
 244       }, {
 245         "name": "body",
 246         "in": "body",
 247         "description": "An advanced editor macro object",
 248         "required": true,
 249         "schema": {
 250           "$ref": "../definitions.json#/advancededitormacro"
 251         }
 252       }],
 253       "produces": [
 254         "application/json"
 255       ],
 256       "responses": {
 257         "200": {
 258           "description": "An advanced editor macro",
 259           "schema": {
 260             "$ref": "../definitions.json#/advancededitormacro"
 261           }
 262         },
 263         "401": {
 264           "description": "Authentication required",
 265           "schema": {
 266             "$ref": "../definitions.json#/error"
 267           }
 268         },
 269         "403": {
 270           "description": "Access forbidden",
 271           "schema": {
 272             "$ref": "../definitions.json#/error"
 273           }
 274         },
 275         "404": {
 276           "description": "Macro not found",
 277           "schema": {
 278             "$ref": "../definitions.json#/error"
 279           }
 280         },
 281         "500": {
 282           "description": "Internal error",
 283           "schema": {
 284             "$ref": "../definitions.json#/error"
 285           }
 286         },
 287         "503": {
 288           "description": "Under maintenance",
 289           "schema": {
 290             "$ref": "../definitions.json#/error"
 291           }
 292         }
 293       },
 294       "x-koha-authorization": {
 295         "permissions": {
 296           "editcatalogue": "advanced_editor"
 297         }
 298       }
 299     },
 300     "delete": {
 301       "x-mojo-to": "AdvancedEditorMacro#delete",
 302       "operationId": "deleteAdvancedEditorMacro",
 303       "tags": ["advancededitormacros"],
 304       "parameters": [{
 305         "$ref": "../parameters.json#/advancededitormacro_id_pp"
 306       }],
 307       "produces": [
 308         "application/json"
 309       ],
 310       "responses": {
 311         "204": {
 312           "description": "Advanced editor macro deleted",
 313           "schema": {
 314             "type": "string"
 315           }
 316         },
 317         "401": {
 318           "description": "Authentication required",
 319           "schema": {
 320             "$ref": "../definitions.json#/error"
 321           }
 322         },
 323         "403": {
 324           "description": "Access forbidden",
 325           "schema": {
 326             "$ref": "../definitions.json#/error"
 327           }
 328         },
 329         "404": {
 330           "description": "Macro not found",
 331           "schema": {
 332             "$ref": "../definitions.json#/error"
 333           }
 334         },
 335         "500": {
 336           "description": "Internal error",
 337           "schema": {
 338             "$ref": "../definitions.json#/error"
 339           }
 340         },
 341         "503": {
 342           "description": "Under maintenance",
 343           "schema": {
 344             "$ref": "../definitions.json#/error"
 345           }
 346         }
 347       },
 348       "x-koha-authorization": {
 349         "permissions": {
 350           "editcatalogue": "advanced_editor"
 351         }
 352       }
 353     }
 354   },
 355   "/advanced_editor/macros/shared/{advancededitormacro_id}": {
 356     "get": {
 357       "x-mojo-to": "AdvancedEditorMacro#get_shared",
 358       "operationId": "getsharedAdvancedEditorMacro",
 359       "tags": ["advancededitormacros"],
 360       "parameters": [{
 361         "$ref": "../parameters.json#/advancededitormacro_id_pp"
 362       }],
 363       "produces": [
 364         "application/json"
 365       ],
 366       "responses": {
 367         "200": {
 368           "description": "A macro",
 369           "schema": {
 370             "$ref": "../definitions.json#/advancededitormacro"
 371           }
 372         },
 373         "403": {
 374           "description": "Access forbidden",
 375           "schema": {
 376             "$ref": "../definitions.json#/error"
 377           }
 378         },
 379         "404": {
 380           "description": "AdvancedEditorMacro not found",
 381           "schema": {
 382             "$ref": "../definitions.json#/error"
 383           }
 384         },
 385         "500": {
 386           "description": "Internal error",
 387           "schema": {
 388             "$ref": "../definitions.json#/error"
 389           }
 390         },
 391         "503": {
 392           "description": "Under maintenance",
 393           "schema": {
 394             "$ref": "../definitions.json#/error"
 395           }
 396         }
 397       },
 398       "x-koha-authorization": {
 399         "permissions": {
 400             "editcatalogue": "advanced_editor"
 401         }
 402       }
 403     },
 404     "put": {
 405       "x-mojo-to": "AdvancedEditorMacro#update_shared",
 406       "operationId": "updatesharedAdvancedEditorMacro",
 407       "tags": ["advancededitormacros"],
 408       "parameters": [{
 409         "$ref": "../parameters.json#/advancededitormacro_id_pp"
 410       }, {
 411         "name": "body",
 412         "in": "body",
 413         "description": "An advanced editor macro object",
 414         "required": true,
 415         "schema": {
 416           "$ref": "../definitions.json#/advancededitormacro"
 417         }
 418       }],
 419       "produces": [
 420         "application/json"
 421       ],
 422       "responses": {
 423         "200": {
 424           "description": "An advanced editor macro",
 425           "schema": {
 426             "$ref": "../definitions.json#/advancededitormacro"
 427           }
 428         },
 429         "401": {
 430           "description": "Authentication required",
 431           "schema": {
 432             "$ref": "../definitions.json#/error"
 433           }
 434         },
 435         "403": {
 436           "description": "Access forbidden",
 437           "schema": {
 438             "$ref": "../definitions.json#/error"
 439           }
 440         },
 441         "404": {
 442           "description": "Macro not found",
 443           "schema": {
 444             "$ref": "../definitions.json#/error"
 445           }
 446         },
 447         "500": {
 448           "description": "Internal error",
 449           "schema": {
 450             "$ref": "../definitions.json#/error"
 451           }
 452         },
 453         "503": {
 454           "description": "Under maintenance",
 455           "schema": {
 456             "$ref": "../definitions.json#/error"
 457           }
 458         }
 459       },
 460       "x-koha-authorization": {
 461         "permissions": {
 462           "editcatalogue": {
 463             "advanced_editor": 1,
 464             "create_shared_macros": 1
 465           }
 466         }
 467       }
 468     },
 469     "delete": {
 470       "x-mojo-to": "AdvancedEditorMacro#delete_shared",
 471       "operationId": "deletesharedAdvancedEditorMacro",
 472       "tags": ["advancededitormacros"],
 473       "parameters": [{
 474         "$ref": "../parameters.json#/advancededitormacro_id_pp"
 475       }],
 476       "produces": [
 477         "application/json"
 478       ],
 479       "responses": {
 480         "204": {
 481           "description": "Advanced editor macro deleted",
 482           "schema": {
 483             "type": "string"
 484           }
 485         },
 486         "401": {
 487           "description": "Authentication required",
 488           "schema": {
 489             "$ref": "../definitions.json#/error"
 490           }
 491         },
 492         "403": {
 493           "description": "Access forbidden",
 494           "schema": {
 495             "$ref": "../definitions.json#/error"
 496           }
 497         },
 498         "404": {
 499           "description": "Macro not found",
 500           "schema": {
 501             "$ref": "../definitions.json#/error"
 502           }
 503         },
 504         "500": {
 505           "description": "Internal error",
 506           "schema": {
 507             "$ref": "../definitions.json#/error"
 508           }
 509         },
 510         "503": {
 511           "description": "Under maintenance",
 512           "schema": {
 513             "$ref": "../definitions.json#/error"
 514           }
 515         }
 516       },
 517       "x-koha-authorization": {
 518         "permissions": {
 519           "editcatalogue": {
 520             "advanced_editor": 1,
 521             "delete_shared_macros": 1
 522           }
 523         }
 524       }
 525     }
 526   }
 527 }