From ada8c322dacbae1073460f80d96ebaaf0b4adab9 Mon Sep 17 00:00:00 2001
From: Quaternions <krakow20@gmail.com>
Date: Sat, 7 Jun 2025 17:07:47 -0700
Subject: [PATCH] openapi: add descriptions to enum fields

---
 openapi.yaml | 68 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 68 insertions(+)

diff --git a/openapi.yaml b/openapi.yaml
index 8b656e4..fa1736e 100644
--- a/openapi.yaml
+++ b/openapi.yaml
@@ -114,6 +114,13 @@ paths:
           format: int32
           minimum: 0
           maximum: 4
+        description: >
+          Sort order:
+          * `0` - Disabled
+          * `1` - DisplayNameAscending
+          * `2` - DisplayNameDescending
+          * `3` - DateAscending
+          * `4` - DateDescending
       responses:
         "200":
           description: Successful response
@@ -178,6 +185,11 @@ paths:
           format: int32
           minimum: 1
           maximum: 5
+        description: >
+          Game ID:
+          * `1` - Bhop
+          * `2` - Surf
+          * `5` - FlyTrials
       - name: Sort
         in: query
         schema:
@@ -185,6 +197,13 @@ paths:
           format: int32
           minimum: 0
           maximum: 4
+        description: >
+          Sort order:
+          * `0` - Disabled
+          * `1` - DisplayNameAscending
+          * `2` - DisplayNameDescending
+          * `3` - DateAscending
+          * `4` - DateDescending
       - name: Submitter
         in: query
         schema:
@@ -210,6 +229,24 @@ paths:
           format: int32
           minimum: 0
           maximum: 9
+        description: >
+          // Phase: Creation
+          * `0` - UnderConstruction
+          * `1` - ChangesRequested
+
+          // Phase: Review
+          * `2` - Submitting
+          * `3` - Submitted
+
+          // Phase: Testing
+          * `4` - AcceptedUnvalidated // pending script review, can re-trigger validation
+          * `5` - Validating
+          * `6` - Validated
+          * `7` - Uploading
+
+          // Phase: Final MapfixStatus
+          * `8` - Uploaded // uploaded to the group, but pending release
+          * `9` - Rejected
       responses:
         "200":
           description: Successful response
@@ -602,6 +639,11 @@ paths:
           format: int32
           minimum: 1
           maximum: 5
+        description: >
+          Game ID:
+          * `1` - Bhop
+          * `2` - Surf
+          * `5` - FlyTrials
       - name: Sort
         in: query
         schema:
@@ -609,6 +651,13 @@ paths:
           format: int32
           minimum: 0
           maximum: 4
+        description: >
+          Sort order:
+          * `0` - Disabled
+          * `1` - DisplayNameAscending
+          * `2` - DisplayNameDescending
+          * `3` - DateAscending
+          * `4` - DateDescending
       - name: Submitter
         in: query
         schema:
@@ -634,6 +683,25 @@ paths:
           format: int32
           minimum: 0
           maximum: 10
+        description: >
+          // Phase: Creation
+          * `0` - UnderConstruction
+          * `1` - ChangesRequested
+
+          // Phase: Review
+          * `2` - Submitting
+          * `3` - Submitted
+
+          // Phase: Testing
+          * `4` - AcceptedUnvalidated // pending script review, can re-trigger validation
+          * `5` - Validating
+          * `6` - Validated
+          * `7` - Uploading
+          * `8` - Uploaded // uploaded to the group, but pending release
+
+          // Phase: Final SubmissionStatus
+          * `9` - Rejected
+          * `10` - Released
       responses:
         "200":
           description: Successful response