Bug 19784: Remove reference to 'borrowernumber' param from other endpoints
[koha.git] / api / v1 / swagger / definitions / hold.json
index 8703920..626910b 100644 (file)
@@ -5,55 +5,70 @@
       "$ref": "../x-primitives.json#/reserve_id"
     },
     "borrowernumber": {
-      "$ref": "../x-primitives.json#/borrowernumber"
+      "type": "integer",
+      "description": "Internal patron identifier"
     },
     "reservedate": {
+      "type": ["string", "null"],
       "description": "the date the hold was placed"
     },
     "biblionumber": {
       "$ref": "../x-primitives.json#/biblionumber"
     },
     "branchcode": {
-      "$ref": "../x-primitives.json#/branchcode"
+      "type": ["string", "null"],
+      "description": "code of patron's home branch"
     },
     "notificationdate": {
+      "type": ["string", "null"],
       "description": "currently unused"
     },
     "reminderdate": {
+      "type": ["string", "null"],
       "description": "currently unused"
     },
     "cancellationdate": {
+      "type": ["string", "null"],
       "description": "the date the hold was cancelled"
     },
     "reservenotes": {
+      "type": ["string", "null"],
       "description": "notes related to this hold"
     },
     "priority": {
+      "type": ["integer", "null"],
       "description": "where in the queue the patron sits"
     },
     "found": {
+      "type": ["string", "null"],
       "description": "a one letter code defining what the status of the hold is after it has been confirmed"
     },
     "timestamp": {
+      "type": ["string", "null"],
       "description": "date and time the hold was last updated"
     },
     "itemnumber": {
       "$ref": "../x-primitives.json#/itemnumber"
     },
     "waitingdate": {
+      "type": ["string", "null"],
       "description": "the date the item was marked as waiting for the patron at the library"
     },
     "expirationdate": {
+      "type": ["string", "null"],
       "description": "the date the hold expires"
     },
     "lowestPriority": {
-      "description": ""
+      "type": "boolean",
+      "description": "Controls if the hold is given the lowest priority on the queue"
     },
     "suspend": {
-      "description": ""
+      "type": "boolean",
+      "description": "Controls if the hold is suspended"
     },
     "suspend_until": {
-      "description": ""
+      "type": ["string", "null"],
+      "description": "Date until which the hold has been suspended"
     },
     "itemtype": {
       "type": ["string", "null"],