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

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


ru:airlay:api:air-lay-v4

Различия

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

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

Предыдущая версия справа и слева Предыдущая версия
Следующая версия
Предыдущая версия
ru:airlay:api:air-lay-v4 [2021/05/27 18:38]
Лев [Label]
ru:airlay:api:air-lay-v4 [2021/06/20 13:49] (текущий)
Лев [Label]
Строка 13: Строка 13:
 <code> <code>
     /**     /**
-     * POST - тип метода Action'а 
      * Desctiprion - описание Action      * Desctiprion - описание Action
      * request([      * request([
Строка 42: Строка 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
-     ) +         'params' => [ 
-     response( +             [ 
-         '200' => [ +                 'name' => 'type', 
-              'status' => 200+                 'type' => 'string'
-              'message' => StatusEntity[] +                 'description' => 'label type', 
-              'code' => 0+                 'required' => true 
 +             ]
          ]          ]
-     * )+     ]) 
 +     * response([ 
 +         'status' => 200, 
 +         'message' => LabelsEntity[], 
 +         'code' => 0 
 +     * ])
      *      *
      * @Authorization(['CmsUser', 'User'])      * @Authorization(['CmsUser', 'User'])
 +     *
 +     * @throws AirlayException
      */      */
 </code> </code>
  
-==== Comment ==== +=== createAction ===
-=== getAction ===+
 <code php> <code php>
 +    /**
 +     * Create label
 +     * request([
 +         'method' => 'POST',
 +         'url' => '/api/v4/label/create'
 +         'params' => [
 +              [
 +                 'name' => 'name',
 +                 'type' => 'string',
 +                 'description' => 'label name',
 +                 'required' => true
 +             ],
 +             [
 +                 'name' => 'color',
 +                 'type' => 'string',
 +                 'description' => 'label color',
 +                 'required' => true
 +             ],
 +             [
 +                 'name' => 'type',
 +                 'type' => 'string',
 +                 'description' => 'label type',
 +                 'required' => true
 +             ]
 +         ]
 +     * ])
 +     * response([
 +         'status' => 200,
 +         'message' => LabelEntity,
 +         'code' => 0
 +     * ])
 +     *
 +     * @throws AirlayException
 +     *
 +     * @Authorization('CmsUser')
 +     */
 </code> </code>
  
-==== Label==== +=== updateAction ===
-=== getAction ===+
 <code php> <code php>
     /**     /**
-     Get labels+     Update label
      * request([      * request([
-         'method' => 'GET', +         'method' => 'POST', 
-         'url' => '/api/v4/label/get'+         'url' => '/api/v4/label/update' 
 +         'params' => [ 
 +              [ 
 +                 'name' => 'id', 
 +                 'type' => 'ObjectId', 
 +                 'description' => 'label id', 
 +                 'required' => true 
 +              ], 
 +              [ 
 +                 'name' => 'name', 
 +                 'type' => 'string'|null, 
 +                 'description' => 'label name', 
 +                 'required' => false 
 +             ], 
 +             [ 
 +                 'name' => 'color', 
 +                 'type' => 'string'|null, 
 +                 'description' => 'label color', 
 +                 'required' => false 
 +             ] 
 +         ]
      * ])      * ])
      * response([      * response([
          'status' => 200,          'status' => 200,
-         'message' => LabelsEntity[],+         'message' => LabelEntity,
          'code' => 0          'code' => 0
      * ])      * ])
      *      *
-     * @Authorization(['CmsUser', 'User'])+     * @throws AirlayException 
 +     * 
 +     * @Authorization('CmsUser') 
 +     */ 
 +</code> 
 + 
 +=== deleteAction === 
 +<code php> 
 +    /** 
 +     * Delete label 
 +     * request([ 
 +         'method' => 'POST', 
 +         'url=> '/api/v4/label/delete' 
 +         'params' => [ 
 +              [ 
 +                 'name' => 'id', 
 +                 'type' => 'ObjectId', 
 +                 'description' => 'label id', 
 +                 'required' => true 
 +              ] 
 +         ] 
 +     * ]) 
 +     * response([ 
 +         'status' => 200, 
 +         'message' => 'Ok', 
 +         'code' => 0 
 +     * ]) 
 +     * 
 +     * @throws AirlayException 
 +     * 
 +     * @Authorization('CmsUser')
      */      */
 </code> </code>
