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 some openapi descriptions

Browse Source
This commit is contained in:
eikek 2021-07-17 18:01:18 +02:00
parent 88496e792a
commit eeebe750f9
1 changed files with 54 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -70,7 +70,7 @@ paths:
get: get:
operationId: "open-checkfile-checksum-by-id" operationId: "open-checkfile-checksum-by-id"
tags: [ Upload ] tags: [ Upload ]
summary: Check if a file is in docspell. summary: Check if a file is in docspell (via source).
description: | description: |
Checks if a file with the given SHA-256 checksum is in Checks if a file with the given SHA-256 checksum is in
docspell. The id is a *source id* configured by a collective. docspell. The id is a *source id* configured by a collective.
@ -91,7 +91,7 @@ paths:
post: post:
operationId: "open-upload-new-item-by-source" operationId: "open-upload-new-item-by-source"
tags: [ Upload ] tags: [ Upload ]
summary: Upload files to docspell. summary: Upload files to docspell (via source).
description: | description: |
Upload a file to docspell for processing. The id is a *source Upload a file to docspell for processing. The id is a *source
id* configured by a collective. Files are submitted for id* configured by a collective. Files are submitted for
@ -134,7 +134,7 @@ paths:
post: post:
operationId: "open-upload-to-item-by-source" operationId: "open-upload-to-item-by-source"
tags: [ Upload ] tags: [ Upload ]
summary: Upload files to docspell. summary: Upload files to an existing item (via source).
description: | description: |
Upload a file to docspell for processing. The id is a *source Upload a file to docspell for processing. The id is a *source
id* configured by a collective. Files are submitted for id* configured by a collective. Files are submitted for
@ -219,7 +219,7 @@ paths:
get: get:
operationId: "sec-checkfile-by-checksum" operationId: "sec-checkfile-by-checksum"
tags: [ Upload ] tags: [ Upload ]
summary: Check if a file is in docspell. summary: Check if a file is in docspell (authenticated).
description: | description: |
Checks if a file with the given SHA-256 checksum is in Checks if a file with the given SHA-256 checksum is in
docspell. docspell.
@ -241,7 +241,7 @@ paths:
post: post:
operationId: "sec-upload-new-item" operationId: "sec-upload-new-item"
tags: [ Upload ] tags: [ Upload ]
summary: Upload files to docspell. summary: Upload files to docspell (authenticated).
description: | description: |
Upload files to docspell for processing. This route is meant Upload files to docspell for processing. This route is meant
for authenticated users that upload files to their account. for authenticated users that upload files to their account.
@ -283,7 +283,7 @@ paths:
post: post:
operationId: "sec-upload-to-item" operationId: "sec-upload-to-item"
tags: [ Upload ] tags: [ Upload ]
summary: Upload files to docspell. summary: Upload files to an existing item (authenticated).
description: | description: |
Upload files to docspell for processing. This route is meant Upload files to docspell for processing. This route is meant
for authenticated users that upload files to their account. for authenticated users that upload files to their account.
@ -354,8 +354,8 @@ paths:
description: Unauthorized description: Unauthorized
post: post:
operationId: "open-integration-item-upload" operationId: "open-integration-item-upload"
tags: [ Integration Endpoint ] tags: [ Integration Endpoint, Upload ]
summary: Upload files to docspell. summary: Upload files to docspell (Integration Endpoint).
description: | description: |
Upload a file to docspell for processing. The id is a Upload a file to docspell for processing. The id is a
*collective name*. This route only exists, if enabled by an *collective name*. This route only exists, if enabled by an
@ -400,8 +400,8 @@ paths:
/open/integration/checkfile/{id}/{checksum}: /open/integration/checkfile/{id}/{checksum}:
get: get:
operationId: "open-integration-checkfile-by-checksum" operationId: "open-integration-checkfile-by-checksum"
tags: [ Integration Endpoint ] tags: [ Integration Endpoint, Upload ]
summary: Check if a file is in docspell. summary: Check if a file is in docspell (Integration Endpoint).
description: | description: |
Checks if a file with the given SHA-256 checksum is in Checks if a file with the given SHA-256 checksum is in
docspell. The `id` is the *collective name*. This route only docspell. The `id` is the *collective name*. This route only
@ -2716,7 +2716,7 @@ paths:
head: head:
operationId: "sec-attach-check" operationId: "sec-attach-check"
tags: [ Attachment ] tags: [ Attachment ]
summary: Get an attachment file. summary: Get headers to an attachment file.
description: | description: |
Get information about the binary file belonging to the Get information about the binary file belonging to the
attachment with the given id. attachment with the given id.
@ -2747,7 +2747,8 @@ paths:
summary: Get an attachment file. summary: Get an attachment file.
description: | description: |
Get the binary file belonging to the attachment with the given Get the binary file belonging to the attachment with the given
id. id. The binary is a pdf file. If conversion failed, then the
original file is returned.
security: security:
- authTokenHeader: [] - authTokenHeader: []
parameters: parameters:
@ -2951,15 +2952,17 @@ paths:
get: get:
operationId: "sec-attach-show-viewerjs" operationId: "sec-attach-show-viewerjs"
tags: [ Attachment ] tags: [ Attachment ]
summary: A preview of the attachment summary: A javascript rendered view of the pdf attachment
description: | description: |
This provides a preview of the attachment. It currently uses a This provides a preview of the attachment rendered in a
third-party javascript library (viewerjs) to display the browser.
preview. This works by redirecting to the viewerjs url with
the attachment url as parameter. Note that the resulting url It currently uses a third-party javascript library (viewerjs)
that is redirected to is not stable. It may change from to display the preview. This works by redirecting to the
version to version. This route, however, is meant to provide a viewerjs url with the attachment url as parameter. Note that
stable url for the preview. the resulting url that is redirected to is not stable. It may
change from version to version. This route, however, is meant
to provide a stable url for the preview.
security: security:
- authTokenHeader: [] - authTokenHeader: []
parameters: parameters:
@ -5067,50 +5070,60 @@ components:
specified, you have to specifiy whether the corresponding specified, you have to specifiy whether the corresponding
files should become one single item or if an item is created files should become one single item or if an item is created
for each file. for each file.
A direction can be given, `Incoming` is used if not specified.
A folderId can be given, the item is placed into this folder
after creation.
The `fileFilter` is an optional glob for filtering files to
import. Only applicable if archive files are uploaded. It
applies to all of them. For example, to only import pdf files
when uploading e-mails, use `*.pdf`. If the pattern doesn't
contain a slash `/`, then it is applied to all file names.
Otherwise it is applied to the complete path in the archive
(useful for zip files). Note that the archive file itself is
always saved completely, too.
The `tags` input allows to provide tags that should be applied
to the item being created. This only works if the tags already
exist. It is possible to specify their ids or names.
The `language` of the document may be specified, otherwise the
one from settings is used.
required: required:
- multiple - multiple
properties: properties:
multiple: multiple:
type: boolean type: boolean
default: true default: true
description: |
If `true` (the default) each file in the upload request
results in a separate item. If it is set to `false`, then
all files in the request are put into a single item.
direction: direction:
type: string type: string
format: direction format: direction
default: "incoming"
description: |
The direction of the item, can be `Incoming` or `Outgoing`.
folder: folder:
type: string type: string
format: ident format: ident
description: |
A folder can be specified that is attached to the new
item. The folder must exist.
skipDuplicates: skipDuplicates:
type: boolean type: boolean
default: false default: false
description: |
If set to `true` the processing will look for the same
file in Docspell and will skip processing this one if one
is found. The check is done via the file's checksum.
tags: tags:
$ref: "#/components/schemas/StringList" $ref: "#/components/schemas/StringList"
description: |
The `tags` input allows to provide tags that should be
applied to the item being created. This only works if the
tags already exist. It is possible to specify their ids or
names.
fileFilter: fileFilter:
type: string type: string
format: glob format: glob
description: |
The `fileFilter` is an optional glob for filtering files
to import. Only applicable if archive files are uploaded.
It applies to all of them. For example, to only import pdf
files when uploading e-mails, use `*.pdf`. If the pattern
doesn't contain a slash `/`, then it is applied to all
file names. Otherwise it is applied to the complete path
in the archive (useful for zip files). Note that the
archive file itself is always saved completely, too.
language: language:
type: string type: string
format: language format: language
description: |
The `language` of the document may be specified, otherwise
the one from settings is used.
Collective: Collective:
description: | description: |