TheAnachronism/docspell
1
0
Fork 0
mirror of https://github.com/TheAnachronism/docspell.git synced 2025-04-05 10:59:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve doc string for some endpoints

Browse Source
This commit is contained in:
eikek 2021-07-14 22:32:17 +02:00 committed by eikek
parent 207bb7138a
commit cd304bcff7
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
modules/restapi/src/main/resources/docspell-openapi.yml
View File

@ -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