Строка 103: Строка 197:
              ],              ],
              [              [
-                 'name' => 'userIds',+                 'name' => 'assignIds',
                  'type' => 'ObjectId[]',                  'type' => 'ObjectId[]',
                  'description' => 'assigns filter',                  'description' => 'assigns filter',
Строка 155: Строка 249:
                  'type' => 'string',                  'type' => 'string',
                  'description' => 'issue description',                  'description' => 'issue description',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'assignId',
 +                 'type' => 'objectId|null',
 +                 'description' => 'issue assign user id',
                  'required' => false                  'required' => false
              ],              ],
Строка 161: Строка 261:
                  'type' => 'objectId'|null,                  'type' => 'objectId'|null,
                  'description' => 'priority id',                  'description' => 'priority id',
 +                 'required' => false
 +             ],,
 +             [
 +                 'name' => 'statusId',
 +                 'type' => 'objectId'|null,
 +                 'description' => 'status id',
                  'required' => false                  'required' => false
              ],              ],
Строка 170: Строка 276:
              ],              ],
              [              [
-                 'name' => 'closeDate',+                 'name' => 'endDate',
                  'type' => 'int'|null,                  'type' => 'int'|null,
                  'description' => 'close date',                  'description' => 'close date',
Строка 188: Строка 294:
              ],              ],
              [              [
-                 'name' => 'ready',+                 'name' => 'progress',
                  'type' => 'int'|null,                  'type' => 'int'|null,
                  'description' => 'percentage of issue completed',                  'description' => 'percentage of issue completed',
Строка 232: Строка 338:
                  'description' => 'issue name',                  'description' => 'issue name',
                  'required' => true                  'required' => true
 +             ],
 +             [
 +                 'name' => 'statusId',
 +                 'type' => 'objectId'|null,
 +                 'description' => 'status id',
 +                 'required' => false
              ],              ],
              [              [
Строка 237: Строка 349:
                  'type' => 'string',                  'type' => 'string',
                  'description' => 'issue description',                  'description' => 'issue description',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'assignId',
 +                 'type' => 'objectId|null',
 +                 'description' => 'issue assign user id',
                  'required' => false                  'required' => false
              ],              ],
Строка 252: Строка 370:
              ],              ],
              [              [
-                 'name' => 'closeDate',+                 'name' => 'endDate',
                  'type' => 'int'|null,                  'type' => 'int'|null,
                  'description' => 'close date',                  'description' => 'close date',
Строка 270: Строка 388:
              ],              ],
              [              [
-                 'name' => 'ready',+                 'name' => 'progress',
                  'type' => 'int'|null,                  'type' => 'int'|null,
                  'description' => 'percentage of issue completed',                  'description' => 'percentage of issue completed',
Строка 325: Строка 443:
 === addObserverAction === === addObserverAction ===
 <code php> <code php>
-    /**+   /**
      * Add observer      * Add observer
      * request([      * request([
Строка 375: Строка 493:
                  'type' => 'objectId',                  'type' => 'objectId',
                  'description' => 'issue id',                  'description' => 'issue id',
-                 'required' => true 
-             ], 
-             [ 
-                 'name' => 'type', 
-                 'type' => 'string' ('user' | 'organization' | 'group' | 'department'), 
-                 'description' => 'type of observer', 
                  'required' => true                  'required' => true
              ],              ],
Строка 400: Строка 512:
      *      *
      * @Authorization('CmsUser')      * @Authorization('CmsUser')
 +     */
 +</code>
 +
 +=== getCommentsAction ===
 +<code php>
 +    /**
 +     * Get issue comments
 +     * request(
 +         'method' => 'GET',
 +         'url' => '/api/v4/issue/getComments',
 +         'params' => [
 +              [
 +                  'name' => 'issueId',
 +                  'type' => 'ObjectId',
 +                  'required' => true,
 +                  'description' => 'Issue id'
 +              ],
 +              [
 +                  'name' => 'skip',
 +                  'type' => 'int',
 +                  'required' => false,
 +                  'description' => 'Skip comments in result'
 +              ],
 +              [
 +                  'name' => 'limit',
 +                  'type' => 'int',
 +                  'required' => false,
 +                  'description' => 'Limit comments in result'
 +              ]
 +         ]
 +     * )
 +     * response(
 +         '200' => [
 +              'status' => 200,
 +              'message' => CommentEntity[]
 +              'code' => 0
 +         ]
 +     * )
 +     *
 +     * @throws AirlayException
 +     *
 +     * @Authorization
      */      */
 </code> </code>
Строка 414: Строка 568:
                  'name' => 'id',                  'name' => 'id',
                  'type' => 'objectId',                  'type' => 'objectId',
-                 'description' => 'issue id',+                 'description' => 'Issue id',
                  'required' => true                  'required' => true
              ],              ],
Строка 427: Строка 581:
      * response([      * response([
          'status' => 200,          'status' => 200,
-         'message' => 'IssueEntity',+         'message' => 'CommentEntity',
          'code' => 0          'code' => 0
      * ])      * ])
Строка 433: Строка 587:
      * @throws AirlayException      * @throws AirlayException
      *      *
-     * @Authorization('CmsUser')+     * @Authorization
      */      */
 </code> </code>
  
-=== setPriorityAction ===+=== updateCommentAction ===
 <code php> <code php>
     /**     /**
-     Set priority+     Update comment.
      * request([      * request([
          'method' => 'POST',          'method' => 'POST',
-         'url' => '/api/v4/issue/setPriority'+         'url' => '/api/v4/issue/updateComment'
          'params' => [          'params' => [
               [               [
                  'name' => 'id',                  'name' => 'id',
                  'type' => 'objectId',                  'type' => 'objectId',
-                 'description' => 'issue id',+                 'description' => 'Comment id',
                  'required' => true                  'required' => true
              ],              ],
              [              [
-                 'name' => 'priorityId', +                 'name' => 'text', 
-                 'type' => 'objectId', +                 'type' => 'string', 
-                 'description' => 'priority id for field',+                 'description' => 'Comment text',
                  'required' => true                  'required' => true
              ]              ]
Строка 461: Строка 615:
      * response([      * response([
          'status' => 200,          'status' => 200,
-         'message' => IssueEntity,+         'message' => 'CommentEntity',
          'code' => 0          'code' => 0
      * ])      * ])
 +     *
      * @throws AirlayException      * @throws AirlayException
 +     *
      * @Authorization      * @Authorization
      */      */
 </code> </code>
  
-=== changeStatusAction ===+=== removeCommentAction ===
 <code php> <code php>
     /**     /**
-     Change status+     Remove comment from issue.
      * request([      * request([
          'method' => 'POST',          'method' => 'POST',
-         'url' => '/api/v4/issue/changeStatus'+         'url' => '/api/v4/issue/removeComment'
          'params' => [          'params' => [
-              [+             [
                  'name' => 'id',                  'name' => 'id',
                  'type' => 'objectId',                  'type' => 'objectId',
-                 'description' => 'issue id', +                 'description' => 'Comment id',
-                 'required' => true +
-             ], +
-             [ +
-                 'name' => 'statusId', +
-                 'type' => 'objectId', +
-                 'description' => 'status id for field',+
                  'required' => true                  'required' => true
              ]              ]
Строка 493: Строка 643:
      * response([      * response([
          'status' => 200,          'status' => 200,
-         'message' => IssueEntity,+         'message' => 'Ok',
          'code' => 0          'code' => 0
      * ])      * ])
 +     *
      * @throws AirlayException      * @throws AirlayException
 +     *
      * @Authorization      * @Authorization
      */      */
Строка 601: Строка 753:
 <code php> <code php>
     /**     /**
-     * POST 
      * Create milestone      * Create milestone
      * request([      * request([
Строка 646: Строка 797:
 <code php> <code php>
     /**     /**
-     * POST 
      * Update milestone      * Update milestone
      * request([      * request([
Строка 697: Строка 847:
 <code php> <code php>
     /**     /**
-     * POST 
      * Delete milestone      * Delete milestone
      * request([      * request([
Строка 724: Строка 873:
 <code php> <code php>
     /**     /**
-     * POST 
      * Close milestone      * Close milestone
      * request([      * request([
Строка 751: Строка 899:
 <code php> <code php>
     /**     /**
-     * POST 
      * Add issues to milestone      * Add issues to milestone
      * request([      * request([
Строка 784: Строка 931:
 <code php> <code php>
     /**     /**
-     * POST 
      * Remove issue from milestone      * Remove issue from milestone
      * request([      * request([
ru/airlay/api/air-lay-v4.1622115492.txt.gz · Последнее изменение: 2021/05/27 18:38 — Лев