From c6dcf6d7bddf2ca2e6552eca6bc600b99ff7c93e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= <sybren@blender.org>
Date: Thu, 6 Jul 2023 12:18:26 +0200
Subject: [PATCH] OAPI: better reporting of version info

Make it explicit that the `version` property is for human consumption.
Also add a new `git` property so that all info from `version` is also
included in separate fields for machine consumption.
---
 pkg/api/flamenco-openapi.yaml | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/pkg/api/flamenco-openapi.yaml b/pkg/api/flamenco-openapi.yaml
index 474fd18c..5363fbf1 100644
--- a/pkg/api/flamenco-openapi.yaml
+++ b/pkg/api/flamenco-openapi.yaml
@@ -1334,14 +1334,21 @@ components:
     FlamencoVersion:
       type: object
       properties:
-        "version": { type: string }
+        "version":
+          type: string
+          description: >
+            Version of this Manager, meant for human consumption. For release
+            builds it is the same as `shortversion`, for other builds it also
+            includes the `git` version info.
         "shortversion": { type: string }
         "name": { type: string }
-      required: [version, shortversion, name]
+        "git": { type: string }
+      required: [version, shortversion, name, git]
       example:
-        version: 3.0-beta1-56-g4761e3d7-dirty
-        shortversion: 3.0-beta1
+        version: "3.3-alpha0 (v3.2-76-gdd34d538)"
+        shortversion: 3.3-alpha0
         name: Your Manager
+        git: v3.2-76-gdd34d538
 
     ManagerConfiguration:
       type: object