bugfix: explicitly set nullability of a parameter is now considered as well (no actual behavioral changes, all the changed endpoint parameters were optional so nullable by default, now they are explicitly nullable as well)

Author: eceltov

app/V1Module/presenters/AsyncJobsPresenter.php

@@ -104,12 +104,14 @@ public function checkList()
         new VInt(),
         "Maximal time since completion (in seconds), null = only pending operations",
         required: false,
+        nullable: true,
     )]
     #[Query(
         "includeScheduled",
         new VBool(),
         "If true, pending scheduled events will be listed as well",
         required: false,
+        nullable: true,
     )]
     public function actionList(?int $ageThreshold, ?bool $includeScheduled)
     {

app/V1Module/presenters/ExercisesPresenter.php

@@ -199,19 +199,21 @@ public function checkDefault()
      * @GET
      */
     #[Query("offset", new VInt(), "Index of the first result.", required: false)]
-    #[Query("limit", new VInt(), "Maximal number of results returned.", required: false)]
+    #[Query("limit", new VInt(), "Maximal number of results returned.", required: false, nullable: true)]
     #[Query(
         "orderBy",
         new VString(),
         "Name of the column (column concept). The '!' prefix indicate descending order.",
         required: false,
+        nullable: true,
     )]
-    #[Query("filters", new VArray(), "Named filters that prune the result.", required: false)]
+    #[Query("filters", new VArray(), "Named filters that prune the result.", required: false, nullable: true)]
     #[Query(
         "locale",
         new VString(),
         "Currently set locale (used to augment order by clause if necessary),",
         required: false,
+        nullable: true,
     )]
     public function actionDefault(
         int $offset = 0,
@@ -263,7 +265,13 @@ public function checkAuthors()
      * @GET
      */
     #[Query("instanceId", new VString(), "Id of an instance from which the authors are listed.", required: false)]
-    #[Query("groupId", new VString(), "A group where the relevant exercises can be seen (assigned).", required: false)]
+    #[Query(
+        "groupId",
+        new VString(),
+        "A group where the relevant exercises can be seen (assigned).",
+        required: false,
+        nullable: true,
+    )]
     public function actionAuthors(string $instanceId = null, string $groupId = null)
     {
         $authors = $this->exercises->getAuthors($instanceId, $groupId, $this->groups);

app/V1Module/presenters/GroupsPresenter.php

@@ -184,7 +184,7 @@ class GroupsPresenter extends BasePresenter
      * Get a list of all non-archived groups a user can see. The return set is filtered by parameters.
      * @GET
      */
-    #[Query("instanceId", new VString(), "Only groups of this instance are returned.", required: false)]
+    #[Query("instanceId", new VString(), "Only groups of this instance are returned.", required: false, nullable: true)]
     #[Query(
         "ancestors",
         new VBool(),
@@ -196,6 +196,7 @@ class GroupsPresenter extends BasePresenter
         new VString(),
         "Search string. Only groups containing this string as a substring of their names are returned.",
         required: false,
+        nullable: true,
     )]
     #[Query("archived", new VBool(), "Include also archived groups in the result.", required: false)]
     #[Query(

app/V1Module/presenters/PipelinesPresenter.php

@@ -156,19 +156,21 @@ public function checkDefault(string $search = null)
      * @GET
      */
     #[Query("offset", new VInt(), "Index of the first result.", required: false)]
-    #[Query("limit", new VInt(), "Maximal number of results returned.", required: false)]
+    #[Query("limit", new VInt(), "Maximal number of results returned.", required: false, nullable: true)]
     #[Query(
         "orderBy",
         new VString(),
         "Name of the column (column concept). The '!' prefix indicate descending order.",
         required: false,
+        nullable: true,
     )]
-    #[Query("filters", new VArray(), "Named filters that prune the result.", required: false)]
+    #[Query("filters", new VArray(), "Named filters that prune the result.", required: false, nullable: true)]
     #[Query(
         "locale",
         new VString(),
         "Currently set locale (used to augment order by clause if necessary),",
         required: false,
+        nullable: true,
     )]
     public function actionDefault(
         int $offset = 0,

app/V1Module/presenters/SubmitPresenter.php

@@ -224,7 +224,7 @@ public function checkCanSubmit(string $id, string $userId = null)
      * @throws NotFoundException
      */
     #[Path("id", new VString(), "Identifier of the assignment", required: true)]
-    #[Query("userId", new VString(), "Identification of the user", required: false)]
+    #[Query("userId", new VString(), "Identification of the user", required: false, nullable: true)]
     public function actionCanSubmit(string $id, string $userId = null)
     {
         $assignment = $this->assignments->findOrThrow($id);
@@ -452,7 +452,7 @@ public function checkPreSubmit(string $id, string $userId = null)
      */
     #[Post("files", new VArray())]
     #[Path("id", new VString(), "identifier of assignment", required: true)]
-    #[Query("userId", new VString(), "Identifier of the submission author", required: false)]
+    #[Query("userId", new VString(), "Identifier of the submission author", required: false, nullable: true)]
     public function actionPreSubmit(string $id, string $userId = null)
     {
         $assignment = $this->assignments->findOrThrow($id);

app/V1Module/presenters/UsersPresenter.php

@@ -125,19 +125,21 @@ public function checkDefault()
      * @GET
      */
     #[Query("offset", new VInt(), "Index of the first result.", required: false)]
-    #[Query("limit", new VInt(), "Maximal number of results returned.", required: false)]
+    #[Query("limit", new VInt(), "Maximal number of results returned.", required: false, nullable: true)]
     #[Query(
         "orderBy",
         new VString(),
         "Name of the column (column concept). The '!' prefix indicate descending order.",
         required: false,
+        nullable: true,
     )]
-    #[Query("filters", new VArray(), "Named filters that prune the result.", required: false)]
+    #[Query("filters", new VArray(), "Named filters that prune the result.", required: false, nullable: true)]
     #[Query(
         "locale",
         new VString(),
         "Currently set locale (used to augment order by clause if necessary),",
         required: false,
+        nullable: true,
     )]
     public function actionDefault(
         int $offset = 0,

app/helpers/MetaFormats/AnnotationConversion/NetteAnnotationConverter.php

@@ -231,13 +231,18 @@ public static function convertRegexCapturesToParenthesesBuilder(array $annotatio
         }
         $validation = $annotationParameters["validation"];
 
-        // check nullability
+        // check nullability, it is either in the validation string, or set explicitly
         // validation strings contain the 'null' qualifier always at the end of the string.
         $nullabilitySuffix = "|null";
         if (str_ends_with($validation, $nullabilitySuffix)) {
             // remove the '|null'
             $validation = substr($validation, 0, -strlen($nullabilitySuffix));
             $nullable = true;
+        // check for explicit nullability
+        } elseif (array_key_exists("nullable", $annotationParameters)) {
+            // if it is explicitly not nullable but at the same time has to be nullable due to another factor,
+            // make it nullable (the other factor can be missing validation)
+            $nullable |= $annotationParameters["nullable"] === "true";
         }
 
         // this will always produce a single validator (the annotations do not contain multiple validation fields)