api/v1/swagger/parameters.json

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