Fix openapi linter warnings

This commit is contained in:
eikek 2021-06-12 19:12:52 +02:00
parent 1e685a9ea2
commit 8791326d6a
2 changed files with 232 additions and 34 deletions

View File

@ -3,6 +3,16 @@ openapi: 3.0.0
info: info:
title: Docspell JOEX title: Docspell JOEX
version: 0.24.0-SNAPSHOT version: 0.24.0-SNAPSHOT
description: |
This is the remote API to the job executor component of Docspell.
Docspell is a free document management system focused on small
groups or families.
The routes are not protected by the application. This api is meant
to be used by the server component of Docspell.
license:
name: GPLv3
url: https://spdx.org/licenses/GPL-3.0-or-later.html
servers: servers:
- url: /api/v1 - url: /api/v1
@ -11,6 +21,7 @@ servers:
paths: paths:
/api/info/version: /api/info/version:
get: get:
operationId: "info-version"
tags: [ Api Info ] tags: [ Api Info ]
summary: Get basic information about this software. summary: Get basic information about this software.
description: | description: |
@ -22,8 +33,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/VersionInfo" $ref: "#/components/schemas/VersionInfo"
/api/v1/notify: /notify:
post: post:
operationId: "v1-notify"
tags: [ Job Executor ] tags: [ Job Executor ]
summary: Notify the job executor. summary: Notify the job executor.
description: | description: |
@ -35,8 +47,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/BasicResult" $ref: "#/components/schemas/BasicResult"
/api/v1/running: /running:
get: get:
operationId: "v1-running"
tags: [ Job Executor ] tags: [ Job Executor ]
summary: Get a list of currently executing jobs. summary: Get a list of currently executing jobs.
description: | description: |
@ -48,8 +61,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/JobList" $ref: "#/components/schemas/JobList"
/api/v1/shutdownAndExit: /shutdownAndExit:
post: post:
operationId: "v1-shutdown-and-exit"
tags: [ Job Executor ] tags: [ Job Executor ]
summary: Stops this component and exits. summary: Stops this component and exits.
description: | description: |
@ -61,8 +75,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/BasicResult" $ref: "#/components/schemas/BasicResult"
/api/v1/job/{id}: /job/{id}:
get: get:
operationId: "v1-job-by-id"
tags: [ Current Jobs ] tags: [ Current Jobs ]
summary: Get a job by its id. summary: Get a job by its id.
description: | description: |
@ -76,8 +91,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/JobAndLog" $ref: "#/components/schemas/JobAndLog"
/api/v1/job/{id}/cancel: /job/{id}/cancel:
post: post:
operationId: "v1-job-cancel"
tags: [ Current Jobs ] tags: [ Current Jobs ]
summary: Request to cancel a running job. summary: Request to cancel a running job.
description: | description: |

File diff suppressed because it is too large Load Diff