Meta views

app/V1Module/presenters/AssignmentSolutionReviewsPresenter.php

@@ -2,6 +2,19 @@
 
 namespace App\V1Module\Presenters;
 
+use App\Helpers\MetaFormats\Attributes\Post;
+use App\Helpers\MetaFormats\Attributes\Query;
+use App\Helpers\MetaFormats\Attributes\Path;
+use App\Helpers\MetaFormats\Type;
+use App\Helpers\MetaFormats\Validators\VArray;
+use App\Helpers\MetaFormats\Validators\VBool;
+use App\Helpers\MetaFormats\Validators\VDouble;
+use App\Helpers\MetaFormats\Validators\VEmail;
+use App\Helpers\MetaFormats\Validators\VInt;
+use App\Helpers\MetaFormats\Validators\VMixed;
+use App\Helpers\MetaFormats\Validators\VString;
+use App\Helpers\MetaFormats\Validators\VTimestamp;
+use App\Helpers\MetaFormats\Validators\VUuid;
 use App\Exceptions\BadRequestException;
 use App\Exceptions\InternalServerException;
 use App\Exceptions\InvalidArgumentException;
@@ -88,9 +101,9 @@ public function checkDefault(string $id)
     /**
      * Get detail of the solution and a list of review comments.
      * @GET
-     * @param string $id identifier of the solution
      * @throws InternalServerException
      */
