From cd304bcff7c05bdb600db7cef9c9a1d369748cf0 Mon Sep 17 00:00:00 2001
From: eikek <eikek@posteo.de>
Date: Wed, 14 Jul 2021 22:32:17 +0200
Subject: [PATCH] Improve doc string for some endpoints

---
 .../restapi/src/main/resources/docspell-openapi.yml   | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/modules/restapi/src/main/resources/docspell-openapi.yml b/modules/restapi/src/main/resources/docspell-openapi.yml
index 5a4a6a03..59d5fc66 100644
--- a/modules/restapi/src/main/resources/docspell-openapi.yml
+++ b/modules/restapi/src/main/resources/docspell-openapi.yml
@@ -2764,7 +2764,7 @@ paths:
     head:
       operationId: "sec-attach-check-original"
       tags: [ Attachment ]
-      summary: Get an attachment file.
+      summary: Get headers of the original file of an attachment.
       description: |
         Get information about the original binary file of the
         attachment with the given id.
@@ -2795,7 +2795,7 @@ paths:
     get:
       operationId: "sec-attach-get-original"
       tags: [ Attachment ]
-      summary: Get an attachment file.
+      summary: Get the original file of an attachment.
       description: |
         Get the original binary file of the attachment with the given
         id.
@@ -2818,7 +2818,7 @@ paths:
     head:
       operationId: "sec-attach-check-archive"
       tags: [ Attachment ]
-      summary: Get an attachment archive file.
+      summary: Get headers of the archive file to an attachment.
       description: |
         Get information about the archive that contains the attachment
         with the given id.
@@ -2849,7 +2849,7 @@ paths:
     get:
       operationId: "sec-attach-get-archive"
       tags: [ Attachment ]
-      summary: Get an attachment archive file.
+      summary: Get the archive file of an attachment.
       description: |
         Get the archive file that was originally uploaded that
         contains the attachment with the given id.
@@ -2872,7 +2872,7 @@ paths:
     head:
       operationId: "sec-attach-check-preview"
       tags: [ Attachment ]
-      summary: Get a preview image of an attachment file.
+      summary: Get the headers to a preview image of an attachment file.
       description: |
         Checks if an image file showing a preview of the attachment is
         available. If not available, a 404 is returned.
@@ -5484,6 +5484,7 @@ components:
         - date
         - source
         - tags
+        - attachments
       properties:
         id:
           type: string