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