Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 5 |
|
0.00% |
0 / 1 |
CRAP | |
0.00% |
0 / 1 |
| tao_actions_RestVersion | |
0.00% |
0 / 5 |
|
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 1 |
| index | |
0.00% |
0 / 5 |
|
0.00% |
0 / 1 |
6 | |||
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * This program is free software; you can redistribute it and/or |
| 5 | * modify it under the terms of the GNU General Public License |
| 6 | * as published by the Free Software Foundation; under version 2 |
| 7 | * of the License (non-upgradable). |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
| 15 | * along with this program; if not, write to the Free Software |
| 16 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 17 | * |
| 18 | * Copyright (c) 2019 (original work) Open Assessment Technologies SA; |
| 19 | */ |
| 20 | |
| 21 | /** |
| 22 | * Class tao_actions_RestVersion |
| 23 | * @author Mikhail Kamarouski, <mikhail.kamarouski@1pt.com> |
| 24 | * @OA\Info( |
| 25 | * title="Provides platform version information", |
| 26 | * version="0.1.0", |
| 27 | * @OA\License(name="GPL-2.0-only") |
| 28 | * ) |
| 29 | */ |
| 30 | class tao_actions_RestVersion extends tao_actions_RestClass |
| 31 | { |
| 32 | /** |
| 33 | * @OA\Get( |
| 34 | * path="/tao/RestVersion", |
| 35 | * operationId="getVersion", |
| 36 | * tags={"platform"}, |
| 37 | * @OA\Response( |
| 38 | * response="200", |
| 39 | * description="Returns current platform version", |
| 40 | * |
| 41 | * @OA\MediaType( |
| 42 | * mediaType="application/json", |
| 43 | * @OA\Schema( |
| 44 | * example={ |
| 45 | * "version": "3.3.0-sprint97", |
| 46 | * } |
| 47 | * ) |
| 48 | * ), |
| 49 | * ), |
| 50 | * ) |
| 51 | */ |
| 52 | public function index() |
| 53 | { |
| 54 | if ($this->getRequest()->isGet()) { |
| 55 | return $this->returnJson([ |
| 56 | 'version' => TAO_VERSION |
| 57 | ]); |
| 58 | } |
| 59 | throw new common_exception_RestApi(); |
| 60 | } |
| 61 | } |