From 03a889345d6c032d62d7ed3a3441878d5a683304 Mon Sep 17 00:00:00 2001
From: Taylor Wiebe <taylorwiebe22@gmail.com>
Date: Sat, 18 Nov 2023 18:08:29 -0600
Subject: [PATCH] OAPI: add optional description to job types

This description will be shown as a tooltip in the job submission UI.
---
 pkg/api/flamenco-openapi.yaml | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/pkg/api/flamenco-openapi.yaml b/pkg/api/flamenco-openapi.yaml
index c0c8dc50..72f6a5dc 100644
--- a/pkg/api/flamenco-openapi.yaml
+++ b/pkg/api/flamenco-openapi.yaml
@@ -1719,6 +1719,9 @@ components:
       properties:
         "name": { type: string }
         "label": { type: string }
+        "description":
+          type: string
+          description: The description/tooltip shown in the user interface.
         "settings":
           type: array
           items: { $ref: "#/components/schemas/AvailableJobSetting" }