+    #[Path("id", new VString(), "identifier of the solution", required: true)]
     public function actionDefault(string $id)
     {
         $solution = $this->assignmentSolutions->findOrThrow($id);
@@ -111,11 +124,10 @@ public function checkUpdate(string $id)
     /**
      * Update the state of the review process of the solution.
      * @POST
-     * @Param(type="post", name="close", validation="bool"
-     *        description="If true, the review is closed. If false, the review is (re)opened.")
-     * @param string $id identifier of the solution
      * @throws InternalServerException
      */
+    #[Post("close", new VBool(), "If true, the review is closed. If false, the review is (re)opened.")]
+    #[Path("id", new VString(), "identifier of the solution", required: true)]
     public function actionUpdate(string $id)
     {
         $solution = $this->assignmentSolutions->findOrThrow($id);
@@ -182,9 +194,9 @@ public function checkRemove(string $id)
     /**
      * Update the state of the review process of the solution.
      * @DELETE
-     * @param string $id identifier of the solution
      * @throws InternalServerException
      */
+    #[Path("id", new VString(), "identifier of the solution", required: true)]
     public function actionRemove(string $id)
     {
         $solution = $this->assignmentSolutions->findOrThrow($id);
@@ -251,18 +263,29 @@ private function verifyCodeLocation(AssignmentSolution $solution, string $file,
     /**
      * Create a new comment within a review.
      * @POST
-     * @Param(type="post", name="text", validation="string:1..65535", required=true, description="The comment itself.")
-     * @Param(type="post", name="file", validation="string:0..256", required=true,
-     *        description="Identification of the file to which the comment is related to.")
-     * @Param(type="post", name="line", validation="numericint", required=true,
-     *        description="Line in the designated file to which the comment is related to.")
-     * @Param(type="post", name="issue", validation="bool", required=false,
-     *        description="Whether the comment is an issue (expected to be resolved by the student)")
-     * @Param(type="post", name="suppressNotification", validation="bool", required=false,
-     *        description="If true, no email notification will be sent (only applies when the review has been closed)")
-     * @param string $id identifier of the solution
      * @throws InternalServerException
      */
+    #[Post("text", new VString(1, 65535), "The comment itself.", required: true)]
+    #[Post(
+        "file",
+        new VString(0, 256),
+        "Identification of the file to which the comment is related to.",
+        required: true,
+    )]
+    #[Post("line", new VInt(), "Line in the designated file to which the comment is related to.", required: true)]
+    #[Post(
+        "issue",
+        new VBool(),
+        "Whether the comment is an issue (expected to be resolved by the student)",
+        required: false,
+    )]
+    #[Post(
+        "suppressNotification",
+        new VBool(),
+        "If true, no email notification will be sent (only applies when the review has been closed)",
+        required: false,
+    )]
+    #[Path("id", new VString(), "identifier of the solution", required: true)]
     public function actionNewComment(string $id)
     {
         $solution = $this->assignmentSolutions->findOrThrow($id);
@@ -320,15 +343,23 @@ public function checkEditComment(string $id, string $commentId)
     /**
      * Update existing comment within a review.
      * @POST
-     * @Param(type="post", name="text", validation="string:1..65535", required=true, description="The comment itself.")
-     * @Param(type="post", name="issue", validation="bool", required=false,
-     *        description="Whether the comment is an issue (expected to be resolved by the student)")
-     * @Param(type="post", name="suppressNotification", validation="bool", required=false,
-     *        description="If true, no email notification will be sent (only applies when the review has been closed)")
-     * @param string $id identifier of the solution
-     * @param string $commentId identifier of the review comment
      * @throws InternalServerException
      */
+    #[Post("text", new VString(1, 65535), "The comment itself.", required: true)]
+    #[Post(
+        "issue",
+        new VBool(),
+        "Whether the comment is an issue (expected to be resolved by the student)",
+        required: false,
+    )]
+    #[Post(
+        "suppressNotification",
+        new VBool(),
+        "If true, no email notification will be sent (only applies when the review has been closed)",
+        required: false,
+    )]
+    #[Path("id", new VString(), "identifier of the solution", required: true)]
+    #[Path("commentId", new VString(), "identifier of the review comment", required: true)]
     public function actionEditComment(string $id, string $commentId)
     {
         $solution = $this->assignmentSolutions->findOrThrow($id);
@@ -386,9 +417,9 @@ public function checkDeleteComment(string $id, string $commentId)
     /**
      * Remove one comment from a review.
      * @DELETE
-     * @param string $id identifier of the solution
-     * @param string $commentId identifier of the review comment
      */
+    #[Path("id", new VString(), "identifier of the solution", required: true)]
+    #[Path("commentId", new VString(), "identifier of the review comment", required: true)]
     public function actionDeleteComment(string $id, string $commentId)
     {
         $comment = $this->reviewComments->findOrThrow($commentId);
@@ -422,8 +453,8 @@ public function checkPending(string $id)
      * Return all solutions with pending reviews that given user teaches (is admin/supervisor in corresponding groups).
      * Along with that it returns all assignment entities of the corresponding solutions.
      * @GET
-     * @param string $id of the user whose pending reviews are listed
      */
+    #[Path("id", new VString(), "of the user whose pending reviews are listed", required: true)]
     public function actionPending(string $id)
     {
         $user = $this->users->findOrThrow($id);

app/V1Module/presenters/AssignmentSolutionsPresenter.php

@@ -2,6 +2,19 @@
 
 namespace App\V1Module\Presenters;
 
+use App\Helpers\MetaFormats\Attributes\Post;
+use App\Helpers\MetaFormats\Attributes\Query;
+use App\Helpers\MetaFormats\Attributes\Path;
+use App\Helpers\MetaFormats\Type;
+use App\Helpers\MetaFormats\Validators\VArray;
+use App\Helpers\MetaFormats\Validators\VBool;
+use App\Helpers\MetaFormats\Validators\VDouble;
+use App\Helpers\MetaFormats\Validators\VEmail;
+use App\Helpers\MetaFormats\Validators\VInt;
+use App\Helpers\MetaFormats\Validators\VMixed;
+use App\Helpers\MetaFormats\Validators\VString;
+use App\Helpers\MetaFormats\Validators\VTimestamp;
+use App\Helpers\MetaFormats\Validators\VUuid;
 use App\Exceptions\BadRequestException;
 use App\Exceptions\InternalServerException;
 use App\Exceptions\InvalidArgumentException;
@@ -142,9 +155,9 @@ public function checkSolution(string $id)
     /**
      * Get information about solutions.
      * @GET
-     * @param string $id Identifier of the solution
      * @throws InternalServerException
      */
+    #[Path("id", new VString(), "Identifier of the solution", required: true)]
     public function actionSolution(string $id)
     {
         $solution = $this->assignmentSolutions->findOrThrow($id);
@@ -172,11 +185,11 @@ public function checkUpdateSolution(string $id)
     /**
      * Update details about the solution (note, etc...)
      * @POST
-     * @Param(type="post", name="note", validation="string:0..1024", description="A note by the author of the solution")
-     * @param string $id Identifier of the solution
      * @throws NotFoundException
      * @throws InternalServerException
      */
+    #[Post("note", new VString(0, 1024), "A note by the author of the solution")]
+    #[Path("id", new VString(), "Identifier of the solution", required: true)]
     public function actionUpdateSolution(string $id)
     {
         $req = $this->getRequest();
@@ -198,9 +211,9 @@ public function checkDeleteSolution(string $id)
     /**
      * Delete assignment solution with given identification.
      * @DELETE
-     * @param string $id identifier of assignment solution
      * @throws ForbiddenRequestException
      */
+    #[Path("id", new VString(), "identifier of assignment solution", required: true)]
     public function actionDeleteSolution(string $id)
     {
         $solution = $this->assignmentSolutions->findOrThrow($id);
@@ -236,8 +249,8 @@ public function checkSubmissions(string $id)
     /**
      * Get list of all submissions of a solution
      * @GET
-     * @param string $id Identifier of the solution
      */
+    #[Path("id", new VString(), "Identifier of the solution", required: true)]
     public function actionSubmissions(string $id)
     {
         $solution = $this->assignmentSolutions->findOrThrow($id);
@@ -271,10 +284,10 @@ public function checkSubmission(string $submissionId)
     /**
      * Get information about the evaluation of a submission
      * @GET
-     * @param string $submissionId Identifier of the submission
      * @throws NotFoundException
      * @throws InternalServerException
      */
+    #[Path("submissionId", new VString(), "Identifier of the submission", required: true)]
     public function actionSubmission(string $submissionId)
     {
         $submission = $this->assignmentSolutionSubmissions->findOrThrow($submissionId);
@@ -301,8 +314,8 @@ public function checkDeleteSubmission(string $submissionId)
     /**
      * Remove the submission permanently
      * @DELETE
-     * @param string $submissionId Identifier of the submission
      */
+    #[Path("submissionId", new VString(), "Identifier of the submission", required: true)]
     public function actionDeleteSubmission(string $submissionId)
     {
         $submission = $this->assignmentSolutionSubmissions->findOrThrow($submissionId);
@@ -327,15 +340,19 @@ public function checkSetBonusPoints(string $id)
      * Set new amount of bonus points for a solution (and optionally points override)
      * Returns array of solution entities that has been changed by this.
      * @POST
-     * @Param(type="post", name="bonusPoints", validation="numericint",
-     *        description="New amount of bonus points, can be negative number")
-     * @Param(type="post", name="overriddenPoints", required=false,
-     *        description="Overrides points assigned to solution by the system")
-     * @param string $id Identifier of the solution
      * @throws NotFoundException
      * @throws InvalidArgumentException
      * @throws InvalidStateException
      */
+    #[Post("bonusPoints", new VInt(), "New amount of bonus points, can be negative number")]
+    #[Post(
+        "overriddenPoints",
+        new VMixed(),
+        "Overrides points assigned to solution by the system",
+        required: false,
+        nullable: true,
+    )]
+    #[Path("id", new VString(), "Identifier of the solution", required: true)]
     public function actionSetBonusPoints(string $id)
     {
         $solution = $this->assignmentSolutions->findOrThrow($id);
@@ -423,14 +440,13 @@ public function checkSetFlag(string $id, string $flag)
     /**
      * Set flag of the assignment solution.
      * @POST
-     * @param string $id identifier of the solution
-     * @param string $flag name of the flag which should to be changed
-     * @Param(type="post", name="value", required=true, validation=boolean,
-     *        description="True or false which should be set to given flag name")
      * @throws NotFoundException
      * @throws \Nette\Application\AbortException
      * @throws \Exception
      */
+    #[Post("value", new VBool(), "True or false which should be set to given flag name", required: true)]
+    #[Path("id", new VString(), "identifier of the solution", required: true)]
+    #[Path("flag", new VString(), "name of the flag which should to be changed", required: true)]
     public function actionSetFlag(string $id, string $flag)
     {
         $req = $this->getRequest();
@@ -546,12 +562,12 @@ public function checkDownloadSolutionArchive(string $id)
     /**
      * Download archive containing all solution files for particular solution.
      * @GET
-     * @param string $id of assignment solution
      * @throws ForbiddenRequestException
      * @throws NotFoundException
      * @throws \Nette\Application\BadRequestException
      * @throws \Nette\Application\AbortException
      */
+    #[Path("id", new VString(), "of assignment solution", required: true)]
     public function actionDownloadSolutionArchive(string $id)
     {
         $solution = $this->assignmentSolutions->findOrThrow($id);
@@ -573,10 +589,10 @@ public function checkFiles(string $id)
     /**
      * Get the list of submitted files of the solution.
      * @GET
-     * @param string $id of assignment solution
      * @throws ForbiddenRequestException
      * @throws NotFoundException
      */
+    #[Path("id", new VString(), "of assignment solution", required: true)]
     public function actionFiles(string $id)
     {
         $solution = $this->assignmentSolutions->findOrThrow($id)->getSolution();
@@ -594,11 +610,11 @@ public function checkDownloadResultArchive(string $submissionId)
     /**
      * Download result archive from backend for particular submission.
      * @GET
-     * @param string $submissionId
      * @throws NotFoundException
      * @throws InternalServerException
      * @throws \Nette\Application\AbortException
      */
+    #[Path("submissionId", new VString(), required: true)]
     public function actionDownloadResultArchive(string $submissionId)
     {
         $submission = $this->assignmentSolutionSubmissions->findOrThrow($submissionId);
@@ -628,10 +644,10 @@ public function checkEvaluationScoreConfig(string $submissionId)
     /**
      * Get score configuration associated with given submission evaluation
      * @GET
-     * @param string $submissionId Identifier of the submission
      * @throws NotFoundException
      * @throws InternalServerException
      */
+    #[Path("submissionId", new VString(), "Identifier of the submission", required: true)]
     public function actionEvaluationScoreConfig(string $submissionId)
     {
         $submission = $this->assignmentSolutionSubmissions->findOrThrow($submissionId);
@@ -655,8 +671,8 @@ public function checkReviewRequests(string $id)
      * (is admin/supervisor in corresponding groups).
      * Along with that it returns all assignment entities of the corresponding solutions.
      * @GET
-     * @param string $id of the user whose solutions with requested reviews are listed
      */
+    #[Path("id", new VString(), "of the user whose solutions with requested reviews are listed", required: true)]
     public function actionReviewRequests(string $id)
     {
         $user = $this->users->findOrThrow($id);

app/V1Module/presenters/AssignmentSolversPresenter.php

@@ -2,6 +2,19 @@
 
 namespace App\V1Module\Presenters;
 
+use App\Helpers\MetaFormats\Attributes\Post;
+use App\Helpers\MetaFormats\Attributes\Query;
+use App\Helpers\MetaFormats\Attributes\Path;
+use App\Helpers\MetaFormats\Type;
+use App\Helpers\MetaFormats\Validators\VArray;
+use App\Helpers\MetaFormats\Validators\VBool;
+use App\Helpers\MetaFormats\Validators\VDouble;
+use App\Helpers\MetaFormats\Validators\VEmail;
+use App\Helpers\MetaFormats\Validators\VInt;
+use App\Helpers\MetaFormats\Validators\VMixed;
+use App\Helpers\MetaFormats\Validators\VString;
+use App\Helpers\MetaFormats\Validators\VTimestamp;
+use App\Helpers\MetaFormats\Validators\VUuid;
 use App\Exceptions\BadRequestException;
 use App\Model\Entity\AssignmentSolutionSubmission;
 use App\Model\Repository\Assignments;
@@ -92,11 +105,15 @@ public function checkDefault(?string $assignmentId, ?string $groupId, ?string $u
      * Get a list of assignment solvers based on given parameters (assignment/group and solver user).
      * Either assignment or group ID must be set (group is ignored if assignment is set), user ID is optional.
      * @GET
-     * @Param(type="query", name="assignmentId", required=false, validation="string:36")
-     * @Param(type="query", name="groupId", required=false, validation="string:36",
-     *        description="An alternative for assignment ID, selects all assignments from a group.")
-     * @Param(type="query", name="userId", required=false, validation="string:36")
      */
+    #[Query("assignmentId", new VUuid(), required: false)]
+    #[Query(
+        "groupId",
+        new VUuid(),
+        "An alternative for assignment ID, selects all assignments from a group.",
+        required: false,
+    )]
+    #[Query("userId", new VUuid(), required: false)]
     public function actionDefault(?string $assignmentId, ?string $groupId, ?string $userId): void
     {
         $user = $userId ? $this->users->findOrThrow($userId) : null;