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

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


ru:airlay:api:air-lay-v4

Различия

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

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

Предыдущая версия справа и слева Предыдущая версия
ru:airlay:api:air-lay-v4 [2021/06/20 13:44]
Лев [Issue]
ru:airlay:api:air-lay-v4 [2021/06/20 13:49] (текущий)
Лев [Label]
Строка 70: Строка 70:
      *      *
      * @throws AirlayException      * @throws AirlayException
 +     */
 +</code>
 +
 +=== createAction ===
 +<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>
 +
 +=== updateAction ===
 +<code php>
 +    /**
 +     * Update label
 +     * request([
 +         'method' => 'POST',
 +         '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([
 +         'status' => 200,
 +         'message' => LabelEntity,
 +         'code' => 0
 +     * ])
 +     *
 +     * @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>
ru/airlay/api/air-lay-v4.1624171465.txt.gz · Последнее изменение: 2021/06/20 13:44 — Лев