mirror of
https://github.com/TheAnachronism/docspell.git
synced 2025-06-21 18:08:25 +00:00
Add api docs and cleanup
This commit is contained in:
@ -1213,6 +1213,33 @@ paths:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BasicResult"
|
||||
|
||||
/sec/item/convertallpdfs:
|
||||
post:
|
||||
tags: [ Item ]
|
||||
summary: Convert all non-converted pdfs.
|
||||
description: |
|
||||
Submits a job that will find all pdf files that have not been
|
||||
converted and converts them using the ocrmypdf tool (if
|
||||
enabled). This tool has been added in version 0.9.0 and so
|
||||
older files can be "migrated" this way, or maybe after
|
||||
enabling the tool.
|
||||
|
||||
The task finds all files of the current collective and submits
|
||||
task for each file to convert. These tasks are submitted with
|
||||
a low priority so that normal processing can still proceed.
|
||||
|
||||
The body of the request should be empty.
|
||||
security:
|
||||
- authTokenHeader: []
|
||||
responses:
|
||||
200:
|
||||
description: Ok
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BasicResult"
|
||||
|
||||
|
||||
/sec/item/search:
|
||||
post:
|
||||
tags: [ Item ]
|
||||
@ -1811,7 +1838,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/StringList"
|
||||
$ref: "#/components/schemas/IdList"
|
||||
responses:
|
||||
200:
|
||||
description: Ok
|
||||
@ -2629,6 +2656,17 @@ paths:
|
||||
|
||||
components:
|
||||
schemas:
|
||||
IdList:
|
||||
description:
|
||||
A list of identifiers.
|
||||
required:
|
||||
- ids
|
||||
properties:
|
||||
ids:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
format: ident
|
||||
StringList:
|
||||
description: |
|
||||
A simple list of strings.
|
||||
|
Reference in New Issue
Block a user