apuc/guild
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add doc for tests

Browse Source
This commit is contained in:
iIronside
2023-10-10 15:06:01 +03:00
parent aae845aee7
commit 3e575dcf8b
8 changed files with 626 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

116
frontend/modules/api/controllers/UserQuestionnaireController.php
View File

@ -27,6 +27,34 @@ class UserQuestionnaireController extends ApiController
}
/**
* @OA\Get(path="/user-questionnaire/questionnaires-list",
* summary="Список тестов",
* description="Получение списка тестов",
* security={
* {"bearerAuth": {}}
* },
* tags={"Tests"},
* @OA\Parameter(
* name="user_id",
* in="query",
* required=true,
* @OA\Schema(
* type="integer",
* )
* ),
*
* @OA\Response(
* response=200,
* description="Возвращает массив объектов тест",
* @OA\MediaType(
* mediaType="application/json",
* @OA\Schema(ref="#/components/schemas/UserQuestionnaireArrExample"),
* ),
* ),
*
* ),
* )
*
* @throws NotFoundHttpException
*/
public function actionQuestionnairesList($user_id): array
@ -42,6 +70,32 @@ class UserQuestionnaireController extends ApiController
}
/**
* @OA\Get(path="/user-questionnaire/questionnaire-completed",
* summary="Проверка теста",
* description="Выполнения проверки теста",
* security={
* {"bearerAuth": {}}
* },
* tags={"Tests"},
* @OA\Parameter(
* name="user_questionnaire_uuid",
* in="query",
* required=true,
* @OA\Schema(
* type="string",
* )
* ),
* @OA\Response(
* response=200,
* description="Возвращает объект Запроса",
* @OA\MediaType(
* mediaType="application/json",
* @OA\Schema(ref="#/components/schemas/UserQuestionnaireExample"),
* ),
*
* ),
* )
*
* @throws NotFoundHttpException
* @throws ServerErrorHttpException
*/
@ -55,6 +109,37 @@ class UserQuestionnaireController extends ApiController
}
/**
* @OA\Get(path="/user-questionnaire/get-points-number",
* summary="Количество балов в тесте",
* description="Возвращает максимальное количество балов за тест",
* security={
* {"bearerAuth": {}}
* },
* tags={"Tests"},
* @OA\Parameter(
* name="user_questionnaire_uuid",
* in="query",
* required=true,
* @OA\Schema(
* type="string",
* )
* ),
* @OA\Response(
* response=200,
* description="Возвращает максимально возможное количество балов за тест",
* @OA\MediaType(
* mediaType="application/json",
* @OA\Schema(
* @OA\Property(
* property="sum_point",
* type="integer",
* example="61",
* ),
* ),
* ),
*
* ),
* )
* @throws ServerErrorHttpException
*/
public function actionGetPointsNumber($user_questionnaire_uuid)
@ -67,6 +152,37 @@ class UserQuestionnaireController extends ApiController
}
/**
* @OA\Get(path="/user-questionnaire/get-question-number",
* summary="Число вопросов в тесте",
* description="Возвращает число вопросов в тесте",
* security={
* {"bearerAuth": {}}
* },
* tags={"Tests"},
* @OA\Parameter(
* name="user_questionnaire_uuid",
* in="query",
* required=true,
* @OA\Schema(
* type="string",
* )
* ),
* @OA\Response(
* response=200,
* description="Возвращает число вопросов в тесте",
* @OA\MediaType(
* mediaType="application/json",
* @OA\Schema(
* @OA\Property(
* property="question_number",
* type="integer",
* example="61",
* ),
* ),
* ),
*
* ),
* )
* @throws ServerErrorHttpException
*/
public function actionGetQuestionNumber($user_questionnaire_uuid)