{"swagger":"2.0","info":{"description":"Api Documentation","version":"1.0","title":"Api Documentation","termsOfService":"urn:tos","contact":{},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0"}},"host":"localhost:4621","basePath":"/","tags":[{"name":"stored-annotation-set-controller","description":"Stored Annotation Set Controller"},{"name":"annotation-controller","description":"Annotation Controller"},{"name":"annotation-set-search-controller","description":"Annotation Set Search Controller"}],"paths":{"/annotation-sets":{"post":{"tags":["stored-annotation-set-controller"],"summary":"Create Annotation Set.","operationId":"createAnnotationSetUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/AnnotationSet"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AnnotationSetHalResource"}}}}},"/annotation-sets/filter":{"get":{"tags":["annotation-set-search-controller"],"summary":"Retrieve all Annotation Sets associated with a given DM URL","operationId":"findAllAnnotationSetByDocumentUrlUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"url","in":"query","description":"url","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/PagedResources"}}}}},"/annotation-sets/{annotationSetId}/annotations":{"post":{"tags":["annotation-controller"],"summary":"createAnnotation","operationId":"createAnnotationUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"annotationSetId","in":"path","description":"annotationSetId","required":true,"type":"string"},{"in":"body","name":"annotation","description":"annotation","required":true,"schema":{"$ref":"#/definitions/Annotation"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AnnotationHalResource"}}}}},"/annotation-sets/{annotationSetId}/annotations/{annotationId}":{"get":{"tags":["annotation-controller"],"summary":"getAnnotation","operationId":"getAnnotationUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"annotationSetId","in":"path","description":"annotationSetId","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"annotationId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AnnotationHalResource"}}}},"put":{"tags":["annotation-controller"],"summary":"updateAnnotation","operationId":"updateAnnotationUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"annotationId","in":"path","description":"annotationId","required":true,"type":"string"},{"in":"body","name":"annotation","description":"annotation","required":true,"schema":{"$ref":"#/definitions/Annotation"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AnnotationHalResource"}}}},"delete":{"tags":["annotation-controller"],"summary":"deleteAnnotation","operationId":"deleteAnnotationUsingDELETE","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"annotationId","in":"path","description":"annotationId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AnnotationHalResource"}}}}},"/annotation-sets/{uuid}":{"get":{"tags":["stored-annotation-set-controller"],"summary":"Retrieve Annotation Set instance.","operationId":"retrieveAnnotationSetUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"uuid","in":"path","description":"uuid","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AnnotationSetHalResource"}}}},"delete":{"tags":["stored-annotation-set-controller"],"summary":"Delete Annotation Set instance.","operationId":"deleteAnnotationSetUsingDELETE","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"uuid","in":"path","description":"uuid","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseEntity"}},"204":{"description":"No Content","schema":{"$ref":"#/definitions/ResponseEntity"}}}}}},"definitions":{"Annotation":{"type":"object","properties":{"color":{"type":"string"},"colour":{"type":"string"},"comments":{"type":"array","items":{"$ref":"#/definitions/Comment"}},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"fontSize":{"type":"integer","format":"int64"},"height":{"type":"integer","format":"int64"},"lastModifiedBy":{"type":"string"},"lines":{"type":"array","items":{"$ref":"#/definitions/Point"}},"modifiedOn":{"type":"string","format":"date-time"},"page":{"type":"integer","format":"int64"},"pointX":{"type":"integer","format":"int64"},"pointY":{"type":"integer","format":"int64"},"rectangles":{"type":"array","items":{"$ref":"#/definitions/Rectangle"}},"type":{"type":"string","enum":["drawing","highlight","point","strikeout","textbox","pagenote"]},"uuid":{"type":"string"},"width":{"type":"integer","format":"int64"}}},"AnnotationHalResource":{"type":"object","properties":{"_embedded":{"type":"object","additionalProperties":{"$ref":"#/definitions/ResourceSupport"}},"colour":{"type":"string"},"comments":{"type":"array","items":{"$ref":"#/definitions/Comment"}},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"fontSize":{"type":"integer","format":"int64"},"height":{"type":"integer","format":"int64"},"lastModifiedBy":{"type":"string"},"lines":{"type":"array","items":{"$ref":"#/definitions/Point"}},"links":{"type":"array","items":{"$ref":"#/definitions/Link"}},"modifiedOn":{"type":"string","format":"date-time"},"page":{"type":"integer","format":"int64"},"pointX":{"type":"integer","format":"int64"},"pointY":{"type":"integer","format":"int64"},"rectangles":{"type":"array","items":{"$ref":"#/definitions/Rectangle"}},"type":{"type":"string","enum":["drawing","highlight","point","strikeout","textbox","pagenote"]},"width":{"type":"integer","format":"int64"}}},"AnnotationSet":{"type":"object","properties":{"annotations":{"type":"array","items":{"$ref":"#/definitions/Annotation"}},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"documentUri":{"type":"string"},"lastModifiedBy":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"uuid":{"type":"string"}}},"AnnotationSetHalResource":{"type":"object","properties":{"_embedded":{"type":"object","additionalProperties":{"$ref":"#/definitions/ResourceSupport"}},"annotations":{"type":"array","items":{"$ref":"#/definitions/AnnotationHalResource"}},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"documentUri":{"type":"string"},"lastModifiedBy":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/definitions/Link"}},"modifiedOn":{"type":"string","format":"date-time"},"uuid":{"type":"string"}}},"Comment":{"type":"object","properties":{"content":{"type":"string"},"uuid":{"type":"string"}}},"Link":{"type":"object","properties":{"deprecation":{"type":"string"},"href":{"type":"string"},"hreflang":{"type":"string"},"media":{"type":"string"},"rel":{"type":"string"},"templated":{"type":"boolean"},"title":{"type":"string"},"type":{"type":"string"}}},"PageMetadata":{"type":"object","properties":{"number":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int64"},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int64"}}},"PagedResources":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object"}},"links":{"type":"array","items":{"$ref":"#/definitions/Link"}},"page":{"$ref":"#/definitions/PageMetadata"}}},"PagedResources«Resource«AnnotationSetHalResource»»":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/Resource«AnnotationSetHalResource»"}},"links":{"type":"array","items":{"$ref":"#/definitions/Link"}},"page":{"$ref":"#/definitions/PageMetadata"}}},"Point":{"type":"object","properties":{"pointX":{"type":"integer","format":"int64"},"pointY":{"type":"integer","format":"int64"}}},"Rectangle":{"type":"object","properties":{"height":{"type":"integer","format":"int64"},"pointX":{"type":"integer","format":"int64"},"pointY":{"type":"integer","format":"int64"},"uuid":{"type":"string"},"width":{"type":"integer","format":"int64"},"x":{"type":"integer","format":"int64"},"y":{"type":"integer","format":"int64"}}},"ResourceSupport":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/definitions/Link"}}}},"Resource«AnnotationSetHalResource»":{"type":"object","properties":{"_embedded":{"type":"object","additionalProperties":{"$ref":"#/definitions/ResourceSupport"}},"annotations":{"type":"array","items":{"$ref":"#/definitions/AnnotationHalResource"}},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"documentUri":{"type":"string"},"lastModifiedBy":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/definitions/Link"}},"modifiedOn":{"type":"string","format":"date-time"},"uuid":{"type":"string"}}},"ResponseEntity":{"type":"object","properties":{"body":{"type":"object"},"statusCode":{"type":"string","enum":["100","101","102","103","200","201","202","203","204","205","206","207","208","226","300","301","302","303","304","305","307","308","400","401","402","403","404","405","406","407","408","409","410","411","412","413","414","415","416","417","418","419","420","421","422","423","424","426","428","429","431","451","500","501","502","503","504","505","506","507","508","509","510","511"]},"statusCodeValue":{"type":"integer","format":"int32"}}}}}