api/v1/swagger/parameters.yaml

   1 ---
   2 advancededitormacro_id_pp:
   3   $ref: parameters/advancededitormacro.yaml#/advancededitormacro_id_pp
   4 biblio_id_pp:
   5   $ref: parameters/biblio.yaml#/biblio_id_pp
   6 cash_register_id_pp:
   7   $ref: parameters/cash_register.yaml#/cash_register_id_pp
   8 cashup_id_pp:
   9   $ref: parameters/cashup.yaml#/cashup_id_pp
  10 checkout_id_pp:
  11   $ref: parameters/checkout.yaml#/checkout_id_pp
  12 city_id_pp:
  13   $ref: parameters/city.yaml#/city_id_pp
  14 club_id_pp:
  15   $ref: parameters/club.yaml#/club_id_pp
  16 fund_id_pp:
  17   $ref: parameters/fund.yaml#/fund_id_pp
  18 hold_id_pp:
  19   $ref: parameters/hold.yaml#/hold_id_pp
  20 import_batch_profile_id_pp:
  21   $ref: parameters/import_batch_profile.yaml#/import_batch_profile_id_pp
  22 item_id_pp:
  23   $ref: parameters/item.yaml#/item_id_pp
  24 library_id_pp:
  25   $ref: parameters/library.yaml#/library_id_pp
  26 match:
  27   name: _match
  28   in: query
  29   required: false
  30   description: Matching criteria
  31   type: string
  32   enum:
  33     - contains
  34     - exact
  35     - starts_with
  36     - ends_with
  37 order_by:
  38   name: _order_by
  39   in: query
  40   required: false
  41   description: Sorting criteria
  42   type: array
  43   collectionFormat: csv
  44   items:
  45     type: string
  46 order_id_pp:
  47   $ref: parameters/order.yaml#/order_id_pp
  48 page:
  49   name: _page
  50   in: query
  51   required: false
  52   description: Page number, for paginated object listing
  53   type: integer
  54 patron_id_pp:
  55   $ref: parameters/patron.yaml#/patron_id_pp
  56 patron_id_qp:
  57   $ref: parameters/patron.yaml#/patron_id_qp
  58 per_page:
  59   name: _per_page
  60   in: query
  61   required: false
  62   description: Page size, for paginated object listing
  63   type: integer
  64 q_body:
  65   name: query
  66   in: body
  67   required: false
  68   description: Query filter sent through request's body
  69   schema:
  70     type:
  71       - object
  72       - array
  73 q_param:
  74   name: q
  75   in: query
  76   required: false
  77   description: Query filter sent as a request parameter
  78   type: array
  79   items:
  80     type: string
  81   collectionFormat: multi
  82 q_header:
  83   name: x-koha-query
  84   in: header
  85   required: false
  86   description: Query filter sent as a request header
  87   type: string
  88 quote_id_pp:
  89   $ref: parameters/quote.yaml#/quote_id_pp
  90 seen_pp:
  91   $ref: parameters/checkout.yaml#/seen_pp
  92 smtp_server_id_pp:
  93   $ref: parameters/smtp_server.yaml#/smtp_server_id_pp
  94 suggestion_id_pp:
  95   $ref: parameters/suggestion.yaml#/suggestion_id_pp
  96 transfer_limit_id_pp:
  97   $ref: parameters/transfer_limit.yaml#/transfer_limit_id_pp
  98 vendor_id_pp:
  99   $ref: parameters/vendor.yaml#/vendor_id_pp