Add doc for tests

2023-10-10 15:06:01 +03:00
parent aae845aee7
commit 3e575dcf8b
8 changed files with 626 additions and 0 deletions
--- a/frontend/modules/api/models/UserQuestionnaire.php
+++ b/frontend/modules/api/models/UserQuestionnaire.php
@ -0,0 +1,103 @@
+<?php
+
+namespace frontend\modules\api\models;
+
+
+/**
+ *
+ * @OA\Schema(
+ *  schema="UserQuestionnaire",
+ *  @OA\Property(
+ *     property="user_id",
+ *     type="int",
+ *     example=1,
+ *     description="Идентификатор пользователя"
+ *  ),
+ *  @OA\Property(
+ *     property="uuid",
+ *     type="string",
+ *     example="d222f858-60fd-47fb-8731-dc9d5fc384c5",
+ *     description="uuid"
+ *  ),
+ *  @OA\Property(
+ *     property="score",
+ *     type="int",
+ *     example="11",
+ *     description="Количество балов за тест"
+ *  ),
+ *  @OA\Property(
+ *     property="status",
+ *     type="int",
+ *     example="2",
+ *     description="статус файла"
+ *  ),
+ *  @OA\Property(
+ *     property="percent_correct_answers",
+ *     type="float",
+ *     example="0.25",
+ *     description="Процент правильных ответов"
+ *  ),
+ *  @OA\Property(
+ *     property="testing_date",
+ *     type="string",
+ *     example="2022-03-17 11:14:22",
+ *     description="Дата тестирования"
+ *  ),
+ *  @OA\Property(
+ *     property="questionnaire_title",
+ *     type="string",
+ *     example="Анкета 1",
+ *     description="Название анкеты"
+ *  ),
+ *)
+ *
+ * @OA\Schema(
+ *  schema="UserQuestionnaireExample",
+ *  type="array",
+ *  @OA\Items(
+ *      type="object",
+ *      ref="#/components/schemas/UserQuestionnaire",
+ *  ),
+ *)
+ *
+ * @OA\Schema(
+ *  schema="UserQuestionnaireArrExample",
+ *  type="array",
+ *  example={
+ *     {"uuid": "d222f858-60fd-47fb-8731-dc9d5fc384c5", "score": 11, "status": 2, "percent_correct_answers": 0.25, "testing_date": "2022-04-03 09:23:45", "questionnaire_title": "Тест 2"},
+ *     {"uuid": "gcjs77d9-vtyd-02jh-9467-dc8fbb6s6jdb", "score": 20, "status": 2, "percent_correct_answers": 0.85, "testing_date": "2022-03-17 11:14:22", "questionnaire_title": "Тест 1"},
+ *     },
+ *  @OA\Items(
+ *      type="object",
+ *      @OA\Property(
+ *         property="uuid",
+ *         type="string",
+ *      ),
+ *      @OA\Property(
+ *         property="score",
+ *         type="integer",
+ *      ),
+ *      @OA\Property(
+ *         property="status",
+ *         type="integer",
+ *      ),
+ *      @OA\Property(
+ *         property="percent_correct_answers",
+ *         type="float",
+ *      ),
+ *     @OA\Property(
+ *         property="testing_date",
+ *         type="string",
+ *      ),
+ *     @OA\Property(
+ *         property="questionnaire_title",
+ *         type="string",
+ *      ),
+ *  ),
+ *)
+ *
+ */
+class UserQuestionnaire extends \common\models\UserQuestionnaire
+{
+
+}