{"openapi":"3.0.0","info":{"title":"DAMS API","version":"1.0.0","description":"This is the Swagger documentation for DAMS.","license":{"name":"Licensed Under MIT","url":"https://spdx.org/licenses/MIT.html"},"contact":{"name":"Online Strategy - UC Davis Library","url":"https://library.ucdavis.edu/online-strategy/"}},"paths":{"/api/collection/{collectionId}":{"get":{"tags":["collection"],"summary":"Get collection information by id","description":"Get collection information by id","parameters":[{"name":"collectionId","in":"path","description":"ID of collection","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"@graph":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"array","items":{"type":"string"}},"clientMedia":{"type":"object"},"@id":{"type":"string"},"lastModified":{"type":"string","format":"date-time"},"image":{"type":"object","properties":{"@id":{"type":"string"}}},"identifier":{"type":"string"},"subjects":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"@id":{"type":"string"}}}},"description":{"type":"string"},"yearPublished":{"type":"integer"},"isPartOf":{"type":"object","properties":{"@id":{"type":"string"}}},"itemCount":{"type":"integer"},"datePublished":{"type":"string"},"license":{"type":"object","properties":{"@id":{"type":"string"}}},"name":{"type":"string"},"publisher":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"@id":{"type":"string"}}}}}}},"name":{"type":"string"},"@id":{"type":"string"}}}}}}}},"post":{"tags":["collection"],"summary":"Search for collections by keyword","description":"Search for collections by keyword","parameters":[{"name":"collectionId","in":"path","description":"ID of collection","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string"},"textFields":{"type":"array","items":{"type":"string"}},"limit":{"type":"integer"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"object","properties":{"value":{"type":"integer"},"relation":{"type":"string"}}},"limit":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"@graph":{"type":"array","items":{"type":"object","properties":{"image":{"type":"object","properties":{"@id":{"type":"string"}}},"identifier":{"type":"string"},"@type":{"type":"array","items":{"type":"string"}},"subjects":{"type":"object","properties":{"@id":{"type":"string"}}},"description":{"type":"string"},"yearPublished":{"type":"integer"},"itemCount":{"type":"integer"},"datePublished":{"type":"string"},"license":{"type":"object","properties":{"@id":{"type":"string"}}},"name":{"type":"string"},"clientMedia":{"type":"object"},"publisher":{"type":"array","items":{"type":"object","properties":{"@id":{"type":"string"},"name":{"type":"string"}}}},"@id":{"type":"string"},"lastModified":{"type":"string"}}}},"name":{"type":"string"},"@id":{"type":"string"},"_score":{"type":"number"}}}},"aggregations":{"type":"object","properties":{"facets":{"type":"object"},"ranges":{"type":"object"}}}}}}}}}}},"/api/collection/edits/collection/{collectionId}":{"get":{"tags":["collection"],"summary":"Find item and collection edits for a collection by id","description":"Returns admin preferences overrides for item and collection edits for a collection by id","parameters":[{"name":"collectionId","in":"path","description":"ID of collection","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"collection":{"type":"string","description":"Fedora collection information"},"edits":{"type":"string","description":"Fedora application edits information, showing if the collection has edits"},"itemOverrides":{"type":"array","items":{"type":"object","properties":{"item":{"type":"string","description":"Fedora item information"},"item_default_display":{"type":"string","description":"Default display for the item, showing if the item has edits"}}}}}}}}}}}},"/api/item/{itemId}":{"get":{"tags":["item"],"summary":"Get item information by id","description":"Get item information by id","parameters":[{"name":"itemId","in":"path","description":"ID of item","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"@graph":{"type":"array","items":{"type":"object","properties":{"fileFormatSimple":{"type":"string"},"filename":{"type":"string"},"fileSize":{"type":"integer"},"@type":{"type":"array","items":{"type":"string"}},"clientMedia":{"type":"object","properties":{"images":{"type":"object","properties":{"small":{"type":"object","properties":{"size":{"type":"object","properties":{"width":{"type":"string"},"height":{"type":"string"}}},"url":{"type":"string"}}}}}}},"@id":{"type":"string"},"lastModified":{"type":"string","format":"date-time"},"fileFormat":{"type":"string"},"identifier":{"type":"array","items":{"type":"string"}},"image":{"type":"object","properties":{"@id":{"type":"string"}}},"license":{"type":"object","properties":{"@id":{"type":"string"}}},"material":{"type":"string"},"subjects":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"@id":{"type":"string"}}}},"name":{"type":"string"},"publisher":{"type":"object","properties":{"name":{"type":"string"}}},"associatedMedia":{"type":"object","properties":{"@id":{"type":"string"}}},"isPartOf":{"type":"array","items":{"type":"object","properties":{"@id":{"type":"string"}}}}}}},"@id":{"type":"string"}}}}}}}},"post":{"tags":["item"],"summary":"Search for items by keyword","description":"Search for items by keyword","parameters":[{"name":"itemId","in":"path","description":"ID of item","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string"},"textFields":{"type":"array","items":{"type":"string"}},"limit":{"type":"integer"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"object","properties":{"value":{"type":"integer"},"relation":{"type":"string"}}},"offset":{"type":"integer"},"limit":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"@graph":{"type":"array","items":{"type":"object","properties":{"identifier":{"type":"array","items":{"type":"string"}},"image":{"type":"object","properties":{"@id":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"}}},"@type":{"type":"array","items":{"type":"string"}},"subjects":{"type":"array","items":{"type":"object","properties":{"@id":{"type":"string"}}}},"yearPublished":{"type":"integer"},"associatedMedia":{"type":"array","items":{"type":"object","properties":{"@id":{"type":"string"}}}},"isPartOf":{"type":"object","properties":{"@id":{"type":"string"}}},"datePublished":{"type":"string"},"license":{"type":"object","properties":{"@id":{"type":"string"}}},"name":{"type":"string"},"publisher":{"type":"object","properties":{"name":{"type":"string"}}},"@id":{"type":"string"},"lastModified":{"type":"string"}}}},"@id":{"type":"string"},"_score":{"type":"number"}}}},"aggregations":{"type":"object","properties":{"facets":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"integer"}}},"ranges":{"type":"object","additionalProperties":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"}}}}}}}}}}}}}},"/api/page-search/ia":{"get":{"tags":["page search"],"summary":"Search item by keyword","description":"Search item by keyword","parameters":[{"in":"query","name":"item_id","schema":{"type":"string"},"description":"The item id to search"},{"in":"query","name":"q","schema":{"type":"string"},"description":"The search term"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ia":{"type":"string"},"q":{"type":"string"},"indexed":{"type":"boolean"},"matches":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"par":{"type":"array","items":{"type":"object","properties":{"l":{"type":"integer"},"t":{"type":"integer"},"r":{"type":"integer"},"b":{"type":"integer"},"page":{"type":"integer"},"boxes":{"type":"array","items":{"type":"object","properties":{"l":{"type":"integer"},"t":{"type":"integer"},"r":{"type":"integer"},"b":{"type":"integer"},"page":{"type":"integer"}}}},"page_width":{"type":"integer"},"page_height":{"type":"integer"}}}}}}}}}}}}}}}},"components":{},"tags":[]}