Bug 9834: (QA follow-up) API Corrections

[koha-equinox.git] / api / v1 / swagger / definitions / hold.json

diff --git a/api/v1/swagger/definitions/hold.json b/api/v1/swagger/definitions/hold.json
index 8703920..dda3260 100644 (file)
--- a/api/v1/swagger/definitions/hold.json
+++ b/api/v1/swagger/definitions/hold.json
@@ -1,63 +1,83 @@
 {
   "type": "object",
   "properties": {
-    "reserve_id": {
-      "$ref": "../x-primitives.json#/reserve_id"
+    "hold_id": {
+      "type": "integer",
+      "description": "Internal hold identifier"
     },
-    "borrowernumber": {
-      "$ref": "../x-primitives.json#/borrowernumber"
+    "patron_id": {
+      "type": "integer",
+      "description": "Internal patron identifier"
     },
-    "reservedate": {
-      "description": "the date the hold was placed"
-    },
-    "biblionumber": {
-      "$ref": "../x-primitives.json#/biblionumber"
-    },
-    "branchcode": {
-      "$ref": "../x-primitives.json#/branchcode"
+    "hold_date": {
+      "type": ["string", "null"],
+      "format": "date",
+      "description": "The date the hold was placed"
     },
-    "notificationdate": {
-      "description": "currently unused"
+    "biblio_id": {
+      "type": "integer",
+      "description": "Internal biblio identifier"
     },
-    "reminderdate": {
-      "description": "currently unused"
+    "pickup_library_id": {
+      "type": ["string", "null"],
+      "description": "Internal library identifier for the pickup library"
     },
-    "cancellationdate": {
-      "description": "the date the hold was cancelled"
+    "cancelation_date": {
+      "type": ["string", "null"],
+      "format": "date",
+      "description": "The date the hold was cancelled"
     },
-    "reservenotes": {
-      "description": "notes related to this hold"
+    "notes": {
+      "type": ["string", "null"],
+      "description": "Notes related to this hold"
     },
     "priority": {
-      "description": "where in the queue the patron sits"
+      "type": ["integer", "null"],
+      "description": "Where in the queue the patron sits"
     },
-    "found": {
-      "description": "a one letter code defining what the status of the hold is after it has been confirmed"
+    "status": {
+      "type": ["string", "null"],
+      "description": "A one letter code defining what the status of the hold is after it has been confirmed"
     },
     "timestamp": {
-      "description": "date and time the hold was last updated"
+      "type": "string",
+      "format": "date-time",
+      "description": "Timestamp for the latest hold update"
     },
-    "itemnumber": {
-      "$ref": "../x-primitives.json#/itemnumber"
+    "item_id": {
+      "type": ["string", "null"],
+      "description": "Internal item identifier"
     },
-    "waitingdate": {
-      "description": "the date the item was marked as waiting for the patron at the library"
+    "waiting_date": {
+      "type": ["string", "null"],
+      "format": "date",
+      "description": "The date the item was marked as waiting for the patron at the library"
     },
-    "expirationdate": {
-      "description": "the date the hold expires"
+    "expiration_date": {
+      "type": ["string", "null"],
+      "format": "date",
+      "description": "The date the hold expires"
     },
-    "lowestPriority": {
-      "description": ""
+    "lowest_priority": {
+      "type": "boolean",
+      "description": "Controls if the hold is given the lowest priority on the queue"
     },
-    "suspend": {
-      "description": ""
+    "suspended": {
+      "type": "boolean",
+      "description": "Controls if the hold is suspended"
     },
-    "suspend_until": {
-      "description": ""
+    "suspended_until": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date until which the hold has been suspended"
     },
-    "itemtype": {
+    "item_type": {
       "type": ["string", "null"],
       "description": "If record level hold, the optional itemtype of the item the patron is requesting"
+    },
+    "item_level": {
+      "type": "boolean",
+      "description": "If the hold is placed at item level"
     }
   }
 }