added descriptions to formats

Author: eceltov

app/helpers/MetaFormats/FormatDefinitions/GroupPrivateDataFormat.php

@@ -21,51 +21,51 @@ class GroupPrivateDataFormat extends MetaFormat
     #[FPost(new VArray(new VUuid()), "IDs of all users that have admin privileges to this group (including inherited)")]
     public array $admins;
 
-    #[FPost(new VArray(new VUuid()))]
+    #[FPost(new VArray(new VUuid()), "IDs of all group supervisors")]
     public array $supervisors;
 
-    #[FPost(new VArray(new VUuid()))]
+    #[FPost(new VArray(new VUuid()), "IDs of all group observers")]
     public array $observers;
 
-    #[FPost(new VArray(new VUuid()))]
+    #[FPost(new VArray(new VUuid()), "IDs of the students of this group")]
     public array $students;
 
-    #[FPost(new VUuid(), required: false)]
+    #[FPost(new VUuid(), "The instance ID of the group", required: false)]
     public string $instanceId;
 
-    #[FPost(new VBool())]
+    #[FPost(new VBool(), "Whether the group has a valid license")]
     public bool $hasValidLicence;
 
-    #[FPost(new VArray(new VUuid()))]
+    #[FPost(new VArray(new VUuid()), "IDs of all group assignments")]
     public array $assignments;
 
-    #[FPost(new VArray(new VUuid()))]
+    #[FPost(new VArray(new VUuid()), "IDs of all group shadow assignments")]
     public array $shadowAssignments;
 
-    #[FPost(new VBool())]
+    #[FPost(new VBool(), "Whether the group statistics are public")]
     public bool $publicStats;
 
-    #[FPost(new VBool())]
+    #[FPost(new VBool(), "Whether the group is detaining")]
     public bool $detaining;
 
-    #[FPost(new VDouble(), required: false)]
+    #[FPost(new VDouble(), "The group assignment point threshold", required: false)]
     public ?float $threshold;
 
-    #[FPost(new VInt(), required: false)]
+    #[FPost(new VInt(), "The group points limit", required: false)]
     public ?int $pointsLimit;
 
-    #[FPost(new VArray())]
+    #[FPost(new VArray(), "Entities bound to the group")]
     public array $bindings;
 
-    #[FPost(new VTimestamp(), required: false)]
+    #[FPost(new VTimestamp(), "The time when the exam starts if there is an exam", required: false)]
     public ?int $examBegin;
 
-    #[FPost(new VTimestamp(), required: false)]
+    #[FPost(new VTimestamp(), "The time when the exam ends if there is an exam", required: false)]
     public ?int $examEnd;
 
-    #[FPost(new VBool(), required: false)]
+    #[FPost(new VBool(), "Whether there is a strict exam lock", required: false)]
     public ?bool $examLockStrict;
 
-    #[FPost(new VArray())]
+    #[FPost(new VArray(), "All group exams")]
     public array $exams;
 }

app/helpers/MetaFormats/FormatDefinitions/SuccessResponseFormat.php

@@ -16,12 +16,12 @@
 #[Format(SuccessResponseFormat::class)]
 class SuccessResponseFormat extends MetaFormat
 {
-    #[FPost(new VBool())]
+    #[FPost(new VBool(), "Whether the request was processed successfully.")]
     public bool $success;
 
-    #[FPost(new VInt())]
+    #[FPost(new VInt(), "HTTP response code.")]
     public int $code;
 
-    #[FPost(new VMixed())]
+    #[FPost(new VMixed(), "The payload of the response.")]
     public mixed $payload;
 }