OAPI: add sections to OpenAPI paths

This just makes the grouping a bit more obvious. It follows the already
available tags.
This commit is contained in:
Sybren A. Stüvel 2022-04-15 15:11:29 +02:00
parent de3c4af8cb
commit 70584ce951

View File

@ -12,6 +12,8 @@ info:
servers: servers:
- url: / - url: /
paths: paths:
## Meta
/api/version: /api/version:
summary: Clients can use this to check this is actually a Flamenco server. summary: Clients can use this to check this is actually a Flamenco server.
get: get:
@ -39,6 +41,8 @@ paths:
application/json: application/json:
schema: {$ref: "#/components/schemas/ManagerConfiguration"} schema: {$ref: "#/components/schemas/ManagerConfiguration"}
## Worker
/api/worker/register-worker: /api/worker/register-worker:
summary: Registration of new workers summary: Registration of new workers
post: post:
@ -217,6 +221,8 @@ paths:
schema: schema:
$ref: '#/components/schemas/Error' $ref: '#/components/schemas/Error'
## Jobs
/api/jobs/types: /api/jobs/types:
summary: Available Flamenco job types. summary: Available Flamenco job types.
get: get:
@ -280,7 +286,6 @@ paths:
application/json: application/json:
schema: {$ref: "#/components/schemas/Error"} schema: {$ref: "#/components/schemas/Error"}
/api/jobs/{job_id}: /api/jobs/{job_id}:
summary: Job info and management summary: Job info and management
get: get:
@ -299,6 +304,8 @@ paths:
application/json: application/json:
schema: {$ref: "#/components/schemas/Job"} schema: {$ref: "#/components/schemas/Job"}
## Shaman
/shaman/checkout/requirements: /shaman/checkout/requirements:
summary: Allows a client to check which files are available on the server, and which ones are still unknown. summary: Allows a client to check which files are available on the server, and which ones are still unknown.
post: post: