Инструменты пользователя

Инструменты сайта


ru:airlay:api:air-lay-v4

Различия

Показаны различия между двумя версиями страницы.

Ссылка на это сравнение

Предыдущая версия справа и слева Предыдущая версия
Следующая версия
Предыдущая версия
Следующая версия Следующая версия справа и слева
ru:airlay:api:air-lay-v4 [2021/05/28 12:57]
Лев [Структура запроса]
ru:airlay:api:air-lay-v4 [2021/06/20 13:35]
Лев [Comment]
Строка 41: Строка 41:
 =====Контроллеры===== =====Контроллеры=====
  
-==== Status ====+ 
 + 
 + 
 +==== Label====
 === getAction === === getAction ===
 <code php> <code php>
     /**     /**
-     * Get statuses by ids +     * Get labels 
-     * request(+     * request([
          'method' => 'GET',          'method' => 'GET',
-         'url' => '/api/v4/status/getByIds' +         'url' => '/api/v4/label/get'
-     * ) +
-     * response( +
-         '200' => [ +
-              'status' => 200, +
-              'message' => StatusEntity[] +
-              'code' => 0 +
-         ] +
-     * ) +
-     * +
-     * @Authorization(['CmsUser', 'User']) +
-     */ +
-</code> +
- +
-==== Comment ==== +
-=== getByIdsAction === +
-<code php> +
-    /** +
-     * Get comments by ids +
-     * request( +
-         'method' => 'GET', +
-         'url' => '/api/v4/comment/getByIds',+
          'params' => [          'params' => [
-              [ 
-                  'name' => 'ids', 
-                  'type' => 'ObjectId', 
-                  'required' => true, 
-                  'description' => 'comment ids from issue' 
-              ] 
-         ] 
-     * ) 
-     * response( 
-         '200' => [ 
-              'status' => 200, 
-              'message' => CommentEntity[] 
-              'code' => 0 
-         ] 
-     * ) 
-     * 
-     * @Authorization(['CmsUser', 'User']) 
-     */ 
-</code> 
-=== updateAction === 
-<code php> 
-    /** 
-     * Update comment 
-     * request([ 
-         'method' => 'POST', 
-         'url' => '/api/v4/comment/update' 
-         'params' => [ 
-              [ 
-                 'name' => 'id', 
-                 'type' => 'objectId', 
-                 'description' => 'comment id', 
-                 'required' => true 
-             ], 
              [              [
-                 'name' => 'text',+                 'name' => 'type',
                  'type' => 'string',                  'type' => 'string',
-                 'description' => 'comment text',+                 'description' => 'label type',
                  'required' => true                  'required' => true
              ]              ]
Строка 114: Строка 63:
      * response([      * response([
          'status' => 200,          'status' => 200,
-         'message' => "ok",+         'message' => LabelsEntity[],
          'code' => 0          'code' => 0
      * ])      * ])
      *      *
-     * @throws AirlayException +     * @Authorization(['CmsUser', 'User'])
-     * +
-     * @Authorization('CmsUser'+
-     */ +
-</code> +
-=== deleteAction === +
-<code php> +
-    /** +
-     * Delete comment +
-     * request([ +
-         'method' => 'POST', +
-         'url' => '/api/v4/comment/delete' +
-         'params' => [ +
-              [ +
-                 'name' => 'id', +
-                 'type' => 'objectId', +
-                 'description' => 'comment id', +
-                 'required' => true +
-             ] +
-         ] +
-     * ]) +
-     * response([ +
-         'status' => 200, +
-         'message' => "ok", +
-         'code=> 0 +
-     ])+
      *      *
      * @throws AirlayException      * @throws AirlayException
-     * 
-     * @Authorization('CmsUser') 
-     */ 
-</code> 
- 
-==== Label==== 
-=== getAction === 
-<code php> 
-    /** 
-     * Get labels 
-     * request([ 
-         'method' => 'GET', 
-         'url' => '/api/v4/label/get' 
-     * ]) 
-     * response([ 
-         'status' => 200, 
-         'message' => LabelsEntity[], 
-         'code' => 0 
-     * ]) 
-     * 
-     * @Authorization(['CmsUser', 'User']) 
      */      */
 </code> </code>
Строка 271: Строка 174:
              ],              ],
              [              [
-                 'name' => 'ready',+                 'name' => 'progress',
                  'type' => 'int'|null,                  'type' => 'int'|null,
                  'description' => 'percentage of issue completed',                  'description' => 'percentage of issue completed',
Строка 353: Строка 256:
              ],              ],
              [              [
-                 'name' => 'ready',+                 'name' => 'progress',
                  'type' => 'int'|null,                  'type' => 'int'|null,
                  'description' => 'percentage of issue completed',                  'description' => 'percentage of issue completed',
ru/airlay/api/air-lay-v4.txt · Последнее изменение: 2021/06/20 13:49 — Лев