From 70584ce9514e4e2eabd93ab040d0cebbfc82ec4b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= Date: Fri, 15 Apr 2022 15:11:29 +0200 Subject: [PATCH] OAPI: add sections to OpenAPI paths This just makes the grouping a bit more obvious. It follows the already available tags. --- pkg/api/flamenco-manager.yaml | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/pkg/api/flamenco-manager.yaml b/pkg/api/flamenco-manager.yaml index 8d4c3c87..8dda143d 100644 --- a/pkg/api/flamenco-manager.yaml +++ b/pkg/api/flamenco-manager.yaml @@ -12,6 +12,8 @@ info: servers: - url: / paths: + ## Meta + /api/version: summary: Clients can use this to check this is actually a Flamenco server. get: @@ -39,6 +41,8 @@ paths: application/json: schema: {$ref: "#/components/schemas/ManagerConfiguration"} + ## Worker + /api/worker/register-worker: summary: Registration of new workers post: @@ -217,6 +221,8 @@ paths: schema: $ref: '#/components/schemas/Error' + ## Jobs + /api/jobs/types: summary: Available Flamenco job types. get: @@ -280,7 +286,6 @@ paths: application/json: schema: {$ref: "#/components/schemas/Error"} - /api/jobs/{job_id}: summary: Job info and management get: @@ -299,6 +304,8 @@ paths: application/json: schema: {$ref: "#/components/schemas/Job"} + ## Shaman + /shaman/checkout/requirements: summary: Allows a client to check which files are available on the server, and which ones are still unknown. post: