Показаны различия между двумя версиями страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
ru:airlay:api:air-lay-v4 [2021/05/20 12:18] Лев [Структура запроса] |
ru:airlay:api:air-lay-v4 [2021/06/20 13:49] (текущий) Лев [Label] |
||
|---|---|---|---|
| Строка 13: | Строка 13: | ||
| < | < | ||
| /** | /** | ||
| - | * POST - тип метода Action' | ||
| * Desctiprion - описание Action | * Desctiprion - описание Action | ||
| * request([ | * request([ | ||
| Строка 41: | Строка 40: | ||
| </ | </ | ||
| =====Контроллеры===== | =====Контроллеры===== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==== Label==== | ||
| + | === getAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * Get labels | ||
| + | * request([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * | ||
| + | * @Authorization([' | ||
| + | * | ||
| + | * @throws AirlayException | ||
| + | */ | ||
| + | </ | ||
| + | |||
| + | === createAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * Create label | ||
| + | * request([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * | ||
| + | * @throws AirlayException | ||
| + | * | ||
| + | * @Authorization(' | ||
| + | */ | ||
| + | </ | ||
| + | |||
| + | === updateAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * Update label | ||
| + | * request([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * | ||
| + | * @throws AirlayException | ||
| + | * | ||
| + | * @Authorization(' | ||
| + | */ | ||
| + | </ | ||
| + | |||
| + | === deleteAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * Delete label | ||
| + | * request([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * | ||
| + | * @throws AirlayException | ||
| + | * | ||
| + | * @Authorization(' | ||
| + | */ | ||
| + | </ | ||
| + | |||
| + | ==== Issue ==== | ||
| + | === getAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * Get issues | ||
| + | * request([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * | ||
| + | * @Authorization([' | ||
| + | */ | ||
| + | </ | ||
| + | |||
| + | === createAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * request([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * | ||
| + | * @throws AirlayException | ||
| + | * | ||
| + | * @Authorization(' | ||
| + | */ | ||
| + | </ | ||
| + | |||
| + | === updateAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * Update issue | ||
| + | * request([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * | ||
| + | * @throws AirlayException | ||
| + | * | ||
| + | * @Authorization(' | ||
| + | */ | ||
| + | </ | ||
| + | |||
| + | === deleteAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * Delete issue | ||
| + | * request([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * | ||
| + | * @throws AirlayException | ||
| + | * | ||
| + | * @Authorization(' | ||
| + | */ | ||
| + | </ | ||
| + | |||
| + | === addObserverAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * Add observer | ||
| + | * request([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * | ||
| + | * @throws AirlayException | ||
| + | * | ||
| + | * @Authorization(' | ||
| + | */ | ||
| + | </ | ||
| + | |||
| + | === removeObserverAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * Remove observer | ||
| + | * request([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * | ||
| + | * @throws AirlayException | ||
| + | * | ||
| + | * @Authorization(' | ||
| + | */ | ||
| + | </ | ||
| + | |||
| + | === getCommentsAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * Get issue comments | ||
| + | * request( | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ) | ||
| + | * response( | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ) | ||
| + | * | ||
| + | * @throws AirlayException | ||
| + | * | ||
| + | * @Authorization | ||
| + | */ | ||
| + | </ | ||
| + | |||
| + | === addCommentAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * Add new comment to issue. | ||
| + | * request([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * | ||
| + | * @throws AirlayException | ||
| + | * | ||
| + | * @Authorization | ||
| + | */ | ||
| + | </ | ||
| + | |||
| + | === updateCommentAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * Update comment. | ||
| + | * request([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * | ||
| + | * @throws AirlayException | ||
| + | * | ||
| + | * @Authorization | ||
| + | */ | ||
| + | </ | ||
| + | |||
| + | === removeCommentAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * Remove comment from issue. | ||
| + | * request([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * | ||
| + | * @throws AirlayException | ||
| + | * | ||
| + | * @Authorization | ||
| + | */ | ||
| + | </ | ||
| + | |||
| + | === addRelatedObjectAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * Add related object. | ||
| + | * request([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * @throws AirlayException | ||
| + | * @Authorization | ||
| + | */ | ||
| + | </ | ||
| + | |||
| + | === removeRelatedObjectAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * Remove related object. | ||
| + | * request([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * | ||
| + | * @throws AirlayException | ||
| + | * | ||
| + | * @Authorization | ||
| + | */ | ||
| + | </ | ||
| + | |||
| + | |||
| + | |||
| ==== Milestone ==== | ==== Milestone ==== | ||
| + | === getAction === | ||
| <code php> | <code php> | ||
| /** | /** | ||
| - | | + | |
| - | * | + | |
| - | | + | |
| - | * | + | |
| - | | + | |
| - | | + | |
| - | * @return 200 Ok json/ | + | |
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * @Authorization(' | ||
| */ | */ | ||
| - | / | ||
| </ | </ | ||
| + | === createAction === | ||
| <code php> | <code php> | ||
| /** | /** | ||
| - | * POST | + | |
| - | * | + | * request([ |
| - | | + | |
| - | * | + | |
| - | * @param ObjectId | + | |
| - | * @return | + | |
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * @throws AirlayException | ||
| + | * | ||
| + | * @Authorization(' | ||
| + | */ | ||
| + | </ | ||
| + | === updateAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * Update milestone | ||
| + | * request([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * @throws AirlayException | ||
| + | * | ||
| + | * @Authorization(' | ||
| + | */ | ||
| + | </ | ||
| + | === deleteAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * Delete milestone | ||
| + | * request([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * @throws AirlayException | ||
| + | * | ||
| + | * @Authorization(' | ||
| + | */ | ||
| + | </ | ||
| + | === closeMilestoneAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * Close milestone | ||
| + | * request([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * @throws AirlayException | ||
| + | * | ||
| + | * @Authorization(' | ||
| + | */ | ||
| + | </ | ||
| + | === addIssuesAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * Add issues to milestone | ||
| + | * request([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * @throws AirlayException | ||
| + | * | ||
| + | * @Authorization(' | ||
| + | */ | ||
| + | </ | ||
| + | === removeIssueAction === | ||
| + | <code php> | ||
| + | /** | ||
| + | * Remove issue from milestone | ||
| + | * request([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * response([ | ||
| + | | ||
| + | | ||
| + | | ||
| + | * ]) | ||
| + | * @throws AirlayException | ||
| + | * | ||
| + | * @Authorization(' | ||
| */ | */ | ||
| - | / | ||
| </ | </ | ||