Карыстальніцкія гісторыі і наборы планавання
На гэтай старонцы
Апісвайце ў канкрэтнай гісторыі паводзіны, якія можна праверыць. Выкарыстоўвайце набор планавання, калі ён падыходзіць праекту.
Як карыстацца гэтымі інструментамі
- Спачатку выклічце адпаведны інструмент чытання або праверкі стану.
- Праверце размяшчэнне праекта і абавязковыя аргументы.
- Выканайце адно запланаванае дзеянне з яўным пацвярджэннем чалавека, калі яно патрабуецца.
- Пасля гэтага праверце стан або паўторна прачытайце рэсурс, які закранула дзеянне.
Параметры ніжэй апісваюць публічны кантракт. Вызначальным застаецца актуальны спіс інструментаў падключанага сервера. Некаторыя інструменты патрабуюць пэўнага хоста, размяшчэння праекта, рэжыму інферэнсу або плана. Ідэнтыфікатары — гэта значэнні, якія вярнулі ранейшыя інструменты; не прыдумляйце іх.
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 на хостынгу.
Машыначытальныя кантракты інструментаў змяшчаюць укладзеныя схемы аргументаў.