mirror of
https://github.com/TheAnachronism/docspell.git
synced 2025-06-06 15:15:58 +00:00
Merge pull request #156 from scala-steward/update/sbt-openapi-schema-0.6.1
Update sbt-openapi-schema to 0.6.1
This commit is contained in:
commit
90f5d15010
@ -11,19 +11,20 @@ servers:
|
|||||||
paths:
|
paths:
|
||||||
/api/info:
|
/api/info:
|
||||||
get:
|
get:
|
||||||
tag: [ Api Info ]
|
tags: [ Api Info ]
|
||||||
summary: Get basic information about this software.
|
summary: Get basic information about this software.
|
||||||
description: |
|
description: |
|
||||||
Returns the version and project name and other properties of the build.
|
Returns the version and project name and other properties of the build.
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
|
description: Ok
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/VersionInfo"
|
$ref: "#/components/schemas/VersionInfo"
|
||||||
/api/v1/notify:
|
/api/v1/notify:
|
||||||
post:
|
post:
|
||||||
tag: [ Job Executor ]
|
tags: [ Job Executor ]
|
||||||
summary: Notify the job executor.
|
summary: Notify the job executor.
|
||||||
description: |
|
description: |
|
||||||
Notifies the job executor to wake up and look for jobs in th queue.
|
Notifies the job executor to wake up and look for jobs in th queue.
|
||||||
@ -36,7 +37,7 @@ paths:
|
|||||||
$ref: "#/components/schemas/BasicResult"
|
$ref: "#/components/schemas/BasicResult"
|
||||||
/api/v1/running:
|
/api/v1/running:
|
||||||
get:
|
get:
|
||||||
tag: [ Job Executor ]
|
tags: [ Job Executor ]
|
||||||
summary: Get a list of currently executing jobs.
|
summary: Get a list of currently executing jobs.
|
||||||
description: |
|
description: |
|
||||||
Returns all jobs this executor is currently executing.
|
Returns all jobs this executor is currently executing.
|
||||||
@ -49,7 +50,7 @@ paths:
|
|||||||
$ref: "#/components/schemas/JobList"
|
$ref: "#/components/schemas/JobList"
|
||||||
/api/v1/shutdownAndExit:
|
/api/v1/shutdownAndExit:
|
||||||
post:
|
post:
|
||||||
tag: [ Job Executor ]
|
tags: [ Job Executor ]
|
||||||
summary: Stops this component and exits.
|
summary: Stops this component and exits.
|
||||||
description: |
|
description: |
|
||||||
Gracefully stops the scheduler and also stops the process.
|
Gracefully stops the scheduler and also stops the process.
|
||||||
@ -62,25 +63,29 @@ paths:
|
|||||||
$ref: "#/components/schemas/BasicResult"
|
$ref: "#/components/schemas/BasicResult"
|
||||||
/api/v1/job/{id}:
|
/api/v1/job/{id}:
|
||||||
get:
|
get:
|
||||||
tag: [ Current Jobs ]
|
tags: [ Current Jobs ]
|
||||||
summary: Get a job by its id.
|
summary: Get a job by its id.
|
||||||
description: |
|
description: |
|
||||||
Returns details about a job given the id.
|
Returns details about a job given the id.
|
||||||
|
parameters:
|
||||||
|
- $ref: "#/components/parameters/id"
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: Ok
|
description: Ok
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/JobAndLogs"
|
$ref: "#/components/schemas/JobAndLog"
|
||||||
/api/v1/job/{id}/cancel:
|
/api/v1/job/{id}/cancel:
|
||||||
post:
|
post:
|
||||||
tag: [ Current Jobs ]
|
tags: [ Current Jobs ]
|
||||||
summary: Request to cancel a running job.
|
summary: Request to cancel a running job.
|
||||||
description: |
|
description: |
|
||||||
Requests to cancel the running job. This will try to cancel
|
Requests to cancel the running job. This will try to cancel
|
||||||
the execution but it is not guaranteed that it can immediately
|
the execution but it is not guaranteed that it can immediately
|
||||||
abort. The job is then removed from the queue.
|
abort. The job is then removed from the queue.
|
||||||
|
parameters:
|
||||||
|
- $ref: "#/components/parameters/id"
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: Ok
|
description: Ok
|
||||||
@ -197,3 +202,11 @@ components:
|
|||||||
type: boolean
|
type: boolean
|
||||||
message:
|
message:
|
||||||
type: string
|
type: string
|
||||||
|
parameters:
|
||||||
|
id:
|
||||||
|
name: id
|
||||||
|
in: path
|
||||||
|
description: An identifier
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
addSbtPlugin("com.47deg" % "sbt-microsites" % "1.2.1")
|
addSbtPlugin("com.47deg" % "sbt-microsites" % "1.2.1")
|
||||||
addSbtPlugin("com.eed3si9n" % "sbt-buildinfo" % "0.9.0")
|
addSbtPlugin("com.eed3si9n" % "sbt-buildinfo" % "0.9.0")
|
||||||
addSbtPlugin("com.github.eikek" % "sbt-openapi-schema" % "0.6.0")
|
addSbtPlugin("com.github.eikek" % "sbt-openapi-schema" % "0.6.1")
|
||||||
addSbtPlugin("com.github.gseitz" % "sbt-release" % "1.0.13")
|
addSbtPlugin("com.github.gseitz" % "sbt-release" % "1.0.13")
|
||||||
addSbtPlugin("com.jsuereth" % "sbt-pgp" % "2.0.1")
|
addSbtPlugin("com.jsuereth" % "sbt-pgp" % "2.0.1")
|
||||||
addSbtPlugin("com.typesafe.sbt" % "sbt-git" % "1.0.0")
|
addSbtPlugin("com.typesafe.sbt" % "sbt-git" % "1.0.0")
|
||||||
|
Loading…
x
Reference in New Issue
Block a user