TheAnachronism/docspell
1
0
Fork 0
mirror of https://github.com/TheAnachronism/docspell.git synced 2025-06-06 15:15:58 +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
parent 42edfe39c2
commit 280968355e
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

@ -2766,7 +2766,7 @@ paths:
head: head:
operationId: "sec-attach-check-original" operationId: "sec-attach-check-original"
tags: [ Attachment ] tags: [ Attachment ]
summary: Get an attachment file. summary: Get headers of the original file of an attachment.
description: | description: |
Get information about the original binary file of the Get information about the original binary file of the
attachment with the given id. attachment with the given id.
@ -2797,7 +2797,7 @@ paths:
get: get:
operationId: "sec-attach-get-original" operationId: "sec-attach-get-original"
tags: [ Attachment ] tags: [ Attachment ]
summary: Get an attachment file. summary: Get the original file of an attachment.
description: | description: |
Get the original binary file of the attachment with the given Get the original binary file of the attachment with the given
id. id.
@ -2820,7 +2820,7 @@ paths:
head: head:
operationId: "sec-attach-check-archive" operationId: "sec-attach-check-archive"
tags: [ Attachment ] tags: [ Attachment ]
summary: Get an attachment archive file. summary: Get headers of the archive file to an attachment.
description: | description: |
Get information about the archive that contains the attachment Get information about the archive that contains the attachment
with the given id. with the given id.
@ -2851,7 +2851,7 @@ paths:
get: get:
operationId: "sec-attach-get-archive" operationId: "sec-attach-get-archive"
tags: [ Attachment ] tags: [ Attachment ]
summary: Get an attachment archive file. summary: Get the archive file of an attachment.
description: | description: |
Get the archive file that was originally uploaded that Get the archive file that was originally uploaded that
contains the attachment with the given id. contains the attachment with the given id.
@ -2874,7 +2874,7 @@ paths:
head: head:
operationId: "sec-attach-check-preview" operationId: "sec-attach-check-preview"
tags: [ Attachment ] tags: [ Attachment ]
summary: Get a preview image of an attachment file. summary: Get the headers to a preview image of an attachment file.
description: | description: |
Checks if an image file showing a preview of the attachment is Checks if an image file showing a preview of the attachment is
available. If not available, a 404 is returned. available. If not available, a 404 is returned.
@ -5486,6 +5486,7 @@ components:
- date - date
- source - source
- tags - tags
- attachments
properties: properties:
id: id:
type: string type: string