{"openapi":"3.1.0","info":{"title":"EM Annotation API","description":"API to store and retrieve annotations for Documents.","version":"v0.0.1"},"servers":[{"url":"http://localhost","description":"Generated server url"}],"tags":[{"name":"Tags Service","description":"Endpoint for managing Tags."},{"name":"Bookmark Service","description":"Endpoint for managing Bookmarks."},{"name":"Annotations Service","description":"Endpoint for managing Annotations."},{"name":"AnnotationSet Service","description":"Endpoint for managing AnnotationSet."},{"name":"AnnotationSet Filter Service","description":"Endpoint for filtering AnnotationSet."},{"name":"Metadata Service","description":"Endpoint for managing Metadata."},{"name":"Document Data","description":"Endpoints to manage data related to documents"},{"name":"Rectangle Service","description":"Endpoint for managing Rectangles."},{"name":"Comments Service","description":"Endpoint for managing Comments."}],"paths":{"/api/rectangles":{"get":{"tags":["Rectangle Service"],"summary":"Get all comments","description":"A GET request without a body is used to retrieve all comments","operationId":"getAllRectangles","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}},{"name":"pageable","in":"query","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RectangleDTO"}}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RectangleDTO"}}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RectangleDTO"}}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RectangleDTO"}}}}}}},"put":{"tags":["Rectangle Service"],"summary":"Update an existing rectangleDTO","description":"A PUT request to update a rectangleDTO","operationId":"updateRectangle","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RectangleDTO"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RectangleDTO"}}}},"400":{"description":"rectangleDTO not valid, invalid id","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RectangleDTO"}}}},"500":{"description":"rectangleDTO couldn't be updated","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RectangleDTO"}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RectangleDTO"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RectangleDTO"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RectangleDTO"}}}}}},"post":{"tags":["Rectangle Service"],"summary":"Create a rectangleDTO","description":"A POST request to create a rectangleDTO","operationId":"createRectangle","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RectangleDTO"}}},"required":true},"responses":{"201":{"description":"Successfully created","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RectangleDTO"}}}},"400":{"description":"rectangleDTO not valid, invalid id","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RectangleDTO"}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RectangleDTO"}}}},"404":{"description":"Annotation Id not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RectangleDTO"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RectangleDTO"}}}}}}},"/api/comments":{"get":{"tags":["Comments Service"],"summary":"Get all comments","description":"A GET request without a body is used to retrieve all annotations","operationId":"getAllComments","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}},{"name":"pageable","in":"query","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommentDTO"}}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommentDTO"}}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommentDTO"}}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommentDTO"}}}}}}},"put":{"tags":["Comments Service"],"summary":"Update an existing annotationDTO","description":"A PUT request to update an annotationDTO","operationId":"updateComment","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentDTO"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CommentDTO"}}}},"400":{"description":"commentDTO not valid, invalid id","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CommentDTO"}}}},"500":{"description":"commentDTO couldn't be updated","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CommentDTO"}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CommentDTO"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CommentDTO"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CommentDTO"}}}}}},"post":{"tags":["Comments Service"],"summary":"Create an commentDTO","description":"A POST request to create a commentDTO","operationId":"createComment","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentDTO"}}},"required":true},"responses":{"201":{"description":"Successfully created","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CommentDTO"}}}},"400":{"description":"commentDTO not valid, invalid id","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CommentDTO"}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CommentDTO"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CommentDTO"}}}}}}},"/api/bookmarks_multiple":{"put":{"tags":["Bookmark Service"],"summary":"Update multiple existing bookmarkDTO objects","description":"A PUT request to update multiple bookmarkDTO objects","operationId":"updateMultipleBookmarks","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BookmarkDTO"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BookmarkDTO"}}}}},"400":{"description":"bookmarkDTO objects not valid, invalid id","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BookmarkDTO"}}}}},"500":{"description":"bookmarkDTO objects couldn't be updated","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BookmarkDTO"}}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BookmarkDTO"}}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BookmarkDTO"}}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BookmarkDTO"}}}}}}},"delete":{"tags":["Bookmark Service"],"summary":"Delete multiple existing bookmarkDTO objects","description":"A DELETE request to delete multiple bookmarkDTO objects","operationId":"deleteMultipleBookmarks","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBookmarkDTO"}}},"required":true},"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"}}}},"/api/bookmarks":{"put":{"tags":["Bookmark Service"],"summary":"Update an existing bookmarkDTO","description":"A PUT request to update an bookmarkDTO","operationId":"updateBookmark","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookmarkDTO"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BookmarkDTO"}}}},"400":{"description":"bookmarkDTO not valid, invalid id","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BookmarkDTO"}}}},"500":{"description":"bookmarkDTO couldn't be updated","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BookmarkDTO"}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BookmarkDTO"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BookmarkDTO"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BookmarkDTO"}}}}}},"post":{"tags":["Bookmark Service"],"summary":"Create an bookmarkDTO","description":"A POST request to create an bookmarkDTO","operationId":"createBookmark","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookmarkDTO"}}},"required":true},"responses":{"201":{"description":"Successfully created","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BookmarkDTO"}}}},"400":{"description":"bookmarkDTO not valid, invalid id","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BookmarkDTO"}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BookmarkDTO"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BookmarkDTO"}}}}}}},"/api/annotations":{"get":{"tags":["Annotations Service"],"summary":"Get all annotations","description":"A GET request without a body is used to retrieve all annotations","operationId":"getAllAnnotations","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}},{"name":"pageable","in":"query","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnnotationDTO"}}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnnotationDTO"}}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnnotationDTO"}}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnnotationDTO"}}}}}}},"put":{"tags":["Annotations Service"],"summary":"Update an existing annotationDTO","description":"A PUT request to update an annotationDTO","operationId":"updateAnnotation","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationDTO"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationDTO"}}}},"400":{"description":"annotationDTO not valid, invalid id","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationDTO"}}}},"500":{"description":"annotationDTO couldn't be updated","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationDTO"}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationDTO"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationDTO"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationDTO"}}}}}},"post":{"tags":["Annotations Service"],"summary":"Create an annotationDTO","description":"A POST request to create an annotationDTO","operationId":"createAnnotation","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationDTO"}}},"required":true},"responses":{"201":{"description":"Successfully created","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationDTO"}}}},"400":{"description":"annotationDTO not valid, invalid id","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationDTO"}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationDTO"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationDTO"}}}}}}},"/api/annotation-sets":{"get":{"tags":["AnnotationSet Service"],"summary":"Get all annotationSets","description":"A GET request without a body is used to retrieve all annotationSets","operationId":"getAllAnnotationSets","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}},{"name":"pageable","in":"query","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}}}}},"put":{"tags":["AnnotationSet Service"],"summary":"Update an existing annotationSetDTO","description":"A PUT request to update an annotationSetDTO","operationId":"updateAnnotationSet","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}},"400":{"description":"annotationSetDTO not valid, invalid id","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}},"500":{"description":"annotationSetDTO couldn't be updated","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}}}},"post":{"tags":["AnnotationSet Service"],"summary":"Create an annotationSetDTO","description":"A POST request to create an annotationSetDTO","operationId":"createAnnotationSet","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}},"required":true},"responses":{"201":{"description":"Successfully created","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}},"400":{"description":"annotationSetDTO not valid, invalid id","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}}}}},"/api/metadata/":{"post":{"tags":["Metadata Service"],"summary":"Create an metadataDto","description":"A POST request to create an metadataDto","operationId":"createMetaData","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataDto"}}},"required":true},"responses":{"201":{"description":"Successfully created","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MetadataDto"}}}},"400":{"description":"metadataDto not valid","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MetadataDto"}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MetadataDto"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MetadataDto"}}}}}}},"/api/{documentId}/bookmarks":{"get":{"tags":["Bookmark Service"],"summary":"Get all bookmarks for Document ID","operationId":"getAllDocumentBookmarks","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"Document Id","required":true,"schema":{"type":"UUID"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BookmarkDTO"}}}}},"204":{"description":"No Content","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BookmarkDTO"}}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BookmarkDTO"}}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BookmarkDTO"}}}}}}}},"/api/tags/{createdBy}":{"get":{"tags":["Tags Service"],"summary":"Get list of tags created by user","description":"A GET request to retrieve a list of tags","operationId":"getTagsCreatedBy","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}},{"name":"createdBy","in":"path","description":"Created By","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TagDTO"}}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TagDTO"}}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TagDTO"}}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TagDTO"}}}}}}}},"/api/rectangles/{id}":{"get":{"tags":["Rectangle Service"],"summary":"Get an existing rectangleDTO","description":"A GET request to retrieve a rectangleDTO","operationId":"getRectangle","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Rectangle Id","required":true,"schema":{"type":"UUID"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RectangleDTO"}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RectangleDTO"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RectangleDTO"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RectangleDTO"}}}}}},"delete":{"tags":["Rectangle Service"],"summary":"Delete a commentDTO","description":"A DELETE request to delete a commentDTO","operationId":"deleteRectangle","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Rectangle Id","required":true,"schema":{"type":"UUID"}}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"}}}},"/api/metadata/{documentId}":{"get":{"tags":["Metadata Service"],"summary":"Get the metadata for Document ID","operationId":"getMetadata","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"Document Id","required":true,"schema":{"type":"UUID"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MetadataDto"}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MetadataDto"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MetadataDto"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MetadataDto"}}}}}}},"/api/comments/{id}":{"get":{"tags":["Comments Service"],"summary":"Get an existing commentDTO","description":"A GET request to retrieve an commentDTO","operationId":"getComment","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Comment Id","required":true,"schema":{"type":"UUID"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CommentDTO"}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CommentDTO"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CommentDTO"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CommentDTO"}}}}}},"delete":{"tags":["Comments Service"],"summary":"Delete a commentDTO","description":"A DELETE request to delete a commentDTO","operationId":"deleteComment","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Comment Id","required":true,"schema":{"type":"UUID"}}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"}}}},"/api/annotations/{id}":{"get":{"tags":["Annotations Service"],"summary":"Get an existing annotationDTO","description":"A GET request to retrieve an annotationDTO","operationId":"getAnnotation","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Annotation Id","required":true,"schema":{"type":"UUID"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationDTO"}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationDTO"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationDTO"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationDTO"}}}}}},"delete":{"tags":["Annotations Service"],"summary":"Delete an annotationDTO","description":"A DELETE request to delete an annotationDTO","operationId":"deleteAnnotation","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Annotation Id","required":true,"schema":{"type":"UUID"}}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"}}}},"/api/annotation-sets/{id}":{"get":{"tags":["AnnotationSet Service"],"summary":"Get an existing annotationSetDTO","description":"A GET request to retrieve an annotationSetDTO","operationId":"getAnnotationSet","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"AnnotationSet Id","required":true,"schema":{"type":"UUID"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}},"204":{"description":"No Content","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}}}},"delete":{"tags":["AnnotationSet Service"],"summary":"Delete an annotationSetDTO","description":"A DELETE request to delete an annotationSetDTO","operationId":"deleteAnnotationSet","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"AnnotationSet Id","required":true,"schema":{"type":"UUID"}}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"}}}},"/api/annotation-sets/filter":{"get":{"tags":["AnnotationSet Filter Service"],"summary":"Filter an annotationSet","description":"A GET request to filter an annotationSetDTO","operationId":"getAllAnnotationSets_1","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}},"401":{"description":"Unauthorised","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnotationSetDTO"}}}}}}},"/":{"get":{"tags":["welcome-resource"],"operationId":"welcome","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}}}}},"/api/documents/{docId}/data":{"delete":{"tags":["Document Data"],"summary":"Delete all data related to a document","description":"A DELETE request to remove all annotations, bookmarks, and metadata associated with a specific document ID. This operation is idempotent.","operationId":"deleteDocumentData","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}},{"name":"docId","in":"path","description":"The UUID of the Document to be purged","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Data deleted successfully or did not exist"},"400":{"description":"Invalid Document ID format"},"401":{"description":"Unauthorised (Missing or invalid tokens)"},"403":{"description":"Forbidden - Calling service is not whitelisted to perform this operation"}}}},"/api/bookmarks/{id}":{"delete":{"tags":["Bookmark Service"],"summary":"Delete a BookmarkDTO","description":"A DELETE request to delete a BookmarkDTO","operationId":"deleteBookmark","parameters":[{"name":"authorization","in":"header","description":"Authorization (Idam Bearer token)","required":true,"schema":{"type":"string"}},{"name":"serviceauthorization","in":"header","description":"Service Authorization (S2S Bearer token)","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Bookmark Id","required":true,"schema":{"type":"UUID"}}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"}}}}},"components":{"schemas":{"IdamDetails":{"type":"object","properties":{"forename":{"type":"string"},"surname":{"type":"string"},"email":{"type":"string"}}},"RectangleDTO":{"type":"object","properties":{"createdBy":{"type":"string"},"createdByDetails":{"$ref":"#/components/schemas/IdamDetails"},"lastModifiedByDetails":{"$ref":"#/components/schemas/IdamDetails"},"createdDate":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedDate":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"x":{"type":"number","format":"double"},"y":{"type":"number","format":"double"},"width":{"type":"number","format":"double"},"height":{"type":"number","format":"double"},"annotationId":{"type":"string","format":"uuid"}}},"CommentDTO":{"type":"object","properties":{"createdBy":{"type":"string"},"createdByDetails":{"$ref":"#/components/schemas/IdamDetails"},"lastModifiedByDetails":{"$ref":"#/components/schemas/IdamDetails"},"createdDate":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedDate":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"content":{"type":"string","maxLength":5000,"minLength":0},"annotationId":{"type":"string","format":"uuid"}}},"BookmarkDTO":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":30,"minLength":1},"documentId":{"type":"string","format":"uuid"},"createdBy":{"type":"string","maxLength":50,"minLength":0},"pageNumber":{"type":"integer","format":"int32","minimum":0},"getxCoordinate":{"type":"number","format":"double"},"getyCoordinate":{"type":"number","format":"double"},"parent":{"type":"string","format":"uuid"},"previous":{"type":"string","format":"uuid"}}},"AnnotationDTO":{"type":"object","properties":{"createdBy":{"type":"string"},"createdByDetails":{"$ref":"#/components/schemas/IdamDetails"},"lastModifiedByDetails":{"$ref":"#/components/schemas/IdamDetails"},"createdDate":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedDate":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"page":{"type":"integer","format":"int32","minimum":0},"color":{"type":"string"},"annotationSetId":{"type":"string","format":"uuid"},"comments":{"type":"array","items":{"$ref":"#/components/schemas/CommentDTO"},"uniqueItems":true},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagDTO"},"uniqueItems":true},"rectangles":{"type":"array","items":{"$ref":"#/components/schemas/RectangleDTO"},"uniqueItems":true},"documentId":{"type":"string"},"caseId":{"type":"string"},"jurisdiction":{"type":"string"},"commentHeader":{"type":"string"},"type":{"type":"string"}}},"TagDTO":{"type":"object","properties":{"name":{"type":"string","maxLength":35,"minLength":0},"createdBy":{"type":"string"},"label":{"type":"string","maxLength":20,"minLength":0},"color":{"type":"string"}}},"AnnotationSetDTO":{"type":"object","properties":{"createdBy":{"type":"string"},"createdByDetails":{"$ref":"#/components/schemas/IdamDetails"},"lastModifiedByDetails":{"$ref":"#/components/schemas/IdamDetails"},"createdDate":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedDate":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"documentId":{"type":"string"},"annotations":{"type":"array","items":{"$ref":"#/components/schemas/AnnotationDTO"},"uniqueItems":true}}},"MetadataDto":{"type":"object","properties":{"rotationAngle":{"type":"integer","format":"int32"},"documentId":{"type":"string","format":"uuid"}},"required":["documentId","rotationAngle"]},"Pageable":{"type":"object","properties":{"page":{"type":"integer","format":"int32","minimum":0},"size":{"type":"integer","format":"int32","minimum":1},"sort":{"type":"array","items":{"type":"string"}}}},"DeleteBookmarkDTO":{"type":"object","properties":{"updated":{"$ref":"#/components/schemas/BookmarkDTO"},"deleted":{"type":"array","items":{"type":"string","format":"uuid"}}}}}}}