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