koha-dev.rot13.org Git - srvgit/blob - api/v1/swagger/paths/erm_eholdings_resources.yaml

   1 ---
   2 /erm/eholdings/{provider}/resources:
   3   get:
   4     x-mojo-to: ERM::EHoldings::Resources#list
   5     operationId: listErmEHoldingsResources
   6     tags:
   7       - eholdings
   8     summary: List eholdings resources
   9     produces:
  10       - application/json
  11     parameters:
  12       - description: Provider name
  13         in: path
  14         name: provider
  15         required: true
  16         type: string
  17       - description: Case insensitive search on resource_id
  18         in: query
  19         name: resource_id
  20         required: false
  21         type: string
  22       - description: Case insensitive search on package_id
  23         in: query
  24         name: package_id
  25         required: false
  26         type: string
  27       - description: Case insensitive search on title vendor_id
  28         in: query
  29         name: vendor_id
  30         required: false
  31         type: integer
  32       - description: Case insensitive search on started_on
  33         in: query
  34         name: started_on
  35         required: false
  36         type: string
  37       - description: Case insensitive search on ended_on
  38         in: query
  39         name: ended_on
  40         required: false
  41         type: string
  42       - description: Case insensitive search on proxy
  43         in: query
  44         name: proxy
  45         required: false
  46         type: string
  47       - $ref: "../swagger.yaml#/parameters/match"
  48       - $ref: "../swagger.yaml#/parameters/order_by"
  49       - $ref: "../swagger.yaml#/parameters/page"
  50       - $ref: "../swagger.yaml#/parameters/per_page"
  51       - $ref: "../swagger.yaml#/parameters/q_param"
  52       - $ref: "../swagger.yaml#/parameters/q_body"
  53       - $ref: "../swagger.yaml#/parameters/q_header"
  54     responses:
  55       200:
  56         description: A list of eHoldings resources
  57         schema:
  58           items:
  59             $ref: "../swagger.yaml#/definitions/erm_eholdings_resource"
  60           type: array
  61       400:
  62         description: Bad request
  63         schema:
  64           $ref: "../swagger.yaml#/definitions/error"
  65       403:
  66         description: Access forbidden
  67         schema:
  68           $ref: "../swagger.yaml#/definitions/error"
  69       500:
  70         description: |-
  71           Internal server error. Possible `error_code` attribute values:
  72           * `internal_server_error`
  73         schema:
  74           $ref: "../swagger.yaml#/definitions/error"
  75       503:
  76         description: Under maintenance
  77         schema:
  78           $ref: "../swagger.yaml#/definitions/error"
  79     x-koha-authorization:
  80       permissions:
  81         erm: 1
  82 "/erm/eholdings/{provider}/resources/{resource_id}":
  83   get:
  84     x-mojo-to: ERM::EHoldings::Resources#get
  85     operationId: getErmEHoldingsResources
  86     tags:
  87       - eholdings
  88     summary: Get resources
  89     produces:
  90       - application/json
  91     parameters:
  92       - description: Provider name
  93         in: path
  94         name: provider
  95         required: true
  96         type: string
  97       - $ref: "../swagger.yaml#/parameters/eholdings_resource_id_pp"
  98       - name: x-koha-embed
  99         in: header
 100         required: false
 101         description: Embed list sent as a request header
 102         type: array
 103         items:
 104           type: string
 105           enum:
 106             - title
 107             - package
 108             - vendor
 109         collectionFormat: csv
 110     responses:
 111       200:
 112         description: An eHolding resource
 113         schema:
 114           items:
 115             $ref: "../swagger.yaml#/definitions/erm_eholdings_resource"
 116       401:
 117         description: Authentication required
 118         schema:
 119           $ref: "../swagger.yaml#/definitions/error"
 120       403:
 121         description: Access forbidden
 122         schema:
 123           $ref: "../swagger.yaml#/definitions/error"
 124       404:
 125         description: Ressource not found
 126         schema:
 127           $ref: "../swagger.yaml#/definitions/error"
 128       500:
 129         description: |-
 130           Internal server error. Possible `error_code` attribute values:
 131           * `internal_server_error`
 132         schema:
 133           $ref: "../swagger.yaml#/definitions/error"
 134       503:
 135         description: Under maintenance
 136         schema:
 137           $ref: "../swagger.yaml#/definitions/error"
 138     x-koha-authorization:
 139       permissions:
 140         erm: 1
 141   patch:
 142     x-mojo-to: ERM::EHoldings::Resources#edit
 143     operationId: editErmEHoldingsResources
 144     tags:
 145       - eholdings
 146     summary: Edit a resource
 147     produces:
 148       - application/json
 149     parameters:
 150       - description: Provider name
 151         in: path
 152         name: provider
 153         required: true
 154         type: string
 155       - description: A JSON object containing the fields to edit
 156         in: body
 157         name: body
 158         required: true
 159         schema:
 160           type: object
 161           properties:
 162             is_selected:
 163               description: Add or remove this resource from remote holdings
 164               type: boolean
 165           additionalProperties: false
 166       - $ref: "../swagger.yaml#/parameters/eholdings_resource_id_pp"
 167     responses:
 168       200:
 169         description: What has been modified
 170         schema:
 171           type: object
 172           properties:
 173             is_selected:
 174               description: Add or remove this resource from remote holdings
 175               type: boolean
 176           additionalProperties: false
 177       401:
 178         description: Authentication required
 179         schema:
 180           $ref: "../swagger.yaml#/definitions/error"
 181       403:
 182         description: Access forbidden
 183         schema:
 184           $ref: "../swagger.yaml#/definitions/error"
 185       404:
 186         description: Ressource not found
 187         schema:
 188           $ref: "../swagger.yaml#/definitions/error"
 189       500:
 190         description: |-
 191           Internal server error. Possible `error_code` attribute values:
 192           * `internal_server_error`
 193         schema:
 194           $ref: "../swagger.yaml#/definitions/error"
 195       503:
 196         description: Under maintenance
 197         schema:
 198           $ref: "../swagger.yaml#/definitions/error"
 199     x-koha-authorization:
 200       permissions:
 201         erm: 1