swagger.v4.json

{
    "swagger": "2.0",
    "info": {
        "version": "v0.10.0",
        "title": "Digital Research Books Search API",
        "description": "RESTful API for the Digital Research Books Project"
    },
    "basePath": "/",
    "tags": [
        {
            "name": "digital-research-books",
            "description": "Digital Research Books Search API"
        }
    ],
    "securityDefinitions": {
        "BasicAuth": {
            "type": "basic"
        }
    },
    "paths": {
        "/search": {
            "get": {
                "tags": ["digital-research-books"],
                "summary": "v4 Basic/Advanced Search",
                "description": "Queries DRB collection via ElasticSearch and returns work objects",
                "parameters": [
                    {
                        "name": "query",
                        "in": "query",
                        "description": "Query field/term pair (e.g. keyword:baseball or subject:cricket). Valid fields are keyword, title, author and subject",
                        "required": true,
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "sort",
                        "in": "query",
                        "description": "Sort option field/direction pair (e.g. title:desc). Valid options are: title, author and date",
                        "required": false,
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "filter",
                        "in": "query",
                        "description": "Fiter option field/term pair (e.g. language:French). Valid options are date, language and format",
                        "required": false,
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "showAll",
                        "in": "query",
                        "description": "Setting that controls display of either all editions (true) or only editions with links (false)",
                        "required": false,
                        "type": "boolean"
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "description": "Sets the page of results to return",
                        "required": false,
                        "type": "integer"
                    },
                    {
                        "name": "size",
                        "in": "query",
                        "description": "Sets the number of results to return per page",
                        "required": false,
                        "type": "integer"
                    },
                    {
                        "name": "readerVersion",
                        "in": "query",
                        "description": "Informs the API of the reader to be used, which determines which Read Online links can be served",
                        "required": false,
                        "type": "string",
                        "enum": ["v1", "v2"]
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A search result",
                        "schema": {
                            "$ref": "#/definitions/SearchResponse"
                        }
                    },
                    "404": {
                        "description": "Resource was not found",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "default": {
                        "description": "Unexpected Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    }
                }
            }
        },
        "/work/{uuid}": {
           "get": {
                "tags": ["digital-research-books"],
                "summary": "v4 Get Single Work",
                "description": "Return a single work record identified by a UUID",
                "parameters": [
                    {
                        "name": "uuid",
                        "in": "path",
                        "description": "UUID for work record",
                        "type": "string",
                        "required": true
                    },
                    {
                        "name": "showAll",
                        "in": "query",
                        "description": "If True all editions are returned, if False only editions with readable links are returned",
                        "type": "boolean",
                        "required": false
                    },
                    {
                        "name": "readerVersion",
                        "in": "query",
                        "description": "Informs the API of the reader to be used, which determines which Read Online links can be served",
                        "required": false,
                        "type": "string",
                        "enum": ["v1", "v2"]
                    },
                    {
                        "name": "filter",
                        "in": "query",
                        "description": "Fiter option field/term pair (e.g. format:readable). Valid options are readable, downloadable, and requestable",
                        "required": false,
                        "type": "array",
                        "items": {
                             "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A single DRB Work record",
                        "schema": {
                            "$ref": "#/definitions/SingleWorkResponse"
                        }
                    },
                    "404": {
                        "description": "Resource was not found",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "default": {
                        "description": "Unexpected Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    }
                }
           }
        },
        "/edition/{id}": {
            "get": {
                "tags": ["digital-research-books"],
                "summary": "v4 Get Single Edition",
                "description": "Return a single edition record identified by an internal id",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "description": "Identifier for Edition record",
                        "type": "string",
                        "required": true
                    },
                    {
                        "name": "showAll",
                        "in": "query",
                        "description": "If True all editions are returned, if False only editions with readable links are returned",
                        "type": "boolean",
                        "required": false
                    },
                    {
                        "name": "readerVersion",
                        "in": "query",
                        "description": "Informs the API of the reader to be used, which determines which Read Online links can be served",
                        "required": false,
                        "type": "string",
                        "enum": ["v1", "v2"]
                    },
                    {
                        "name": "filter",
                        "in": "query",
                        "description": "Fiter option field/term pair (e.g. format:readable). Valid options are readable, downloadable, and requestable",
                        "required": false,
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A single DRB Edition record",
                        "schema": {
                            "$ref": "#/definitions/SingleEditionResponse"
                        }
                    },
                    "404": {
                        "description": "Resource was not found",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "default": {
                        "description": "Unexpected Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    }
                }
            }
        },
        "/link/{id}": {
            "get": {
                "tags": ["digital-research-books"],
                "summary": "v4 Get Single Link",
                "description": "Return a single link record with a nested work to provide context",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "description": "Identifier for Link record",
                        "type": "string",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A single DRB Link record",
                        "schema": {
                            "$ref": "#/definitions/SingleLinkResponse"
                        }
                    },
                    "404": {
                        "description": "Resource was not found",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "default": {
                        "description": "Unexpected Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    }
                }
            }
        },
        "/utils/languages": {
            "get": {
                "tags": ["digital-research-books"],
                "summary": "v4 Get Language Counts",
                "description": "Returns an array of all languages present in the collection, optionally with total counts for each language",
                "parameters": [
                    {
                        "name": "totals",
                        "in": "query",
                        "description": "If True return total counts for languages, if False return only languages",
                        "type": "boolean",
                        "required": false
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A response containing an array of all",
                        "schema": {
                            "$ref": "#/definitions/LanguageResponse"
                        }
                    },
                    "404": {
                        "description": "Resource was not found",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "default": {
                        "description": "Unexpected Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    }
                }
            }
        },
        "/utils/proxy": {
            "get": {
                "tags": ["digital-research-books"],
                "summary": "v4 Proxy Resource",
                "description": "Provides a proxy service for use with the NYPL Web reader",
                "parameters": [
                    {
                        "name": "proxy_url",
                        "in": "query",
                        "description": "Provide a URL-encoded resource to proxy",
                        "type": "string",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The proxied resource",
                        "type": "string"
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "default": {
                        "description": "Unexpected Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    }
                }
            }
        },
        "/utils/counts": {
            "get": {
                "tags": ["digital-research-books"],
                "summary": "v4 Get Total Record Counts",
                "description": "Returns counts of work, edition, item and record totals",
                "parameters": [],
                "responses": {
                    "200": {
                        "description": "A response containing an array of all",
                        "schema": {
                            "$ref": "#/definitions/CountResponse"
                        }
                    },
                    "404": {
                        "description": "Resource was not found",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "default": {
                        "description": "Unexpected Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    }
                }
            }
        },
        "/opds": {
            "get": {
                "tags": ["digital-research-books"],
                "summary": "OPDS2 Root Endpoint",
                "description": "Provides a basic overview of the OPDS2 feed and access methods",
                "parameters": [],
                "responses": {
                    "200": {
                        "description": "A basic OPDS2 feed response",
                        "schema": {
                            "$ref": "#/definitions/OPDSFeedResponse"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "default": {
                        "description": "Unexpected Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    }
                }
            }
        },
        "/opds/new": {
            "get": {
                "tags": ["digital-research-books"],
                "summary": "OPDS2 New Publications",
                "description": "A feed of recently updated DRB publications",
                "parameters": [],
                "responses": {
                    "200": {
                        "description": "A basic OPDS2 feed response",
                        "schema": {
                            "$ref": "#/definitions/OPDSFeedResponse"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "default": {
                        "description": "Unexpected Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    }
                }
            }
        },
        "/opds/search": {
            "get": {
                "tags": ["digital-research-books"],
                "summary": "OPDS2 Publications Search",
                "description": "Search endpoint for querying DRB Collection",
                "parameters": [
                    {
                        "name": "keyword",
                        "in": "query",
                        "description": "Query across title, subject and author fields",
                        "required": false,
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "title",
                        "in": "query",
                        "description": "title query (Includes subtitle and alternate title fields)",
                        "required": false,
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "author",
                        "in": "query",
                        "description": "Query on author names",
                        "required": false,
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "subject",
                        "in": "query",
                        "description": "Query on subject headings (across all authorities)",
                        "required": false,
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "filter",
                        "in": "query",
                        "description": "Fiter option field/term pair (e.g. language:French). Valid options are date, language and format",
                        "required": false,
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "showAll",
                        "in": "query",
                        "description": "Setting that controls display of either all editions (true) or only editions with links (false)",
                        "required": false,
                        "type": "boolean"
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "description": "Sets the page of results to return",
                        "required": false,
                        "type": "integer"
                    },
                    {
                        "name": "size",
                        "in": "query",
                        "description": "Sets the number of results to return per page",
                        "required": false,
                        "type": "integer"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A basic OPDS2 feed response",
                        "schema": {
                            "$ref": "#/definitions/OPDSFeedResponse"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "default": {
                        "description": "Unexpected Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    }
                }
            }
        },
        "/opds/publication/{uuid}": {
            "get": {
                 "tags": ["digital-research-books"],
                 "summary": "OPDS2 Get Single Publication",
                 "description": "Return a single publication record identified by a UUID",
                 "parameters": [
                    {
                        "name": "uuid",
                        "in": "path",
                        "description": "UUID for publication record",
                        "type": "string",
                        "required": true
                    }
                 ],
                 "responses": {
                     "200": {
                         "description": "A single DRB Work record",
                         "schema": {
                             "$ref": "#/definitions/OPDSPublicationObject"
                         }
                     },
                     "404": {
                         "description": "Resource was not found",
                         "schema": {
                             "$ref": "#/definitions/ErrorResponse"
                         }
                     },
                     "500": {
                         "description": "Internal Server Error",
                         "schema": {
                             "$ref": "#/definitions/ErrorResponse"
                         }
                     },
                     "default": {
                         "description": "Unexpected Error",
                         "schema": {
                             "$ref": "#/definitions/ErrorResponse"
                         }
                     }
                 }
            }
        },
        "/collection": {
            "post": {
                "tags": ["digital-research-books"],
                "summary": "Create DRB Collection",
                "description": "Creates a collection of selected edition records and returns a formatted OPDS2 feed",
                "security": [
                    {
                        "BasicAuth": []
                    }
                ],
                "parameters": [
                    {
                        "name": "collection",
                        "in": "body",
                        "description": "The collection to create",
                        "schema": {
                            "type": "object",
                            "properties": [
                                {
                                    "title": {
                                        "type": "string"
                                    },
                                    "creator": {
                                        "type": "string"
                                    },
                                    "description": {
                                        "type": "string"
                                    },
                                    "workUUIDs": {
                                        "type": "array",
                                        "items": {
                                            "type": "string"
                                        }
                                    },
                                    "editionIDs": {
                                        "type": "array",
                                        "items": {
                                            "type": "string"
                                        }
                                    },
                                    "autoDef": {
                                      "type": "object",
                                      "properties": {
                                          "sortField": {
                                              "type": "string",
                                              "enum": ["uuid", "title", "author", "date"],
                                              "default": "uuid"
                                          },
                                          "sortDirection": {
                                              "type": "string",
                                              "enum": ["ASC", "DESC"],
                                              "default": "ASC"
                                          },
                                          "limit": {
                                              "type": "number"
                                          },
                                          "keywordQuery": {
                                              "type": "string"
                                          },
                                          "authorQuery": {
                                              "type": "string"
                                          },
                                          "titleQuery": {
                                              "type": "string"
                                          },
                                          "subjectQuery": {
                                              "type": "string"
                                          }
                                      }
                                    }
                                }
                            ]
                        }
                    }
                ],
                "responses": {
                    "201": {
                        "description": "A basic OPDS2 feed response",
                        "schema": {
                            "$ref": "#/definitions/OPDSFeedResponse"
                        }
                    },
                    "400": {
                        "description": "Invalid/missing fields in body of request",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "default": {
                        "description": "Unexpected Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    }
                }
            }
        },
        "/collection/{uuid}": {
            "get": {
                "tags": ["digital-research-books"],
                "summary": "Return DRB Collection",
                "description": "Return a collection of selected edition records as a formatted OPDS2 feed",
                "parameters": [
                    {
                        "name": "uuid",
                        "in": "path",
                        "description": "UUID for publication record",
                        "type": "string",
                        "required": true
                    },
                    {
                        "name": "sort",
                        "in": "query",
                        "description": "Method of sorting collections. Either title or creator",
                        "type": "string",
                        "required": false
                    },
                    {
                        "name": "perPage",
                        "in": "query",
                        "description": "Number of collections to load per page",
                        "type": "integer",
                        "required": false
                    }
                ],
                "responses": {
                    "201": {
                        "description": "A basic OPDS2 feed response",
                        "schema": {
                            "$ref": "#/definitions/OPDSFeedResponse"
                        }
                    },
                    "404": {
                        "description": "Collection not found",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "default": {
                        "description": "Unexpected Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    }
                }
            },
            "delete": {
                "tags": ["digital-research-books"],
                "summary": "Delete a DRB Collection",
                "description": "Deletes the currently specified collection",
                "security": [
                    {
                        "BasicAuth": []
                    }
                ],
                "parameters": [
                    {
                        "name": "uuid",
                        "in": "path",
                        "description": "UUID for publication record",
                        "type": "string",
                        "required": true
                    }
                ],
                "responses": {
                    "201": {
                        "description": "A basic OPDS2 feed response",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "404": {
                        "description": "Collection not found",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "default": {
                        "description": "Unexpected Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    }
                }
            }
        },
        "/collection/replace/{uuid}": {
            "post": {
                "tags": ["digital-research-books"],
                "summary": "Replace a DRB Collection",
                "description": "Replace a collection of selected edition records with a new one as a formatted OPDS2 feed",
                "security": [
                    {
                        "BasicAuth": []
                    }
                ],
                "parameters": [
                    {
                        "name": "uuid",
                        "in": "path",
                        "description": "UUID for publication record",
                        "type": "string",
                        "required": true
                    },
                    {
                        "name": "collection",
                        "in": "body",
                        "description": "The collection to create",
                        "schema": {
                            "type": "object",
                            "properties": [
                                {
                                    "title": {
                                        "type": "string"
                                    },
                                    "creator": {
                                        "type": "string"
                                    },
                                    "description": {
                                        "type": "string"
                                    },
                                    "workUUIDs": {
                                        "type": "array",
                                        "items": {
                                            "type": "string"
                                        }
                                    },
                                    "editionIDs": {
                                        "type": "array",
                                        "items": {
                                            "type": "string"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                ],
                "responses": {
                    "201": {
                        "description": "A basic OPDS2 feed response",
                        "schema": {
                            "$ref": "#/definitions/OPDSFeedResponse"
                        }
                    },
                    "404": {
                        "description": "Collection not found",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "default": {
                        "description": "Unexpected Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    }
                }
            }
        },
        "/collection/update/{uuid}": {
            "post": {
                "tags": ["digital-research-books"],
                "summary": "Update a DRB Collection",
                "description": "Return an updated collection of selected edition records as a formatted OPDS2 feed",
                "security": [
                    {
                        "BasicAuth": []
                    }
                ],
                "parameters": [
                    {
                        "name": "uuid",
                        "in": "path",
                        "description": "UUID for publication record",
                        "type": "string",
                        "required": true
                    },
                    {
                        "name": "title",
                        "in": "query",
                        "description": "Updated title of collection",
                        "type": "string",
                        "required": false
                    },
                    {
                        "name": "creator",
                        "in": "query",
                        "description": "Updated creator of collection",
                        "type": "string",
                        "required": false
                    },
                    {
                        "name": "description",
                        "in": "query",
                        "description": "Updated description of collection",
                        "type": "string",
                        "required": false
                    },
                    {
                        "name": "editionIDs",
                        "in": "query",
                        "description": "Adding new editions in this format (1,2,3) with no space after the commas",
                        "type": "string",
                        "required": false
                    },
                    {
                        "name": "workUUIDs",
                        "in": "query",
                        "description": "Adding a preferred edition from each work given in this format (uuid1, uuid2, uuid3) with no space after the commas",
                        "type": "string",
                        "required": false
                    }
                ],              
                "responses": {
                    "201": {
                        "description": "A basic OPDS2 feed response",
                        "schema": {
                            "$ref": "#/definitions/OPDSFeedResponse"
                        }
                    },
                    "404": {
                        "description": "Collection not found",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "default": {
                        "description": "Unexpected Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    } 
                }
            }
        },
        "/collection/delete/{uuid}": {
            "delete": {
                "tags": ["digital-research-books"],
                "summary": "Delete a Edition/Work from a DRB Collection",
                "description": "Return an updated collection with removed edition/works as a formatted OPDS2 feed",
                "security": [
                    {
                        "BasicAuth": []
                    }
                ],
                "parameters": [
                    {
                        "name": "editionIDs",
                        "in": "query",
                        "description": "Deleting editions in this format (1,2,3) with no space after the commas",
                        "type": "string",
                        "required": false
                    },
                    {
                        "name": "workUUIDs",
                        "in": "query",
                        "description": "Deleting a preferred edition from each work given in this format (uuid1, uuid2, uuid3) with no space after the commas",
                        "type": "string",
                        "required": false
                    }
                ],              
                "responses": {
                    "201": {
                        "description": "A basic OPDS2 feed response",
                        "schema": {
                            "$ref": "#/definitions/OPDSFeedResponse"
                        }
                    },
                    "404": {
                        "description": "Collection not found",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "default": {
                        "description": "Unexpected Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    } 
                }
            }
        },
        "/collection/list": {
            "get": {
                "tags": ["digital-research-books"],
                "summary": "Return list of DRB Collections",
                "description": "Returns list of collections in DRB",
                "parameters": [
                    {
                        "name": "sort",
                        "in": "query",
                        "description": "Method of sorting collections. Either title or creator",
                        "type": "string",
                        "required": false
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "description": "Page of collections to load",
                        "type": "integer",
                        "required": false
                    },
                    {
                        "name": "perPage",
                        "in": "query",
                        "description": "Number of collections to load per page",
                        "type": "integer",
                        "required": false
                    }
                ],
                "responses": {
                    "201": {
                        "description": "A basic OPDS2 feed response",
                        "schema": {
                            "$ref": "#/definitions/OPDSFeedResponse"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    },
                    "default": {
                        "description": "Unexpected Error",
                        "schema": {
                            "$ref": "#/definitions/ErrorResponse"
                        }
                    }
                }
            }
        }
    },
    "definitions": {
        "ErrorResponse": {
            "type": "object",
            "properties": {
                "status": {
                    "type": "integer",
                    "format": "int32"
                },
                "timestamp": {
                    "type": "string",
                    "format": "date-time"
                },
                "responseType": {
                    "type": "string"
                },
                "data": {
                    "type": "object",
                    "properties": {
                        "message": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "CountResponse": {
            "type": "object",
            "properties": {
                "type": "object",
                "properties": {
                    "status": {
                        "type": "integer",
                        "format": "int32"
                    },
                    "timestamp": {
                        "type": "string",
                        "format": "date-time"
                    },
                    "responseType": {
                        "type": "string"
                    },
                    "data": {
                        "$ref": "#/definitions/CountsObject"
                    }
                }
            }
        },
        "LanguageResponse": {
            "type": "object",
            "properties": {
                "type": "object",
                "properties": {
                    "status": {
                        "type": "integer",
                        "format": "int32"
                    },
                    "timestamp": {
                        "type": "string",
                        "format": "date-time"
                    },
                    "responseType": {
                        "type": "string"
                    },
                    "data": {
                        "type": "array",
                        "items": {
                            "$ref": "#/definitions/LanguageCountObject"
                        }
                    }
                }
            }
        },
        "SearchResponse": {
            "type": "object",
            "properties": {
                "status": {
                    "type": "integer",
                    "format": "int32"
                },
                "timestamp": {
                    "type": "string",
                    "format": "date-time"
                },
                "responseType": {
                    "type": "string"
                },
                "data": {
                    "$ref": "#/definitions/SearchResults"
                }
            }
        },
        "SingleEditionResponse": {
            "type": "object",
            "properties": {
                "status": {
                    "type": "integer",
                    "format": "int32"
                },
                "timestamp": {
                    "type": "string",
                    "format": "date-time"
                },
                "responseType": {
                    "type": "string"
                },
                "data": {
                    "$ref": "#/definitions/EditionObject"
                }
            }
        },
        "SingleLinkResponse": {
            "type": "object",
            "properties": {
                "status": {
                    "type": "integer",
                    "format": "int32"
                },
                "timestamp": {
                    "type": "string",
                    "format": "date-time"
                },
                "responseType": {
                    "type": "string"
                },
                "data": {
                    "$ref": "#/definitions/SingleLinkObject"
                }
            }
        },
        "SingleWorkResponse": {
            "type": "object",
            "properties": {
                "status": {
                    "type": "integer",
                    "format": "int32"
                },
                "timestamp": {
                    "type": "string",
                    "format": "date-time"
                },
                "responseType": {
                    "type": "string"
                },
                "data": {
                    "$ref": "#/definitions/WorkObject"
                }
            }
        },
        "TokenResponse": {
            "type": "object",
            "properties": {
                "access_token": {
                    "type": "string"
                },
                "expires_at": {
                    "type": "number",
                    "format": "double"
                },
                "expires_in": {
                    "type": "integer"
                },
                "id_token": {
                    "type": "string"
                },
                "scope": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "token_type": {
                    "type": "string"
                }
            }
        },
        "SearchResults": {
            "type": "object",
            "properties": {
                "facets": {
                    "type": "object",
                    "items": {
                        "$ref": "#/definitions/FacetObject"
                    }
                },
                "paging": {
                    "$ref": "#/definitions/PagingOptions"
                },
                "totalWorks": {
                    "type": "integer"
                },
                "works": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/WorkObject"
                    }
                }
            }
        },
        "FacetOption": {
            "type": "object",
            "properties": {
                "value": {
                    "type": "string"
                },
                "count": {
                    "type": "integer"
                }
            }
        },
        "PagingOptions": {
            "type": "object",
            "properties": {
                "recordsPerPage": {
                    "type": "integer"
                },
                "firstPage": {
                    "type": "integer"
                },
                "previousPage": {
                    "type": "integer"
                },
                "currentPage": {
                    "type": "integer"
                },
                "nextPage": {
                    "type": "integer"
                },
                "lastPage": {
                    "type": "integer"
                }
            }
        },
        "AuthorObject": {
            "type": "object",
            "properties": {
                "lcnaf": {
                    "type": "string"
                },
                "name": {
                    "type": "string"
                },
                "primary": {
                    "type": "boolean"
                },
                "viaf": {
                    "type": "string"
                }
            }
        },
        "ContributorObject": {
            "type": "object",
            "properties": {
                "lcnaf": {
                    "type": "string"
                },
                "name": {
                    "type": "string"
                },
                "roles": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "viaf": {
                    "type": "string"
                }
            }
        },
        "CountsObject": {
            "type": "object",
            "properties": {
                "editions": {
                    "type": "integer"
                },
                "items": {
                    "type": "integer"
                },
                "links": {
                    "type": "integer"
                },
                "records": {
                    "type": "integer"
                },
                "works": {
                    "type": "integer"
                }
            }
        },
        "DateObject": {
            "type": "object",
            "properties": {
                "date": {
                    "type": "string"
                },
                "type": {
                    "type": "string"
                }
            }
        },
        "EditionObject": {
            "type": "object",
            "properties": {
                "alt_titles": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "contributors": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/ContributorObject"
                    }
                },
                "edition": {
                    "type": "string"
                },
                "edition_id": {
                    "type": "integer"
                },
                "edition_statement": {
                    "type": "string"
                },
                "extent": {
                    "type": "string"
                },
                "items": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/ItemObject"
                    }
                },
                "languages": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/LanguageObject"
                    }
                },
                "measurements": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/MeasurementObject"
                    }
                },
                "publication_date": {
                    "type": "string",
                    "format": "date-time"
                },
                "publication_place": {
                    "type": "string"
                },
                "publishers": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/PublisherObject"
                    }
                },
                "sub_title": {
                    "type": "string"
                },
                "summary": {
                    "type": "string"
                },
                "table_of_contents": {
                    "type": "string"
                },
                "title": {
                    "type": "string"
                },
                "volume": {
                    "type": "string"
                }
            }
        },
        "FacetObject": {
            "type": "object",
            "properties": {
                "languages": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/FacetOption"
                    }
                },
                "formats": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/FacetOption"
                    }
                }
            }
        },
        "ItemObject": {
            "type": "object",
            "properties": {
                "content_type": {
                    "type": "string"
                },
                "contributors": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/ContributorObject"
                    }
                },
                "drm": {
                    "type": "object"
                },
                "item_id": {
                    "type": "integer"
                },
                "links": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/LinkObject"
                    }
                },
                "location": {
                    "type": "string"
                },
                "measurements": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/MeasurementObject"
                    }
                },
                "modified": {
                    "type": "string",
                    "format": "date-time"
                },
                "rights": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/RightsObject"
                    }
                },
                "source": {
                    "type": "string"
                }
            }
        },
        "LanguageObject": {
            "type": "object",
            "properties": {
                "iso_2": {
                    "type": "string"
                },
                "iso_3": {
                    "type": "string"
                },
                "language": {
                    "type": "string"
                }
            }
        },
        "LanguageCountObject": {
            "type": "object",
            "properties": {
                "language": {
                    "type": "string"
                },
                "work_total": {
                    "type": "integer"
                }
            }
        },
        "LinkObject": {
            "type": "object",
            "properties": {
                "link_id": {
                    "type": "integer"
                },
                "mediaType": {
                    "$ref": "#/definitions/MediaType"
                },
                "url": {
                    "type": "string",
                    "format": "uri"
                },
                "flags": {
                   "type": "object"
                }
            }
        },
        "MeasurementObject": {
            "type": "object",
            "properties": {
                "type": {
                    "type": "string"
                },
                "value": {
                    "type": "string"
                }
            }
        },
        "PublisherObject": {
            "type": "object",
            "properties": {
                "lcnaf": {
                    "type": "string"
                },
                "name": {
                    "type": "string"
                },
                "viaf": {
                    "type": "string"
                }
            }
        },
        "RightsObject": {
            "type": "object",
            "properties": {
                "source": {
                    "type": "string"
                },
                "license": {
                    "type": "string"
                },
                "rights_statement": {
                    "type": "string"
                },
                "rights_reason": {
                    "type": "string"
                }
            }
        },
        "SingleLinkObject": {
            "type": "object",
            "properties": {
                "content": {
                    "type": "string"
                },
                "flags": {
                    "type": "object"
                },
                "link_id": {
                    "type": "integer"
                },
                "md5": {
                    "type": "string"
                },
                "media_type": {
                    "$ref": "#/definitions/MediaType"
                },
                "url": {
                    "type": "string",
                    "format": "uri"
                },
                "work": {
                    "$ref": "#/definitions/WorkObject"
                }
            }
        },
        "SubjectObject": {
            "type": "object",
            "properties": {
                "authority": {
                    "type": "string"
                },
                "controlNo": {
                    "type": "string"
                },
                "heading": {
                    "type": "string"
                }
            }
        },
        "WorkObject": {
            "type": "object",
            "properties": {
                "alt_titles": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "authors": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/AuthorObject"
                    }
                },
                "contributors": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/ContributorObject"
                    }
                },
                "dates": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/DateObject"
                    }
                },
                "editions": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/EditionObject"
                    }
                },
                "measurements": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/MeasurementObject"
                    }
                },
                "medium": {
                    "type": "string"
                },
                "series": {
                    "type": "string"
                },
                "series_position": {
                    "type": "integer"
                },
                "sub_title": {
                    "type": "string"
                },
                "subjects": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/SubjectObject"
                    }
                },
                "title": {
                    "type": "string"
                },
                "uuid": {
                    "type": "string",
                    "format": "uuid"
                }
            }
        },
        "MediaType": {
            "type": "string",
            "enum": ["text/html", "application/pdf", "application/epub+zip", "application/epub+xml", "application/webpub+json", "image/jpeg", "image/png"]
        },
        "OPDSFeedResponse": {
            "type": "object",
            "properties": {
                "links": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/OPDSLinkObject"
                    }
                },
                "metadata": {
                    "type": "object",
                    "$ref": "#/definitions/OPDSMetadataObject"
                },
                "navigation": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/OPDSNavigationObject"
                    }
                },
                "publications": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/OPDSPublicationObject"
                    }
                },
                "groups": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/OPDSGroupObject"
                    }
                },
                "facets": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/OPDSFacetObject"
                    }
                },
                "images": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/OPDSLinkObject"
                    }
                }
            }
        },
        "OPDSLinkObject": {
            "type": "object",
            "properties": {
                "href": {
                    "type": "string",
                    "format": "uri",
                    "required": true
                },
                "type": {
                    "type": "string"
                },
                "rel": {
                    "type": "string"
                },
                "title": {
                    "type": "string"
                },
                "templated": {
                    "type": "boolean"
                },
                "language": {
                    "type": "string"
                },
                "alternate": {
                    "type": "string"
                },
                "children": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/OPDSLinkObject"
                    }
                },
                "properties": {
                    "type": "object"
                },
                "height": {
                    "type": "integer"
                },
                "width": {
                    "type": "integer"
                },
                "duration": {
                    "type": "integer"
                },
                "bitrate": {
                    "type": "integer"
                }
            }
        },
        "OPDSMetadataObject": {
            "type": "object",
            "properties": {
                "identifier": {
                    "type": "string"
                },
                "title": {
                    "type": "string"
                },
                "subtitle": {
                    "type": "string"
                },
                "sortAs": {
                    "type": "string"
                },
                "author": {
                    "type": "string"
                },
                "translator": {
                    "type": "string"
                },
                "editor": {
                    "type": "string"
                },
                "illustrator": {
                    "type": "string"
                },
                "artist": {
                    "type": "string"
                },
                "colorist": {
                    "type": "string"
                },
                "inker": {
                    "type": "string"
                },
                "penciler": {
                    "type": "string"
                },
                "letterer": {
                    "type": "string"
                },
                "narrator": {
                    "type": "string"
                },
                "contributor": {
                    "type": "string"
                },
                "name": {
                    "type": "string"
                },
                "language": {
                    "type": "string"
                },
                "subject": {
                    "type": "string"
                },
                "numberOfPages": {
                    "type": "integer"
                },
                "duration": {
                    "type": "integer"
                },
                "abridged": {
                    "type": "string"
                },
                "publisher": {
                    "type": "string"
                },
                "imprint": {
                    "type": "string"
                },
                "modified": {
                    "type": "string",
                    "format": "date-time"
                },
                "published": {
                    "type": "integer",
                    "format": "date-time"
                },
                "description": {
                    "type": "string"
                },
                "belongsTo": {
                    "type": "string"
                },
                "series": {
                    "type": "string"
                },
                "collection": {
                    "type": "string"
                },
                "position": {
                    "type": "string"
                },
                "readingOrder": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/OPDSLinkObject"
                    }
                },
                "resources": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/OPDSLinkObject"
                    }
                },
                "links": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/OPDSLinkObject"
                    }
                },
                "href": {
                    "type": "string",
                    "format": "url"
                },
                "type": {
                    "type": "string"
                },
                "rel": {
                    "type": "string"
                },
                "height": {
                    "type": "integer"
                },
                "width": {
                    "type": "integer"
                },
                "bitrate": {
                    "type": "integer"
                },
                "alternate": {
                    "type": "integer"
                }
            }
        },
        "OPDSNavigationObject": {
            "type": "object",
            "properties": {
                "href": {
                    "type": "string"
                },
                "title": {
                    "type": "string",
                    "required": true
                },
                "type": {
                    "type": "string"
                },
                "rel": {
                    "type": "string"
                }
            }
        },
        "OPDSPublicationObject": {
            "type": "object",
            "properties": {
                "type": {
                    "type": "string"
                },
                "metadata": {
                    "type": "object",
                    "$ref": "#/definitions/OPDSMetadataObject"
                },
                "links": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/OPDSLinkObject"
                    }
                },
                "images": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/OPDSLinkObject"
                    }
                },
                "editions": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/OPDSPublicationObject"
                    }
                }
            }
        },
        "OPDSGroupObject": {
            "type": "object",
            "properties": {
                "metadata": {
                    "type": "object",
                    "$ref": "#/definitions/OPDSMetadataObject"
                },
                "navigation": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/OPDSNavigationObject"
                    }
                },
                "publications": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/OPDSPublicationObject"
                    }
                }
            }
        },
        "OPDSFacetObject": {
            "type": "object",
            "properties": {
                "metadata": {
                    "type": "object",
                    "$ref": "#/definitions/OPDSMetadataObject"
                },
                "links": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/OPDSLinkObject"
                    }
                }
            }
        }
    }
}