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

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


ru:airlay:api:air-lay-v4

Различия

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

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

Предыдущая версия справа и слева Предыдущая версия
Следующая версия
Предыдущая версия
Следующая версия Следующая версия справа и слева
ru:airlay:api:air-lay-v4 [2021/05/27 18:37]
Лев [Status]
ru:airlay:api:air-lay-v4 [2021/05/29 20:05]
Лев [Status]
Строка 13: Строка 13:
 <code> <code>
     /**     /**
-     * POST - тип метода Action'а 
      * Desctiprion - описание Action      * Desctiprion - описание Action
      * request([      * request([
Строка 42: Строка 41:
 =====Контроллеры===== =====Контроллеры=====
  
-==== Status ==== + 
-=== getAction ===+ 
 +==== Comment ==== 
 +=== getByIdsAction ===
 <code php> <code php>
     /**     /**
-     * Get statuses by ids+     * Get comments by ids
      * request(      * request(
          'method' => 'GET',          'method' => 'GET',
-         'url' => '/api/v4/status/getByIds'+         'url' => '/api/v4/comment/getByIds'
 +         'params' => [ 
 +              [ 
 +                  'name' => 'ids', 
 +                  'type' => 'ObjectId', 
 +                  'required' => true, 
 +                  'description' => 'comment ids from issue' 
 +              ] 
 +         ]
      * )      * )
      * response(      * response(
          '200' => [          '200' => [
               'status' => 200,               'status' => 200,
-              'message' => StatusEntity[]+              'message' => CommentEntity[]
               'code' => 0               'code' => 0
          ]          ]
Строка 62: Строка 71:
      */      */
 </code> </code>
- +=== updateAction ===
-==== Comment ==== +
-=== getAction ===+
 <code php> <code php>
 +    /**
 +     * Update comment
 +     * request([
 +         'method' => 'POST',
 +         'url' => '/api/v4/comment/update'
 +         'params' => [
 +              [
 +                 'name' => 'id',
 +                 'type' => 'objectId',
 +                 'description' => 'comment id',
 +                 'required' => true
 +             ],
 +             [
 +                 'name' => 'text',
 +                 'type' => 'string',
 +                 'description' => 'comment text',
 +                 'required' => true
 +             ]
 +         ]
 +     * ])
 +     * response([
 +         'status' => 200,
 +         'message' => "ok",
 +         'code' => 0
 +     * ])
 +     *
 +     * @throws AirlayException
 +     *
 +     * @Authorization('CmsUser')
 +     */
 +</code>
 +=== deleteAction ===
 +<code php>
 +    /**
 +     * Delete comment
 +     * request([
 +         'method' => 'POST',
 +         'url' => '/api/v4/comment/delete'
 +         'params' => [
 +              [
 +                 'name' => 'commentId',
 +                 'type' => 'objectId',
 +                 'description' => 'comment id',
 +                 'required' => true
 +             ],
 +             [
 +                 'name' => 'issueId',
 +                 'type' => 'objectId',
 +                 'description' => 'issue id',
 +                 'required' => true
 +             ]
 +         ]
 +     * ])
 +     * response([
 +         'status' => 200,
 +         'message' => "ok",
 +         'code' => 0
 +     * ])
 +     *
 +     * @throws AirlayException
 +     *
 +     * @Authorization('CmsUser')
 +     */
 </code> </code>
  
Строка 71: Строка 141:
 === getAction === === getAction ===
 <code php> <code php>
 +    /**
 +     * Get labels
 +     * request([
 +         'method' => 'GET',
 +         'url' => '/api/v4/label/get'
 +         'params' => [
 +             [
 +                 'name' => 'type',
 +                 'type' => 'string',
 +                 'description' => 'label type',
 +                 'required' => true
 +             ]
 +         ]
 +     * ])
 +     * response([
 +         'status' => 200,
 +         'message' => LabelsEntity[],
 +         'code' => 0
 +     * ])
 +     *
 +     * @Authorization(['CmsUser', 'User'])
 +     *
 +     * @throws AirlayException
 +     */
 </code> </code>
  
Строка 174: Строка 268:
              ],              ],
              [              [
-                 'name' => 'ready',+                 'name' => 'progress',
                  'type' => 'int'|null,                  'type' => 'int'|null,
                  'description' => 'percentage of issue completed',                  'description' => 'percentage of issue completed',
Строка 256: Строка 350:
              ],              ],
              [              [
-                 'name' => 'ready',+                 'name' => 'progress',
                  'type' => 'int'|null,                  'type' => 'int'|null,
                  'description' => 'percentage of issue completed',                  'description' => 'percentage of issue completed',
Строка 587: Строка 681:
 <code php> <code php>
     /**     /**
-     * POST 
      * Create milestone      * Create milestone
      * request([      * request([
Строка 632: Строка 725:
 <code php> <code php>
     /**     /**
-     * POST 
      * Update milestone      * Update milestone
      * request([      * request([
Строка 683: Строка 775:
 <code php> <code php>
     /**     /**
-     * POST 
      * Delete milestone      * Delete milestone
      * request([      * request([
Строка 710: Строка 801:
 <code php> <code php>
     /**     /**
-     * POST 
      * Close milestone      * Close milestone
      * request([      * request([
Строка 737: Строка 827:
 <code php> <code php>
     /**     /**
-     * POST 
      * Add issues to milestone      * Add issues to milestone
      * request([      * request([
Строка 770: Строка 859:
 <code php> <code php>
     /**     /**
-     * POST 
      * Remove issue from milestone      * Remove issue from milestone
      * request([      * request([
ru/airlay/api/air-lay-v4.txt · Последнее изменение: 2021/06/20 13:49 — Лев