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": "advanced_editor",
 182           "editcatalogue": "create_shared_macros"
 183         }
 184       }
 185     }
 186   },
 187   "/advanced_editor/macros/{advancededitormacro_id}": {
 188     "get": {
 189       "x-mojo-to": "AdvancedEditorMacro#get",
 190       "operationId": "getAdvancedEditorMacro",
 191       "tags": ["advancededitormacros"],
 192       "parameters": [{
 193         "$ref": "../parameters.json#/advancededitormacro_id_pp"
 194       }],
 195       "produces": [
 196         "application/json"
 197       ],
 198       "responses": {
 199         "200": {
 200           "description": "A macro",
 201           "schema": {
 202             "$ref": "../definitions.json#/advancededitormacro"
 203           }
 204         },
 205         "403": {
 206           "description": "Access forbidden",
 207           "schema": {
 208             "$ref": "../definitions.json#/error"
 209           }
 210         },
 211         "404": {
 212           "description": "AdvancedEditorMacro not found",
 213           "schema": {
 214             "$ref": "../definitions.json#/error"
 215           }
 216         },
 217         "500": {
 218           "description": "Internal error",
 219           "schema": {
 220             "$ref": "../definitions.json#/error"
 221           }
 222         },
 223         "503": {
 224           "description": "Under maintenance",
 225           "schema": {
 226             "$ref": "../definitions.json#/error"
 227           }
 228         }
 229       },
 230       "x-koha-authorization": {
 231         "permissions": {
 232             "editcatalogue": "advanced_editor"
 233         }
 234       }
 235     },
 236     "put": {
 237       "x-mojo-to": "AdvancedEditorMacro#update",
 238       "operationId": "updateAdvancedEditorMacro",
 239       "tags": ["advancededitormacros"],
 240       "parameters": [{
 241         "$ref": "../parameters.json#/advancededitormacro_id_pp"
 242       }, {
 243         "name": "body",
 244         "in": "body",
 245         "description": "An advanced editor macro object",
 246         "required": true,
 247         "schema": {
 248           "$ref": "../definitions.json#/advancededitormacro"
 249         }
 250       }],
 251       "produces": [
 252         "application/json"
 253       ],
 254       "responses": {
 255         "200": {
 256           "description": "An advanced editor macro",
 257           "schema": {
 258             "$ref": "../definitions.json#/advancededitormacro"
 259           }
 260         },
 261         "401": {
 262           "description": "Authentication required",
 263           "schema": {
 264             "$ref": "../definitions.json#/error"
 265           }
 266         },
 267         "403": {
 268           "description": "Access forbidden",
 269           "schema": {
 270             "$ref": "../definitions.json#/error"
 271           }
 272         },
 273         "404": {
 274           "description": "Macro not found",
 275           "schema": {
 276             "$ref": "../definitions.json#/error"
 277           }
 278         },
 279         "500": {
 280           "description": "Internal error",
 281           "schema": {
 282             "$ref": "../definitions.json#/error"
 283           }
 284         },
 285         "503": {
 286           "description": "Under maintenance",
 287           "schema": {
 288             "$ref": "../definitions.json#/error"
 289           }
 290         }
 291       },
 292       "x-koha-authorization": {
 293         "permissions": {
 294           "editcatalogue": "advanced_editor"
 295         }
 296       }
 297     },
 298     "delete": {
 299       "x-mojo-to": "AdvancedEditorMacro#delete",
 300       "operationId": "deleteAdvancedEditorMacro",
 301       "tags": ["advancededitormacros"],
 302       "parameters": [{
 303         "$ref": "../parameters.json#/advancededitormacro_id_pp"
 304       }],
 305       "produces": [
 306         "application/json"
 307       ],
 308       "responses": {
 309         "200": {
 310           "description": "Advanced editor macro deleted",
 311           "schema": {
 312             "type": "string"
 313           }
 314         },
 315         "401": {
 316           "description": "Authentication required",
 317           "schema": {
 318             "$ref": "../definitions.json#/error"
 319           }
 320         },
 321         "403": {
 322           "description": "Access forbidden",
 323           "schema": {
 324             "$ref": "../definitions.json#/error"
 325           }
 326         },
 327         "404": {
 328           "description": "Macro not found",
 329           "schema": {
 330             "$ref": "../definitions.json#/error"
 331           }
 332         },
 333         "500": {
 334           "description": "Internal error",
 335           "schema": {
 336             "$ref": "../definitions.json#/error"
 337           }
 338         },
 339         "503": {
 340           "description": "Under maintenance",
 341           "schema": {
 342             "$ref": "../definitions.json#/error"
 343           }
 344         }
 345       },
 346       "x-koha-authorization": {
 347         "permissions": {
 348           "editcatalogue": "advanced_editor"
 349         }
 350       }
 351     }
 352   },
 353   "/advanced_editor/macros/shared/{advancededitormacro_id}": {
 354     "get": {
 355       "x-mojo-to": "AdvancedEditorMacro#get_shared",
 356       "operationId": "getsharedAdvancedEditorMacro",
 357       "tags": ["advancededitormacros"],
 358       "parameters": [{
 359         "$ref": "../parameters.json#/advancededitormacro_id_pp"
 360       }],
 361       "produces": [
 362         "application/json"
 363       ],
 364       "responses": {
 365         "200": {
 366           "description": "A macro",
 367           "schema": {
 368             "$ref": "../definitions.json#/advancededitormacro"
 369           }
 370         },
 371         "403": {
 372           "description": "Access forbidden",
 373           "schema": {
 374             "$ref": "../definitions.json#/error"
 375           }
 376         },
 377         "404": {
 378           "description": "AdvancedEditorMacro not found",
 379           "schema": {
 380             "$ref": "../definitions.json#/error"
 381           }
 382         },
 383         "500": {
 384           "description": "Internal error",
 385           "schema": {
 386             "$ref": "../definitions.json#/error"
 387           }
 388         },
 389         "503": {
 390           "description": "Under maintenance",
 391           "schema": {
 392             "$ref": "../definitions.json#/error"
 393           }
 394         }
 395       },
 396       "x-koha-authorization": {
 397         "permissions": {
 398             "editcatalogue": "advanced_editor"
 399         }
 400       }
 401     },
 402     "put": {
 403       "x-mojo-to": "AdvancedEditorMacro#update_shared",
 404       "operationId": "updatesharedAdvancedEditorMacro",
 405       "tags": ["advancededitormacros"],
 406       "parameters": [{
 407         "$ref": "../parameters.json#/advancededitormacro_id_pp"
 408       }, {
 409         "name": "body",
 410         "in": "body",
 411         "description": "An advanced editor macro object",
 412         "required": true,
 413         "schema": {
 414           "$ref": "../definitions.json#/advancededitormacro"
 415         }
 416       }],
 417       "produces": [
 418         "application/json"
 419       ],
 420       "responses": {
 421         "200": {
 422           "description": "An advanced editor macro",
 423           "schema": {
 424             "$ref": "../definitions.json#/advancededitormacro"
 425           }
 426         },
 427         "401": {
 428           "description": "Authentication required",
 429           "schema": {
 430             "$ref": "../definitions.json#/error"
 431           }
 432         },
 433         "403": {
 434           "description": "Access forbidden",
 435           "schema": {
 436             "$ref": "../definitions.json#/error"
 437           }
 438         },
 439         "404": {
 440           "description": "Macro not found",
 441           "schema": {
 442             "$ref": "../definitions.json#/error"
 443           }
 444         },
 445         "500": {
 446           "description": "Internal error",
 447           "schema": {
 448             "$ref": "../definitions.json#/error"
 449           }
 450         },
 451         "503": {
 452           "description": "Under maintenance",
 453           "schema": {
 454             "$ref": "../definitions.json#/error"
 455           }
 456         }
 457       },
 458       "x-koha-authorization": {
 459         "permissions": {
 460           "editcatalogue": "advanced_editor",
 461           "editcatalogue": "create_shared_macros"
 462         }
 463       }
 464     },
 465     "delete": {
 466       "x-mojo-to": "AdvancedEditorMacro#delete_shared",
 467       "operationId": "deletesharedAdvancedEditorMacro",
 468       "tags": ["advancededitormacros"],
 469       "parameters": [{
 470         "$ref": "../parameters.json#/advancededitormacro_id_pp"
 471       }],
 472       "produces": [
 473         "application/json"
 474       ],
 475       "responses": {
 476         "200": {
 477           "description": "Advanced editor macro deleted",
 478           "schema": {
 479             "type": "string"
 480           }
 481         },
 482         "401": {
 483           "description": "Authentication required",
 484           "schema": {
 485             "$ref": "../definitions.json#/error"
 486           }
 487         },
 488         "403": {
 489           "description": "Access forbidden",
 490           "schema": {
 491             "$ref": "../definitions.json#/error"
 492           }
 493         },
 494         "404": {
 495           "description": "Macro not found",
 496           "schema": {
 497             "$ref": "../definitions.json#/error"
 498           }
 499         },
 500         "500": {
 501           "description": "Internal error",
 502           "schema": {
 503             "$ref": "../definitions.json#/error"
 504           }
 505         },
 506         "503": {
 507           "description": "Under maintenance",
 508           "schema": {
 509             "$ref": "../definitions.json#/error"
 510           }
 511         }
 512       },
 513       "x-koha-authorization": {
 514         "permissions": {
 515           "editcatalogue": "advanced_editor",
 516           "editcatalogue": "delete_shared_macros"
 517         }
 518       }
 519     }
 520   }
 521 }