api/v1/swagger/parameters.json

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