Koha/api/v1/swagger/definitions/hold.json
Lari Taskula 7b8c7b038f Bug 16699: Move Swagger-related files to api/v1/swagger
This patch separates Swagger-specifications and the minifySwagger.pl from other
api-files by moving specifications & minifier into api/v1/swagger.

Signed-off-by: Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi>

My name is Olli-Antti Kivilahti and I approve this commit.
We have been using the Swagger2.0-driven REST API on Mojolicious for 1 year now
in production and I am certain we have a pretty good idea on how to work with
the limitations of Swagger2.0
We participated in the development of the Mojolicious::Plugin::Swagger and know
it well. We have made an extension to the plugin to provide full CORS support
and have been building all our in-house features on the new REST API.

Signed-off-by: Johanna Raisa <johanna.raisa@gmail.com>

My name is Johanna Räisä and I approve this commit.
We have been using Swagger2.0-driven REST API in production successfully.

Signed-off-by: Benjamin Rokseth <benjamin.rokseth@kul.oslo.kommune.no>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
2016-08-26 12:08:52 +00:00

63 lines
1.6 KiB
JSON

{
"type": "object",
"properties": {
"reserve_id": {
"$ref": "../x-primitives.json#/reserve_id"
},
"borrowernumber": {
"$ref": "../x-primitives.json#/borrowernumber"
},
"reservedate": {
"description": "the date the hold was placed"
},
"biblionumber": {
"$ref": "../x-primitives.json#/biblionumber"
},
"branchcode": {
"$ref": "../x-primitives.json#/branchcode"
},
"notificationdate": {
"description": "currently unused"
},
"reminderdate": {
"description": "currently unused"
},
"cancellationdate": {
"description": "the date the hold was cancelled"
},
"reservenotes": {
"description": "notes related to this hold"
},
"priority": {
"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"
},
"timestamp": {
"description": "date and time the hold was last updated"
},
"itemnumber": {
"$ref": "../x-primitives.json#/itemnumber"
},
"waitingdate": {
"description": "the date the item was marked as waiting for the patron at the library"
},
"expirationdate": {
"description": "the date the hold expires"
},
"lowestPriority": {
"description": ""
},
"suspend": {
"description": ""
},
"suspend_until": {
"description": ""
},
"itemtype": {
"type": ["string", "null"],
"description": "If record level hold, the optional itemtype of the item the patron is requesting"
}
}
}