swagger.json

{"_type":"document","_meta":{"url":"https://dboeannotation.acdh.oeaw.ac.at/","title":"DBÖ annotation service rest api"},"api":{"annotations":{"list":{"_type":"link","url":"/api/annotations/","action":"get","fields":[{"name":"page","location":"query","schema":{"_type":"integer","title":"Page","description":"A page number within the paginated result set."}},{"name":"page_size","location":"query","schema":{"_type":"integer","title":"Page size","description":"Number of results to return per page."}},{"name":"title","location":"query","schema":{"_type":"string","title":"","description":""}},{"name":"description","location":"query","schema":{"_type":"string","title":"","description":""}},{"name":"collection","location":"query","schema":{"_type":"string","title":"","description":""}},{"name":"category","location":"query","schema":{"_type":"string","title":"","description":""}},{"name":"created_by","location":"query","schema":{"_type":"string","title":"","description":""}},{"name":"public","location":"query","schema":{"_type":"string","title":"","description":""}}]},"read":{"_type":"link","url":"/api/annotations/{id}/","action":"get","fields":[{"name":"id","required":true,"location":"path","schema":{"_type":"integer","title":"ID","description":"A unique integer value identifying this annotation."}},{"name":"title","location":"query","schema":{"_type":"string","title":"","description":""}},{"name":"description","location":"query","schema":{"_type":"string","title":"","description":""}},{"name":"collection","location":"query","schema":{"_type":"string","title":"","description":""}},{"name":"category","location":"query","schema":{"_type":"string","title":"","description":""}},{"name":"created_by","location":"query","schema":{"_type":"string","title":"","description":""}},{"name":"public","location":"query","schema":{"_type":"string","title":"","description":""}}]}},"categories":{"list":{"_type":"link","url":"/api/categories/","action":"get","fields":[{"name":"page","location":"query","schema":{"_type":"integer","title":"Page","description":"A page number within the paginated result set."}},{"name":"page_size","location":"query","schema":{"_type":"integer","title":"Page size","description":"Number of results to return per page."}},{"name":"name","location":"query","schema":{"_type":"string","title":"","description":""}}]},"read":{"_type":"link","url":"/api/categories/{id}/","action":"get","fields":[{"name":"id","required":true,"location":"path","schema":{"_type":"integer","title":"ID","description":"A unique integer value identifying this category."}},{"name":"name","location":"query","schema":{"_type":"string","title":"","description":""}}]}},"collections":{"list":{"_type":"link","url":"/api/collections/","action":"get","fields":[{"name":"page","location":"query","schema":{"_type":"integer","title":"Page","description":"A page number within the paginated result set."}},{"name":"page_size","location":"query","schema":{"_type":"integer","title":"Page size","description":"Number of results to return per page."}},{"name":"title","location":"query","schema":{"_type":"string","title":"","description":""}},{"name":"created_by","location":"query","schema":{"_type":"string","title":"","description":""}},{"name":"public","location":"query","schema":{"_type":"string","title":"","description":""}}]},"read":{"_type":"link","url":"/api/collections/{id}/","action":"get","fields":[{"name":"id","required":true,"location":"path","schema":{"_type":"integer","title":"ID","description":"A unique integer value identifying this collection."}},{"name":"title","location":"query","schema":{"_type":"string","title":"","description":""}},{"name":"created_by","location":"query","schema":{"_type":"string","title":"","description":""}},{"name":"public","location":"query","schema":{"_type":"string","title":"","description":""}}]}},"dboe-query":{"list":{"_type":"link","url":"/api/dboe-query/","action":"get","description":"The endpoint to query external elasticsearch index;\nthe query matches all fields"}},"documents":{"list":{"_type":"link","url":"/api/documents/","action":"get","fields":[{"name":"page","location":"query","schema":{"_type":"integer","title":"Page","description":"A page number within the paginated result set."}},{"name":"page_size","location":"query","schema":{"_type":"integer","title":"Page size","description":"Number of results to return per page."}},{"name":"es_id","location":"query","schema":{"_type":"string","title":"","description":""}},{"name":"index","location":"query","schema":{"_type":"string","title":"","description":""}},{"name":"version","location":"query","schema":{"_type":"number","title":"","description":""}},{"name":"in_collections","location":"query","schema":{"_type":"string","title":"","description":""}}]},"read":{"_type":"link","url":"/api/documents/{id}/","action":"get","fields":[{"name":"id","required":true,"location":"path","schema":{"_type":"integer","title":"ID","description":"A unique integer value identifying this es_document."}},{"name":"es_id","location":"query","schema":{"_type":"string","title":"","description":""}},{"name":"index","location":"query","schema":{"_type":"string","title":"","description":""}},{"name":"version","location":"query","schema":{"_type":"number","title":"","description":""}},{"name":"in_collections","location":"query","schema":{"_type":"string","title":"","description":""}}]}},"users":{"list":{"_type":"link","url":"/api/users/","action":"get","fields":[{"name":"page","location":"query","schema":{"_type":"integer","title":"Page","description":"A page number within the paginated result set."}},{"name":"page_size","location":"query","schema":{"_type":"integer","title":"Page size","description":"Number of results to return per page."}},{"name":"username","location":"query","schema":{"_type":"string","title":"","description":""}},{"name":"collections","location":"query","schema":{"_type":"string","title":"","description":""}}]},"read":{"_type":"link","url":"/api/users/{id}/","action":"get","fields":[{"name":"id","required":true,"location":"path","schema":{"_type":"integer","title":"ID","description":"A unique integer value identifying this user."}},{"name":"username","location":"query","schema":{"_type":"string","title":"","description":""}},{"name":"collections","location":"query","schema":{"_type":"string","title":"","description":""}}]}}},"api-token-auth":{"create":{"_type":"link","url":"/api-token-auth/","action":"post","encoding":"application/json","fields":[{"name":"username","required":true,"location":"form","schema":{"_type":"string","title":"Username","description":"Valid username for authentication"}},{"name":"password","required":true,"location":"form","schema":{"_type":"string","title":"Password","description":"Valid password for authentication"}}]}},"authenticate":{"create":{"_type":"link","url":"/authenticate/","action":"post","encoding":"application/json","fields":[{"name":"username","required":true,"location":"form","schema":{"_type":"string","title":"Username","description":"Valid username for authentication"}},{"name":"password","required":true,"location":"form","schema":{"_type":"string","title":"Password","description":"Valid password for authentication"}}]}}}