Користувацькі історії та набори для планування
На цій сторінці
Описуйте в окремій історії конкретну поведінку, яку можна перевірити, а набір для планування використовуйте, якщо він підходить для проєкту.
Як користуватися цими інструментами
- Спершу викличте відповідний інструмент читання або перевірки статусу.
- Перевірте ціль та обовʼязкові аргументи.
- Виконайте одну заплановану дію, отримавши явне підтвердження людини там, де воно потрібне.
- Після цього перевірте статус або повторно прочитайте ресурс, якого стосувалася дія.
Наведені нижче вхідні дані описують публічний контракт. Орієнтуйтеся на поточний перелік інструментів сервера, до якого ви підключені. Деякі інструменти потребують певного хоста, цілі, режиму інференсу або плану. Ідентифікатори — це значення, які повернули попередні інструменти; не вигадуйте їх.
describe_planning_kits
Набори для планування, які можна застосувати до проєкту.
Прочитайте повернутий ресурс і використовуйте його поточні значення, коли плануєте наступну дію.
| Аргумент | Обовʼязковий | Тип або допустимі значення |
|---|
| projectId | Ні | рядок |
Операція: лише читання.
Доступні конфігурації: stdio, хмарний проєкт, хмарний інференс; stdio, хмарний проєкт, делегований інференс; stdio, локальний проєкт, хмарний інференс; stdio, локальний проєкт, делегований інференс; HTTP на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.
apply_planning_kit
Запишіть набір для планування в проєкт.
Спершу прочитайте describe_planning_kits і виберіть підтримуваний набір для планування та набір типів. Перегляньте історії, створені після застосування набору.
| Аргумент | Обовʼязковий | Тип або допустимі значення |
|---|
| projectId | Ні | рядок |
| kit | Так | рядок; мінімальна довжина 1 |
| types | Ні | масив рядків |
Операція: може змінити стан або розпочати роботу.
Доступні конфігурації: stdio, хмарний проєкт, хмарний інференс; stdio, хмарний проєкт, делегований інференс; stdio, локальний проєкт, хмарний інференс; stdio, локальний проєкт, делегований інференс; HTTP на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.
list_stories
Користувацькі історії проєкту.
Прочитайте повернутий ресурс і використовуйте його поточні значення, коли плануєте наступну дію.
| Аргумент | Обовʼязковий | Тип або допустимі значення |
|---|
| projectId | Ні | рядок |
| page | Ні | ціле число; мінімум 0; максимум 9007199254740991 |
| size | Ні | ціле число; мінімум 1; максимум 100 |
| status | Ні | рядок |
| area | Ні | рядок |
Операція: лише читання.
Доступні конфігурації: stdio, хмарний проєкт, хмарний інференс; stdio, хмарний проєкт, делегований інференс; stdio, локальний проєкт, хмарний інференс; stdio, локальний проєкт, делегований інференс; HTTP на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.
search_stories
Знайдіть історію.
Прочитайте повернутий ресурс і використовуйте його поточні значення, коли плануєте наступну дію.
| Аргумент | Обовʼязковий | Тип або допустимі значення |
|---|
| q | Так | рядок; мінімальна довжина 1 |
| projectId | Ні | рядок |
Операція: лише читання.
Доступні конфігурації: stdio, хмарний проєкт, хмарний інференс; stdio, хмарний проєкт, делегований інференс; stdio, локальний проєкт, хмарний інференс; stdio, локальний проєкт, делегований інференс; HTTP на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.
create_story
Додайте користувацьку історію.
Прочитайте повернутий ресурс і використовуйте його поточні значення, коли плануєте наступну дію.
| Аргумент | Обовʼязковий | Тип або допустимі значення |
|---|
| story | Так | рядок; мінімальна довжина 1 |
| projectId | Ні | рядок |
Операція: може змінити стан або розпочати роботу.
Доступні конфігурації: stdio, хмарний проєкт, хмарний інференс; stdio, хмарний проєкт, делегований інференс; stdio, локальний проєкт, хмарний інференс; stdio, локальний проєкт, делегований інференс; HTTP на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.
update_story
Змініть формулювання користувацької історії.
Прочитайте повернутий ресурс і використовуйте його поточні значення, коли плануєте наступну дію.
| Аргумент | Обовʼязковий | Тип або допустимі значення |
|---|
| storyId | Так | рядок |
| story | Так | рядок; мінімальна довжина 1 |
| projectId | Ні | рядок |
Операція: може змінити стан або розпочати роботу.
Доступні конфігурації: stdio, хмарний проєкт, хмарний інференс; stdio, хмарний проєкт, делегований інференс; stdio, локальний проєкт, хмарний інференс; stdio, локальний проєкт, делегований інференс; HTTP на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.
delete_story
Видаліть користувацьку історію.
Видаляє історію з плану. Перш ніж видалити історію, перегляньте її картку. Не розраховуйте, що ця дія скасує зміни в наявному коді застосунку.
| Аргумент | Обовʼязковий | Тип або допустимі значення |
|---|
| storyId | Так | рядок |
| projectId | Ні | рядок |
Операція: може змінити стан або розпочати роботу; можливі руйнівні наслідки.
Доступні конфігурації: stdio, хмарний проєкт, хмарний інференс; stdio, хмарний проєкт, делегований інференс; stdio, локальний проєкт, хмарний інференс; stdio, локальний проєкт, делегований інференс; HTTP на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.
develop_story
Реалізуйте користувацьку історію.
Одноразово запускає розробку для вибраної історії. Стежте за story_status і перевірте результат у попередньому перегляді.
| Аргумент | Обовʼязковий | Тип або допустимі значення |
|---|
| storyId | Так | рядок |
| projectId | Ні | рядок |
Операція: може змінити стан або розпочати роботу.
Доступні конфігурації: stdio, хмарний проєкт, хмарний інференс; stdio, хмарний проєкт, делегований інференс; stdio, локальний проєкт, хмарний інференс; stdio, локальний проєкт, делегований інференс; HTTP на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.
reset_story
Поверніть історію до статусу «Заплановано».
Знову встановлює для історії статус «Заплановано». Перш ніж запускати її повторно, перегляньте поточний застосунок.
| Аргумент | Обовʼязковий | Тип або допустимі значення |
|---|
| storyId | Так | рядок |
| projectId | Ні | рядок |
Операція: може змінити стан або розпочати роботу.
Доступні конфігурації: stdio, хмарний проєкт, хмарний інференс; stdio, хмарний проєкт, делегований інференс; stdio, локальний проєкт, хмарний інференс; stdio, локальний проєкт, делегований інференс; HTTP на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.
complete_story
Позначте історію як завершену.
Оновлює стан у плані. Перевірте, як працює реалізована поведінка: сама ця дія не додає коду, якого бракує.
| Аргумент | Обовʼязковий | Тип або допустимі значення |
|---|
| storyId | Так | рядок |
| projectId | Ні | рядок |
Операція: може змінити стан або розпочати роботу.
Доступні конфігурації: stdio, хмарний проєкт, хмарний інференс; stdio, хмарний проєкт, делегований інференс; stdio, локальний проєкт, хмарний інференс; stdio, локальний проєкт, делегований інференс; HTTP на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.
story_status
Що відбулося з історією.
Прочитайте повернутий ресурс і використовуйте його поточні значення, коли плануєте наступну дію.
| Аргумент | Обовʼязковий | Тип або допустимі значення |
|---|
| storyId | Так | рядок |
| projectId | Ні | рядок |
Операція: лише читання.
Доступні конфігурації: stdio, хмарний проєкт, хмарний інференс; stdio, хмарний проєкт, делегований інференс; stdio, локальний проєкт, хмарний інференс; stdio, локальний проєкт, делегований інференс; HTTP на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.