@stablebaseline/sdk 0.7.0 → 0.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.cts +390 -37
- package/dist/index.d.ts +390 -37
- package/openapi.json +1390 -51
- package/package.json +1 -1
- package/src/types.generated.ts +390 -37
package/src/types.generated.ts
CHANGED
|
@@ -1395,7 +1395,7 @@ export interface paths {
|
|
|
1395
1395
|
put?: never;
|
|
1396
1396
|
/**
|
|
1397
1397
|
* listImprovements
|
|
1398
|
-
* @description List AND grep improvements in a project. `query` searches the title, friendlyId and problem statement, not just the title (substring by default; set isRegex:true for a regular expression, caseSensitive:true for exact case). Supports filtering by status, type, priority. For ranked semantic + text search use searchImprovements.
|
|
1398
|
+
* @description List AND grep improvements in a project. `query` searches the title, friendlyId and problem statement, not just the title (substring by default; set isRegex:true for a regular expression, caseSensitive:true for exact case). Supports filtering by status, type, priority, and by parentItemId for an item's children in the work hierarchy (an epic's stories, say). For ranked semantic + text search use searchImprovements. Every item carries its versionTimestamp, ready for updateImprovement, so one call here supplies the tokens for a whole batch of updates (fields ["id", "friendlyId", "versionTimestamp"] returns just those), and its parentItem: the item it belongs to in the work hierarchy ({ id, friendlyId, title, type, status, isTask }, or null).
|
|
1399
1399
|
*/
|
|
1400
1400
|
post: operations["listImprovements"];
|
|
1401
1401
|
delete?: never;
|
|
@@ -1415,7 +1415,7 @@ export interface paths {
|
|
|
1415
1415
|
put?: never;
|
|
1416
1416
|
/**
|
|
1417
1417
|
* getImprovement
|
|
1418
|
-
* @description Get full details for an improvement item including evidence, activity log, compliance context, and the `checklist` array (each item: id, text, due_date, completed_at, plus server-stamped attribution). Returns versionTimestamp
|
|
1418
|
+
* @description Get full details for an improvement item including evidence, activity log, compliance context, and the `checklist` array (each item: id, text, due_date, completed_at, plus server-stamped attribution). Returns versionTimestamp: pass it to updateImprovement for optimistic locking. (For tasks specifically, use getTask + updateTask which are symmetric aliases.) Also returns the work hierarchy: parentItem (the item this one belongs to, such as its epic or story: { id, friendlyId, title, type, status, isTask }, or null), children (the items that belong to it, in status order then by id, at most 200: each with ownerId, ownerTeamId and percentComplete) and childProgress { total, done, closed } over every child (closed counts done, rejected and deferred). Set a parent with parentItemId on updateImprovement or updateTask.
|
|
1419
1419
|
*/
|
|
1420
1420
|
post: operations["getImprovement"];
|
|
1421
1421
|
delete?: never;
|
|
@@ -1435,7 +1435,7 @@ export interface paths {
|
|
|
1435
1435
|
put?: never;
|
|
1436
1436
|
/**
|
|
1437
1437
|
* createImprovement
|
|
1438
|
-
* @description Create an improvement item in a project. Requires projectId and title. Auto-assigns friendly ID. Accepts every field updateImprovement accepts, so an item can be created complete in one call rather than create-then-update.
|
|
1438
|
+
* @description Create an improvement item in a project. Requires projectId and title. Auto-assigns friendly ID. Accepts every field updateImprovement accepts, so an item can be created complete in one call rather than create-then-update. Pass parentItemId to create it under its epic or story in the work hierarchy. Pass `fields` (for example ["id", "friendlyId", "versionTimestamp"]) for a short answer instead of the whole improvement.
|
|
1439
1439
|
*/
|
|
1440
1440
|
post: operations["createImprovement"];
|
|
1441
1441
|
delete?: never;
|
|
@@ -1455,7 +1455,7 @@ export interface paths {
|
|
|
1455
1455
|
put?: never;
|
|
1456
1456
|
/**
|
|
1457
1457
|
* updateImprovement
|
|
1458
|
-
* @description Update an improvement (or a task
|
|
1458
|
+
* @description Update an improvement, or many in one call (or a task: tasks share this row, but prefer the symmetric updateTask alias when working from getTask). Supports the full field set including `checklist` (tick-boxes with due dates + completion attribution), `acceptance_criteria` (objects with per-row updated_by/at attribution) and parentItemId (the epic or story it belongs to in the work hierarchy; null removes it). versionTimestamp (optimistic locking) is the item's updated_at in epoch milliseconds, and you rarely need a getImprovement call for it: listImprovements returns it for every improvement in a project (fields ["id", "friendlyId", "versionTimestamp"] keeps that answer short), getPlan (items[].versionTimestamp) for every item in a plan, and every write returns the new one. Pass `fields` (for example ["id", "versionTimestamp"]) for a short answer instead of the whole record. To change many improvements, send `items`: up to 200 entries of { improvementId, versionTimestamp, ...changes } per call (more than 200: split them into several calls of up to 200), each checked and written on its own and answered with one row per entry plus a summary. Statuses are captured / in_progress / blocked / done / rejected / deferred, and FOUR of those are CLOSED: blocked, done, rejected, deferred. Entering one needs its comment (blocked needs blocked_comment, rejected needs rejection_comment, done needs completion_comment); leaving one for an open status needs reopened_comment, including blocked -> in_progress, which surprises people because `blocked` does not sound terminal. `metadata` MERGES into what is stored (null on a key deletes it); pass metadata_replace:true to overwrite the object wholesale. Assignment: pass `owner_id=<uuid>` to assign to a user, `owner_team_id=<uuid>` to assign to a team (mutually exclusive: a DB CHECK constraint enforces this). To unassign, pass `owner_id=null` AND `owner_team_id=null`. To switch from a user owner to a team owner, send `owner_id=null, owner_team_id=<uuid>` in the SAME call (sending only one side leaves the stale value and triggers the XOR check). Use listAssignablePrincipals or listTeams to discover valid IDs.
|
|
1459
1459
|
*/
|
|
1460
1460
|
post: operations["updateImprovement"];
|
|
1461
1461
|
delete?: never;
|
|
@@ -1719,7 +1719,7 @@ export interface paths {
|
|
|
1719
1719
|
put?: never;
|
|
1720
1720
|
/**
|
|
1721
1721
|
* getPlan
|
|
1722
|
-
* @description Get full plan details including phases, items, and activity.
|
|
1722
|
+
* @description Get full plan details including phases, items, and activity. Every level carries its own optimistic-lock token, so one call supplies them all: the top-level versionTimestamp is the plan's (for updatePlan), phases[].versionTimestamp each phase's (for updatePlanPhase) and items[].versionTimestamp each task's or improvement's (for updateTask / updateImprovement, including their bulk `items` form). Items include percent_complete for progress tracking.
|
|
1723
1723
|
*/
|
|
1724
1724
|
post: operations["getPlan"];
|
|
1725
1725
|
delete?: never;
|
|
@@ -1739,7 +1739,7 @@ export interface paths {
|
|
|
1739
1739
|
put?: never;
|
|
1740
1740
|
/**
|
|
1741
1741
|
* createPlan
|
|
1742
|
-
* @description Create a plan in a project. Requires projectId and title.
|
|
1742
|
+
* @description Create a plan in a project. Requires projectId and title. Pass `fields` (for example ["id", "versionTimestamp"]) for a short answer instead of the whole plan.
|
|
1743
1743
|
*/
|
|
1744
1744
|
post: operations["createPlan"];
|
|
1745
1745
|
delete?: never;
|
|
@@ -1759,7 +1759,7 @@ export interface paths {
|
|
|
1759
1759
|
put?: never;
|
|
1760
1760
|
/**
|
|
1761
1761
|
* updatePlan
|
|
1762
|
-
* @description Update a plan.
|
|
1762
|
+
* @description Update a plan. versionTimestamp (optimistic locking) is the plan's updated_at in epoch milliseconds: listPlans and getPlan return it, and every write returns the new one. Pass `fields` (for example ["id", "versionTimestamp"]) for a short answer instead of the whole plan.
|
|
1763
1763
|
*/
|
|
1764
1764
|
post: operations["updatePlan"];
|
|
1765
1765
|
delete?: never;
|
|
@@ -1799,7 +1799,7 @@ export interface paths {
|
|
|
1799
1799
|
put?: never;
|
|
1800
1800
|
/**
|
|
1801
1801
|
* listPlanPhases
|
|
1802
|
-
* @description List phases for a plan ordered by position.
|
|
1802
|
+
* @description List phases for a plan ordered by position. Each phase carries its own versionTimestamp, ready for updatePlanPhase.
|
|
1803
1803
|
*/
|
|
1804
1804
|
post: operations["listPlanPhases"];
|
|
1805
1805
|
delete?: never;
|
|
@@ -1839,7 +1839,7 @@ export interface paths {
|
|
|
1839
1839
|
put?: never;
|
|
1840
1840
|
/**
|
|
1841
1841
|
* createPlanPhase
|
|
1842
|
-
* @description Create a phase in a plan. Position and wbs_code are auto-computed.
|
|
1842
|
+
* @description Create a phase in a plan. Position and wbs_code are auto-computed. By default a phase's dates follow its tasks (date_mode 'auto'): once any task in it has dates, the phase runs from the earliest task start to the latest task end and stays in step as tasks change, so there is no need to maintain phase dates by hand. Pass `fields` (for example ["id", "versionTimestamp"]) for a short answer instead of the whole phase.
|
|
1843
1843
|
*/
|
|
1844
1844
|
post: operations["createPlanPhase"];
|
|
1845
1845
|
delete?: never;
|
|
@@ -1859,7 +1859,7 @@ export interface paths {
|
|
|
1859
1859
|
put?: never;
|
|
1860
1860
|
/**
|
|
1861
1861
|
* updatePlanPhase
|
|
1862
|
-
* @description Update a plan phase.
|
|
1862
|
+
* @description Update a plan phase, or many phases in one call. Each phase has its own versionTimestamp (its updated_at in epoch milliseconds): listPlanPhases and getPlan (phases[].versionTimestamp) return it for every phase in a plan, getPlanPhase for one, and every write returns the new one. Never pass the plan's own top-level versionTimestamp. A phase with date_mode 'auto' (the default) takes its dates from its tasks; set date_mode 'manual' to pin dates by hand, or 'auto' to make them follow the tasks again. Pass `fields` (for example ["id", "versionTimestamp"]) for a short answer; a `note` saying the dates were replaced by the tasks' range always comes back. To change many phases, send `items`: up to 200 entries of { phaseId, versionTimestamp, ...changes } per call (more than 200: split them into several calls of up to 200), each checked and written on its own and answered with one row per entry plus a summary.
|
|
1863
1863
|
*/
|
|
1864
1864
|
post: operations["updatePlanPhase"];
|
|
1865
1865
|
delete?: never;
|
|
@@ -1979,7 +1979,7 @@ export interface paths {
|
|
|
1979
1979
|
put?: never;
|
|
1980
1980
|
/**
|
|
1981
1981
|
* createTask
|
|
1982
|
-
* @description Create a task in a plan. Requires planId and title. Accepts every field updateTask accepts, so a task can be created complete in ONE call
|
|
1982
|
+
* @description Create a task in a plan. Requires planId and title. Accepts every field updateTask accepts, so a task can be created complete in ONE call: no create-then-update, and no window in which other actors read a half-written record. Pass parentItemId to create it under its story, requirement or feature in the work hierarchy (which may be in another plan, or in none). Pass `fields` (for example ["id", "friendlyId", "versionTimestamp"]) for a short answer instead of the whole task.
|
|
1983
1983
|
*/
|
|
1984
1984
|
post: operations["createTask"];
|
|
1985
1985
|
delete?: never;
|
|
@@ -1999,7 +1999,7 @@ export interface paths {
|
|
|
1999
1999
|
put?: never;
|
|
2000
2000
|
/**
|
|
2001
2001
|
* listTasks
|
|
2002
|
-
* @description List AND grep tasks in a plan. `query` searches the title, friendlyId and description, not just the title (substring by default; set isRegex:true for a regular expression, caseSensitive:true for exact case). Supports filtering by status, priority and
|
|
2002
|
+
* @description List AND grep tasks in a plan. `query` searches the title, friendlyId and description, not just the title (substring by default; set isRegex:true for a regular expression, caseSensitive:true for exact case). Supports filtering by status, priority, phaseId and parentItemId (a story's tasks in the work hierarchy, say). Every task carries its versionTimestamp, ready for updateTask, so one call here supplies the tokens for a whole batch of updates, and its parent_item_id and parentItem (the item it belongs to in the work hierarchy, or null).
|
|
2003
2003
|
*/
|
|
2004
2004
|
post: operations["listTasks"];
|
|
2005
2005
|
delete?: never;
|
|
@@ -2019,7 +2019,7 @@ export interface paths {
|
|
|
2019
2019
|
put?: never;
|
|
2020
2020
|
/**
|
|
2021
2021
|
* getTask
|
|
2022
|
-
* @description Get a task by ID with full details, evidence, activity, and the `checklist` array (each item: id, text, due_date, completed_at, plus server-stamped attribution). Returns versionTimestamp; pass it to updateTask to modify. Includes percent_complete for progress tracking.
|
|
2022
|
+
* @description Get a task by ID with full details, evidence, activity, and the `checklist` array (each item: id, text, due_date, completed_at, plus server-stamped attribution). Returns versionTimestamp; pass it to updateTask to modify. Includes percent_complete for progress tracking. Also returns the work hierarchy: parentItem (the item this one belongs to, such as its epic or story: { id, friendlyId, title, type, status, isTask }, or null), children (the items that belong to it, in status order then by id, at most 200: each with ownerId, ownerTeamId and percentComplete) and childProgress { total, done, closed } over every child (closed counts done, rejected and deferred). Set a parent with parentItemId on updateImprovement or updateTask.
|
|
2023
2023
|
*/
|
|
2024
2024
|
post: operations["getTask"];
|
|
2025
2025
|
delete?: never;
|
|
@@ -2039,7 +2039,7 @@ export interface paths {
|
|
|
2039
2039
|
put?: never;
|
|
2040
2040
|
/**
|
|
2041
2041
|
* updateTask
|
|
2042
|
-
* @description Update a task. Tasks share a row with improvements (`improvement_items` with `is_task=true`), so this is a thin alias over updateImprovement
|
|
2042
|
+
* @description Update a task, or many tasks in one call. Tasks share a row with improvements (`improvement_items` with `is_task=true`), so this is a thin alias over updateImprovement: every field on updateImprovement is supported, including `checklist`, `acceptance_criteria`, dates, owner, percent_complete, parentItemId (the story or requirement it belongs to in the work hierarchy), etc. versionTimestamp (optimistic locking) is the task's updated_at in epoch milliseconds, and you rarely need a getTask call for it: listTasks and getPlan (items[].versionTimestamp) return it for every task in a plan at once, and every write returns the task's new one. Pass `fields` (for example ["id", "versionTimestamp"]) for a short answer instead of the whole task. To change many tasks (a plan-wide re-date, say), send `items`: up to 200 entries of { taskId, versionTimestamp, ...changes } per call (more than 200: split them into several calls of up to 200), each checked and written on its own and answered with one row per entry plus a summary. Statuses are captured / in_progress / blocked / done / rejected / deferred, and FOUR of those are CLOSED: blocked, done, rejected, deferred. Entering one needs its comment (blocked_comment / rejection_comment / completion_comment); leaving one for an open status needs reopened_comment, including blocked -> in_progress, which surprises people because `blocked` does not sound terminal. `metadata` MERGES into what is stored (null on a key deletes it); pass metadata_replace:true to overwrite the object wholesale. To edit checklist items: call getTask, modify the `checklist` array (preserving each row's `id` to keep its attribution stamps), and pass the full array back here; array order is the sort order. Assignment: pass `owner_id=<uuid>` to assign to a user, `owner_team_id=<uuid>` to assign to a team (mutually exclusive: the DB enforces it with a CHECK constraint). To unassign, pass `owner_id=null` AND `owner_team_id=null`. To switch owner kind, send the new value AND null the old one in the SAME call.
|
|
2043
2043
|
*/
|
|
2044
2044
|
post: operations["updateTask"];
|
|
2045
2045
|
delete?: never;
|
|
@@ -2079,7 +2079,7 @@ export interface paths {
|
|
|
2079
2079
|
put?: never;
|
|
2080
2080
|
/**
|
|
2081
2081
|
* setPlanItemParent
|
|
2082
|
-
* @description Set or clear the WBS
|
|
2082
|
+
* @description Set or clear the plan outline (WBS) nesting of a task or improvement: the indent inside one plan phase, with no scheduling effect. Parent and child must be in the same plan and the same phase, and the WBS numbers are recalculated. Max depth: 5. This is NOT the work hierarchy: for an epic's stories or a story's tasks or test cases, in any plan or phase, set parentItemId with createImprovement, updateImprovement, createTask or updateTask instead.
|
|
2083
2083
|
*/
|
|
2084
2084
|
post: operations["setPlanItemParent"];
|
|
2085
2085
|
delete?: never;
|
|
@@ -10537,9 +10537,11 @@ export interface operations {
|
|
|
10537
10537
|
content: {
|
|
10538
10538
|
"application/json": {
|
|
10539
10539
|
projectId: string;
|
|
10540
|
+
/** @description Only the children of this item in the work hierarchy (its UUID or friendly id, such as IMP-12), whatever plan or phase they are in. "none" lists only the items with no parent. The work hierarchy is not the plan outline nesting (setPlanItemParent). */
|
|
10541
|
+
parentItemId?: string;
|
|
10540
10542
|
/** @description Filter: captured, triaging, shaped, approved, ready_for_agent, in_progress, ready_for_review, in_review, blocked, done, rejected, deferred. */
|
|
10541
10543
|
status?: string;
|
|
10542
|
-
/** @description Filter: feature, bug, tech_debt, architecture_gap, documentation_gap, risk,
|
|
10544
|
+
/** @description Filter by type: feature, enhancement, bug, tech_debt, architecture_gap, documentation_gap, risk, epic, user_story, requirement, test_case, spike, task. Tasks (is_task=true) always have type='task'. */
|
|
10543
10545
|
type?: string;
|
|
10544
10546
|
/** @description Filter: low, medium, high, critical. */
|
|
10545
10547
|
priority?: string;
|
|
@@ -10569,7 +10571,7 @@ export interface operations {
|
|
|
10569
10571
|
limit?: number;
|
|
10570
10572
|
/** @description Pagination offset. */
|
|
10571
10573
|
offset?: number;
|
|
10572
|
-
/** @description Field projection. Valid fields: id, friendly_id, friendlyId, title, type, status, priority, source, category_id, categoryId, created_at, createdAt, updated_at, updatedAt, href. */
|
|
10574
|
+
/** @description Field projection. Valid fields: id, friendly_id, friendlyId, title, type, status, priority, source, category_id, categoryId, parent_item_id, parentItemId, parentItem, created_at, createdAt, updated_at, updatedAt, versionTimestamp, href. */
|
|
10573
10575
|
fields?: string[];
|
|
10574
10576
|
};
|
|
10575
10577
|
};
|
|
@@ -10739,8 +10741,65 @@ export interface operations {
|
|
|
10739
10741
|
"application/json": {
|
|
10740
10742
|
projectId: string;
|
|
10741
10743
|
title: string;
|
|
10742
|
-
/** @description Type. Default: enhancement.
|
|
10744
|
+
/** @description Type. Default: enhancement. One of: feature (New capability for users); enhancement (An improvement to something that already exists); bug (Something that does not work as it should); tech_debt (Work that makes the system easier and safer to change); architecture_gap (A missing or weak part of the architecture); documentation_gap (Documentation that is missing or out of date); risk (Something that could go wrong, to track and reduce); epic (A large body of work, delivered through several stories, features or tasks); user_story (A need told from a user's view: as a role, I want a goal, so that a benefit); requirement (A condition or capability the solution must meet, stated so it can be verified); test_case (Steps that verify a requirement or story, each with its expected result); spike (Time-boxed research to answer a question before committing to the work); task (A unit of work in a plan). Despite the tool's name there is no 'improvement' value: pass it and it is accepted as an alias for 'enhancement', which is also the default. Setting type='task' makes the row a task; any other type makes it a non-task item. The id's prefix follows the type: epic EPIC-, user_story STY-, requirement REQ-, test_case TC-, spike SPK-, task TAS-; every other type IMP-. The number is shared by every type and never changes: a type change rewrites only the prefix (STY-30 becomes IMP-30), and the old id still resolves. Types with fields of their own (epic, user_story, requirement, test_case, spike) take them in details. */
|
|
10743
10745
|
type?: string;
|
|
10746
|
+
/** @description The type's own fields. On update they MERGE key by key: keys you leave out are kept and null removes one. epic: success_measures. user_story: as_a, i_want, so_that (read as 'As a <as_a>, I want <i_want>, so that <so_that>') and story_points. requirement: statement ('The system shall...'), requirement_kind, rationale, source, verification_method. test_case: preconditions, test_steps (ordered { action, expected }), test_data, last_result, last_run_on. spike: question, timebox, findings. An item keeps its details when its type changes. */
|
|
10747
|
+
details?: {
|
|
10748
|
+
/** @description Success Measures (How will you know this epic delivered its outcome?) */
|
|
10749
|
+
success_measures?: string | null;
|
|
10750
|
+
/** @description As a (role or persona) */
|
|
10751
|
+
as_a?: string | null;
|
|
10752
|
+
/** @description I want (what they want to do) */
|
|
10753
|
+
i_want?: string | null;
|
|
10754
|
+
/** @description So that (the benefit to them) */
|
|
10755
|
+
so_that?: string | null;
|
|
10756
|
+
/** @description Story Points (e.g. 3) */
|
|
10757
|
+
story_points?: number | null;
|
|
10758
|
+
/** @description Requirement (The system shall...) */
|
|
10759
|
+
statement?: string | null;
|
|
10760
|
+
/**
|
|
10761
|
+
* @description Kind
|
|
10762
|
+
* @enum {string|null}
|
|
10763
|
+
*/
|
|
10764
|
+
requirement_kind?: "functional" | "non_functional" | "interface" | "data" | "business_rule" | "constraint" | "compliance" | null;
|
|
10765
|
+
/** @description Rationale (Why it is needed...) */
|
|
10766
|
+
rationale?: string | null;
|
|
10767
|
+
/** @description Source (A stakeholder, regulation or document) */
|
|
10768
|
+
source?: string | null;
|
|
10769
|
+
/**
|
|
10770
|
+
* @description Verified By
|
|
10771
|
+
* @enum {string|null}
|
|
10772
|
+
*/
|
|
10773
|
+
verification_method?: "test" | "inspection" | "analysis" | "demonstration" | null;
|
|
10774
|
+
/** @description Preconditions (What must be true before the test starts...) */
|
|
10775
|
+
preconditions?: string | null;
|
|
10776
|
+
/** @description Test Steps, in order. The list you send REPLACES the stored one. */
|
|
10777
|
+
test_steps?: {
|
|
10778
|
+
/** @description Optional; minted if omitted. Echo it back on the steps you keep. */
|
|
10779
|
+
id?: string;
|
|
10780
|
+
/** @description What the tester does. */
|
|
10781
|
+
action?: string;
|
|
10782
|
+
/** @description What should happen. */
|
|
10783
|
+
expected?: string;
|
|
10784
|
+
}[] | null;
|
|
10785
|
+
/** @description Test Data (Inputs, accounts or records the steps use...) */
|
|
10786
|
+
test_data?: string | null;
|
|
10787
|
+
/**
|
|
10788
|
+
* @description Last Result
|
|
10789
|
+
* @enum {string|null}
|
|
10790
|
+
*/
|
|
10791
|
+
last_result?: "not_run" | "passed" | "failed" | "blocked" | null;
|
|
10792
|
+
/** @description Last Run, YYYY-MM-DD. */
|
|
10793
|
+
last_run_on?: string | null;
|
|
10794
|
+
/** @description Question (What does this spike need to find out?) */
|
|
10795
|
+
question?: string | null;
|
|
10796
|
+
/** @description Timebox (e.g. 3 days) */
|
|
10797
|
+
timebox?: string | null;
|
|
10798
|
+
/** @description Findings (What was learned, and the recommendation...) */
|
|
10799
|
+
findings?: string | null;
|
|
10800
|
+
};
|
|
10801
|
+
/** @description The work item this one belongs to in the work hierarchy: an epic for a story, a story for its tasks or test cases. Any item in the same project, in any plan or phase. Not the plan outline nesting, which setPlanItemParent sets. Give its UUID or friendly id (such as IMP-12 or TAS-3). Rules: the same project; no loops (an item cannot sit inside its own children); at most 5 levels, counting this item's own children. */
|
|
10802
|
+
parentItemId?: string;
|
|
10744
10803
|
/** @description Priority. Default: medium. */
|
|
10745
10804
|
priority?: string;
|
|
10746
10805
|
/**
|
|
@@ -10824,7 +10883,7 @@ export interface operations {
|
|
|
10824
10883
|
plan_id?: string;
|
|
10825
10884
|
/** @description Assign to a phase. */
|
|
10826
10885
|
phase_id?: string;
|
|
10827
|
-
/** @description Mark as task. Default: false. Prefer setting type='task' instead
|
|
10886
|
+
/** @description Mark as task. Default: false. Prefer setting type='task' instead: is_task is kept in sync from the type by a DB trigger, and the friendly id's prefix follows the type too (see type). */
|
|
10828
10887
|
is_task?: boolean;
|
|
10829
10888
|
description?: string;
|
|
10830
10889
|
/** @description Work breakdown structure code. */
|
|
@@ -10837,6 +10896,8 @@ export interface operations {
|
|
|
10837
10896
|
relationships?: Record<string, never>;
|
|
10838
10897
|
/** @description Free-form JSON stored alongside the item. On updateImprovement this MERGES rather than replaces. */
|
|
10839
10898
|
metadata?: Record<string, never>;
|
|
10899
|
+
/** @description Optional. Answer with only these fields instead of the whole improvement, for example ["id", "versionTimestamp"]. Any of the improvement's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored. */
|
|
10900
|
+
fields?: string[];
|
|
10840
10901
|
};
|
|
10841
10902
|
};
|
|
10842
10903
|
};
|
|
@@ -10920,11 +10981,72 @@ export interface operations {
|
|
|
10920
10981
|
"application/json": {
|
|
10921
10982
|
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
10922
10983
|
projectId?: string;
|
|
10923
|
-
|
|
10924
|
-
|
|
10925
|
-
|
|
10984
|
+
/** @description Optional. Narrows a friendly-id lookup (such as IMP-42) to one plan, given as the plan's UUID or friendly id (such as PLN-3): the item must be in that plan. It never moves anything (plan_id does that) and is ignored when the id is a UUID. */
|
|
10985
|
+
planId?: string;
|
|
10986
|
+
/** @description Required unless you send items. The improvement's UUID or friendly id (such as IMP-42). */
|
|
10987
|
+
improvementId?: string;
|
|
10988
|
+
/** @description Required unless you send items. The item's current versionTimestamp (its updated_at in epoch ms), as listImprovements, getPlan, getImprovement or your last write of it returned. */
|
|
10989
|
+
versionTimestamp?: number;
|
|
10926
10990
|
title?: string;
|
|
10991
|
+
/** @description One of: feature (New capability for users); enhancement (An improvement to something that already exists); bug (Something that does not work as it should); tech_debt (Work that makes the system easier and safer to change); architecture_gap (A missing or weak part of the architecture); documentation_gap (Documentation that is missing or out of date); risk (Something that could go wrong, to track and reduce); epic (A large body of work, delivered through several stories, features or tasks); user_story (A need told from a user's view: as a role, I want a goal, so that a benefit); requirement (A condition or capability the solution must meet, stated so it can be verified); test_case (Steps that verify a requirement or story, each with its expected result); spike (Time-boxed research to answer a question before committing to the work); task (A unit of work in a plan). Changing the type keeps everything written on the item, its parent and children included. The id's prefix follows the type (see createImprovement's type) and its number stays, so the id can change (STY-30 becomes IMP-30 when a story becomes a feature): the answer's note then gives the new id, and the old one still resolves. */
|
|
10927
10992
|
type?: string;
|
|
10993
|
+
/** @description The type's own fields. On update they MERGE key by key: keys you leave out are kept and null removes one. epic: success_measures. user_story: as_a, i_want, so_that (read as 'As a <as_a>, I want <i_want>, so that <so_that>') and story_points. requirement: statement ('The system shall...'), requirement_kind, rationale, source, verification_method. test_case: preconditions, test_steps (ordered { action, expected }), test_data, last_result, last_run_on. spike: question, timebox, findings. An item keeps its details when its type changes. */
|
|
10994
|
+
details?: {
|
|
10995
|
+
/** @description Success Measures (How will you know this epic delivered its outcome?) */
|
|
10996
|
+
success_measures?: string | null;
|
|
10997
|
+
/** @description As a (role or persona) */
|
|
10998
|
+
as_a?: string | null;
|
|
10999
|
+
/** @description I want (what they want to do) */
|
|
11000
|
+
i_want?: string | null;
|
|
11001
|
+
/** @description So that (the benefit to them) */
|
|
11002
|
+
so_that?: string | null;
|
|
11003
|
+
/** @description Story Points (e.g. 3) */
|
|
11004
|
+
story_points?: number | null;
|
|
11005
|
+
/** @description Requirement (The system shall...) */
|
|
11006
|
+
statement?: string | null;
|
|
11007
|
+
/**
|
|
11008
|
+
* @description Kind
|
|
11009
|
+
* @enum {string|null}
|
|
11010
|
+
*/
|
|
11011
|
+
requirement_kind?: "functional" | "non_functional" | "interface" | "data" | "business_rule" | "constraint" | "compliance" | null;
|
|
11012
|
+
/** @description Rationale (Why it is needed...) */
|
|
11013
|
+
rationale?: string | null;
|
|
11014
|
+
/** @description Source (A stakeholder, regulation or document) */
|
|
11015
|
+
source?: string | null;
|
|
11016
|
+
/**
|
|
11017
|
+
* @description Verified By
|
|
11018
|
+
* @enum {string|null}
|
|
11019
|
+
*/
|
|
11020
|
+
verification_method?: "test" | "inspection" | "analysis" | "demonstration" | null;
|
|
11021
|
+
/** @description Preconditions (What must be true before the test starts...) */
|
|
11022
|
+
preconditions?: string | null;
|
|
11023
|
+
/** @description Test Steps, in order. The list you send REPLACES the stored one. */
|
|
11024
|
+
test_steps?: {
|
|
11025
|
+
/** @description Optional; minted if omitted. Echo it back on the steps you keep. */
|
|
11026
|
+
id?: string;
|
|
11027
|
+
/** @description What the tester does. */
|
|
11028
|
+
action?: string;
|
|
11029
|
+
/** @description What should happen. */
|
|
11030
|
+
expected?: string;
|
|
11031
|
+
}[] | null;
|
|
11032
|
+
/** @description Test Data (Inputs, accounts or records the steps use...) */
|
|
11033
|
+
test_data?: string | null;
|
|
11034
|
+
/**
|
|
11035
|
+
* @description Last Result
|
|
11036
|
+
* @enum {string|null}
|
|
11037
|
+
*/
|
|
11038
|
+
last_result?: "not_run" | "passed" | "failed" | "blocked" | null;
|
|
11039
|
+
/** @description Last Run, YYYY-MM-DD. */
|
|
11040
|
+
last_run_on?: string | null;
|
|
11041
|
+
/** @description Question (What does this spike need to find out?) */
|
|
11042
|
+
question?: string | null;
|
|
11043
|
+
/** @description Timebox (e.g. 3 days) */
|
|
11044
|
+
timebox?: string | null;
|
|
11045
|
+
/** @description Findings (What was learned, and the recommendation...) */
|
|
11046
|
+
findings?: string | null;
|
|
11047
|
+
};
|
|
11048
|
+
/** @description The work item this one belongs to in the work hierarchy: an epic for a story, a story for its tasks or test cases. Any item in the same project, in any plan or phase. Not the plan outline nesting, which setPlanItemParent sets. Give its UUID or friendly id (such as IMP-12 or TAS-3). Rules: the same project; no loops (an item cannot sit inside its own children); at most 5 levels, counting this item's own children. null removes the parent. */
|
|
11049
|
+
parentItemId?: string | null;
|
|
10928
11050
|
/** @enum {string} */
|
|
10929
11051
|
status?: "captured" | "triaging" | "shaped" | "approved" | "ready_for_agent" | "in_progress" | "ready_for_review" | "in_review" | "blocked" | "done" | "rejected" | "deferred";
|
|
10930
11052
|
priority?: string;
|
|
@@ -11022,6 +11144,108 @@ export interface operations {
|
|
|
11022
11144
|
wbs_code?: string;
|
|
11023
11145
|
/** @description Progress percentage (0-100). Null to clear. */
|
|
11024
11146
|
percent_complete?: number;
|
|
11147
|
+
/** @description Optional. Answer with only these fields instead of the whole improvement, for example ["id", "versionTimestamp"]. Any of the improvement's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored. */
|
|
11148
|
+
fields?: string[];
|
|
11149
|
+
/** @description Optional bulk form: update up to 200 improvements in one call, each entry { improvementId, versionTimestamp, ...the fields to change } with the same fields as a single call. Every entry is checked and written on its own (permission, optimistic lock, audit), so one entry's conflict or error never stops the others. The answer has one row per entry, in your order: { index, id, status: "updated", versionTimestamp } or { index, id, status: "conflict" or "failed", error } (a conflict also carries currentVersionTimestamp), plus summary { requested, updated, failed, conflicts }. With items, send nothing else at the top level except projectId, planId and fields; fields then picks extra fields for each updated row (a row's status is its outcome, so the improvement's own status comes back as improvementStatus). */
|
|
11150
|
+
items?: {
|
|
11151
|
+
improvementId: string;
|
|
11152
|
+
versionTimestamp: number;
|
|
11153
|
+
title?: string;
|
|
11154
|
+
type?: string;
|
|
11155
|
+
details?: {
|
|
11156
|
+
success_measures?: string | null;
|
|
11157
|
+
as_a?: string | null;
|
|
11158
|
+
i_want?: string | null;
|
|
11159
|
+
so_that?: string | null;
|
|
11160
|
+
story_points?: number | null;
|
|
11161
|
+
statement?: string | null;
|
|
11162
|
+
/** @enum {string|null} */
|
|
11163
|
+
requirement_kind?: "functional" | "non_functional" | "interface" | "data" | "business_rule" | "constraint" | "compliance" | null;
|
|
11164
|
+
rationale?: string | null;
|
|
11165
|
+
source?: string | null;
|
|
11166
|
+
/** @enum {string|null} */
|
|
11167
|
+
verification_method?: "test" | "inspection" | "analysis" | "demonstration" | null;
|
|
11168
|
+
preconditions?: string | null;
|
|
11169
|
+
test_steps?: {
|
|
11170
|
+
id?: string;
|
|
11171
|
+
action?: string;
|
|
11172
|
+
expected?: string;
|
|
11173
|
+
}[] | null;
|
|
11174
|
+
test_data?: string | null;
|
|
11175
|
+
/** @enum {string|null} */
|
|
11176
|
+
last_result?: "not_run" | "passed" | "failed" | "blocked" | null;
|
|
11177
|
+
last_run_on?: string | null;
|
|
11178
|
+
question?: string | null;
|
|
11179
|
+
timebox?: string | null;
|
|
11180
|
+
findings?: string | null;
|
|
11181
|
+
};
|
|
11182
|
+
parentItemId?: string | null;
|
|
11183
|
+
/** @enum {string} */
|
|
11184
|
+
status?: "captured" | "triaging" | "shaped" | "approved" | "ready_for_agent" | "in_progress" | "ready_for_review" | "in_review" | "blocked" | "done" | "rejected" | "deferred";
|
|
11185
|
+
priority?: string;
|
|
11186
|
+
urgency?: string;
|
|
11187
|
+
owner_id?: string | null;
|
|
11188
|
+
owner_team_id?: string | null;
|
|
11189
|
+
target_date?: string;
|
|
11190
|
+
start_date?: string;
|
|
11191
|
+
end_date?: string;
|
|
11192
|
+
category_id?: string;
|
|
11193
|
+
position?: number;
|
|
11194
|
+
problem_statement?: string;
|
|
11195
|
+
desired_outcome?: string;
|
|
11196
|
+
business_impact?: string;
|
|
11197
|
+
user_impact?: string;
|
|
11198
|
+
why_now?: string;
|
|
11199
|
+
acceptance_criteria?: (string | {
|
|
11200
|
+
id?: string;
|
|
11201
|
+
text: string;
|
|
11202
|
+
updated_at?: string;
|
|
11203
|
+
updated_by?: string;
|
|
11204
|
+
updated_by_credential_name?: string;
|
|
11205
|
+
})[];
|
|
11206
|
+
checklist?: {
|
|
11207
|
+
id?: string;
|
|
11208
|
+
text: string;
|
|
11209
|
+
due_date?: string;
|
|
11210
|
+
completed?: boolean;
|
|
11211
|
+
completed_at?: string;
|
|
11212
|
+
completed_by?: string;
|
|
11213
|
+
completed_by_credential_name?: string;
|
|
11214
|
+
updated_at?: string;
|
|
11215
|
+
updated_by?: string;
|
|
11216
|
+
updated_by_credential_name?: string;
|
|
11217
|
+
}[];
|
|
11218
|
+
constraints?: string[];
|
|
11219
|
+
non_goals?: string[];
|
|
11220
|
+
impacted_documents?: Record<string, never>[];
|
|
11221
|
+
linked_document_ids?: string[];
|
|
11222
|
+
impacted_diagrams?: Record<string, never>[];
|
|
11223
|
+
impacted_components?: string[];
|
|
11224
|
+
impacted_repositories?: string[];
|
|
11225
|
+
agent_ready?: boolean;
|
|
11226
|
+
agent_missing_info?: string[];
|
|
11227
|
+
agent_recommended_action?: string;
|
|
11228
|
+
agent_complexity?: string;
|
|
11229
|
+
agent_confidence?: number;
|
|
11230
|
+
agent_brief?: string;
|
|
11231
|
+
resolution_summary?: string;
|
|
11232
|
+
resolution_pr_url?: string;
|
|
11233
|
+
docs_updated?: boolean;
|
|
11234
|
+
follow_up_needed?: boolean;
|
|
11235
|
+
blocked_comment?: string;
|
|
11236
|
+
rejection_comment?: string;
|
|
11237
|
+
completion_comment?: string;
|
|
11238
|
+
reopened_comment?: string;
|
|
11239
|
+
relationships?: Record<string, never>;
|
|
11240
|
+
metadata?: Record<string, never>;
|
|
11241
|
+
metadata_replace?: boolean;
|
|
11242
|
+
plan_id?: string;
|
|
11243
|
+
phase_id?: string;
|
|
11244
|
+
is_task?: boolean;
|
|
11245
|
+
description?: string;
|
|
11246
|
+
wbs_code?: string;
|
|
11247
|
+
percent_complete?: number;
|
|
11248
|
+
}[];
|
|
11025
11249
|
};
|
|
11026
11250
|
};
|
|
11027
11251
|
};
|
|
@@ -12091,7 +12315,7 @@ export interface operations {
|
|
|
12091
12315
|
limit?: number;
|
|
12092
12316
|
/** @description Pagination offset. */
|
|
12093
12317
|
offset?: number;
|
|
12094
|
-
/** @description Field projection. Valid fields: id, friendly_id, friendlyId, title, description, status, priority, icon, color, start_date, startDate, end_date, endDate, created_at, createdAt, updated_at, updatedAt, href. */
|
|
12318
|
+
/** @description Field projection. Valid fields: id, friendly_id, friendlyId, title, description, status, priority, icon, color, start_date, startDate, end_date, endDate, created_at, createdAt, updated_at, updatedAt, versionTimestamp, href. */
|
|
12095
12319
|
fields?: string[];
|
|
12096
12320
|
};
|
|
12097
12321
|
};
|
|
@@ -12281,6 +12505,8 @@ export interface operations {
|
|
|
12281
12505
|
linked_documents?: Record<string, never>[];
|
|
12282
12506
|
/** @description Document IDs to link. */
|
|
12283
12507
|
linked_document_ids?: string[];
|
|
12508
|
+
/** @description Optional. Answer with only these fields instead of the whole plan, for example ["id", "versionTimestamp"]. Any of the plan's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored. */
|
|
12509
|
+
fields?: string[];
|
|
12284
12510
|
};
|
|
12285
12511
|
};
|
|
12286
12512
|
};
|
|
@@ -12365,7 +12591,7 @@ export interface operations {
|
|
|
12365
12591
|
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
12366
12592
|
projectId?: string;
|
|
12367
12593
|
planId: string;
|
|
12368
|
-
/** @description
|
|
12594
|
+
/** @description The plan's current versionTimestamp (its updated_at in epoch ms), as listPlans, getPlan or your last write of it returned. */
|
|
12369
12595
|
versionTimestamp: number;
|
|
12370
12596
|
title?: string;
|
|
12371
12597
|
description?: string;
|
|
@@ -12383,6 +12609,8 @@ export interface operations {
|
|
|
12383
12609
|
/** @description Document IDs to link. */
|
|
12384
12610
|
linked_document_ids?: string[];
|
|
12385
12611
|
metadata?: Record<string, never>;
|
|
12612
|
+
/** @description Optional. Answer with only these fields instead of the whole plan, for example ["id", "versionTimestamp"]. Any of the plan's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored. */
|
|
12613
|
+
fields?: string[];
|
|
12386
12614
|
};
|
|
12387
12615
|
};
|
|
12388
12616
|
};
|
|
@@ -12632,6 +12860,8 @@ export interface operations {
|
|
|
12632
12860
|
"application/json": {
|
|
12633
12861
|
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
12634
12862
|
projectId?: string;
|
|
12863
|
+
/** @description Optional. Narrows a friendly-id lookup to one plan, given as the plan's UUID or friendly id (such as PLN-3). Phase ids are numbered per plan, so PHA-2 exists in every plan and planId is what makes one unique. Ignored when phaseId is a UUID. */
|
|
12864
|
+
planId?: string;
|
|
12635
12865
|
/** @description Accepts either the UUID or the friendly id (e.g. PHA-7); friendly ids are resolved within your organisation. */
|
|
12636
12866
|
phaseId: string;
|
|
12637
12867
|
};
|
|
@@ -12726,15 +12956,22 @@ export interface operations {
|
|
|
12726
12956
|
position?: number;
|
|
12727
12957
|
/** @description WBS code. Auto-computed if omitted. */
|
|
12728
12958
|
wbs_code?: string;
|
|
12729
|
-
/**
|
|
12959
|
+
/**
|
|
12960
|
+
* @description auto (default): the phase's dates follow its tasks, from the earliest task start to the latest task end, updated whenever a task is added, moved, re-dated or removed; start_date/end_date only hold while no task in the phase has dates. manual: the dates you set are kept as they are.
|
|
12961
|
+
* @enum {string}
|
|
12962
|
+
*/
|
|
12963
|
+
date_mode?: "auto" | "manual";
|
|
12964
|
+
/** @description YYYY-MM-DD. With date_mode 'auto' it is replaced by the tasks' range once a task in the phase has dates. */
|
|
12730
12965
|
start_date?: string;
|
|
12731
|
-
/** @description YYYY-MM-DD. */
|
|
12966
|
+
/** @description YYYY-MM-DD, on or after start_date. With date_mode 'auto' it is replaced by the tasks' range once a task in the phase has dates. */
|
|
12732
12967
|
end_date?: string;
|
|
12733
12968
|
/**
|
|
12734
12969
|
* @description Phase color. Must be one of: #3b82f6 (Blue), #f59e0b (Amber), #8b5cf6 (Purple), #ec4899 (Pink), #06b6d4 (Cyan), #14b8a6 (Teal), #6366f1 (Indigo), #6b7280 (Gray). Red and green are reserved for blocked / done item statuses.
|
|
12735
12970
|
* @enum {string}
|
|
12736
12971
|
*/
|
|
12737
12972
|
color?: "#3b82f6" | "#f59e0b" | "#8b5cf6" | "#ec4899" | "#06b6d4" | "#14b8a6" | "#6366f1" | "#6b7280";
|
|
12973
|
+
/** @description Optional. Answer with only these fields instead of the whole phase, for example ["id", "versionTimestamp"]. Any of the phase's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored. */
|
|
12974
|
+
fields?: string[];
|
|
12738
12975
|
};
|
|
12739
12976
|
};
|
|
12740
12977
|
};
|
|
@@ -12818,9 +13055,12 @@ export interface operations {
|
|
|
12818
13055
|
"application/json": {
|
|
12819
13056
|
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
12820
13057
|
projectId?: string;
|
|
12821
|
-
phaseId
|
|
12822
|
-
|
|
12823
|
-
|
|
13058
|
+
/** @description Optional. Narrows a friendly-id lookup to one plan, given as the plan's UUID or friendly id (such as PLN-3). Phase ids are numbered per plan, so PHA-2 exists in every plan and planId is what makes one unique. Ignored when phaseId is a UUID. */
|
|
13059
|
+
planId?: string;
|
|
13060
|
+
/** @description Required unless you send items. The phase's UUID or friendly id (such as PHA-7); with a friendly id, give planId too, since PHA- ids repeat in every plan. */
|
|
13061
|
+
phaseId?: string;
|
|
13062
|
+
/** @description Required unless you send items. The phase's own current versionTimestamp (its updated_at in epoch ms), as listPlanPhases, getPlan (phases[].versionTimestamp), getPlanPhase or your last write of it returned. Not the plan's. */
|
|
13063
|
+
versionTimestamp?: number;
|
|
12824
13064
|
name?: string;
|
|
12825
13065
|
description?: string;
|
|
12826
13066
|
/** @description Status: not_started, in_progress, completed, on_hold, cancelled. */
|
|
@@ -12829,13 +13069,39 @@ export interface operations {
|
|
|
12829
13069
|
priority?: string;
|
|
12830
13070
|
position?: number;
|
|
12831
13071
|
wbs_code?: string;
|
|
12832
|
-
|
|
12833
|
-
|
|
13072
|
+
/**
|
|
13073
|
+
* @description auto: the phase's dates follow its tasks (earliest task start to latest task end, kept current). manual: the dates you set are kept. Switching to auto recomputes the dates at once when the phase has dated tasks.
|
|
13074
|
+
* @enum {string}
|
|
13075
|
+
*/
|
|
13076
|
+
date_mode?: "auto" | "manual";
|
|
13077
|
+
/** @description YYYY-MM-DD, or null to clear. While date_mode is 'auto' and the phase has dated tasks, the tasks' range wins and the reply carries a note saying so; send date_mode 'manual' with it to set it by hand. */
|
|
13078
|
+
start_date?: string | null;
|
|
13079
|
+
/** @description YYYY-MM-DD on or after start_date, or null to clear. While date_mode is 'auto' and the phase has dated tasks, the tasks' range wins and the reply carries a note saying so; send date_mode 'manual' with it to set it by hand. */
|
|
13080
|
+
end_date?: string | null;
|
|
12834
13081
|
/**
|
|
12835
13082
|
* @description Phase color. Must be one of: #3b82f6 (Blue), #f59e0b (Amber), #8b5cf6 (Purple), #ec4899 (Pink), #06b6d4 (Cyan), #14b8a6 (Teal), #6366f1 (Indigo), #6b7280 (Gray). Red and green are reserved for blocked / done item statuses. Pass null to clear.
|
|
12836
13083
|
* @enum {string|null}
|
|
12837
13084
|
*/
|
|
12838
13085
|
color?: "#3b82f6" | "#f59e0b" | "#8b5cf6" | "#ec4899" | "#06b6d4" | "#14b8a6" | "#6366f1" | "#6b7280" | null;
|
|
13086
|
+
/** @description Optional. Answer with only these fields instead of the whole phase, for example ["id", "versionTimestamp"]. Any of the phase's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored. */
|
|
13087
|
+
fields?: string[];
|
|
13088
|
+
/** @description Optional bulk form: update up to 200 phases in one call, each entry { phaseId, versionTimestamp, ...the fields to change } with the same fields as a single call. Every entry is checked and written on its own (permission, optimistic lock, audit), so one entry's conflict or error never stops the others. The answer has one row per entry, in your order: { index, id, status: "updated", versionTimestamp } or { index, id, status: "conflict" or "failed", error } (a conflict also carries currentVersionTimestamp), plus summary { requested, updated, failed, conflicts }. With items, send nothing else at the top level except projectId, planId and fields; fields then picks extra fields for each updated row (a row's status is its outcome, so the phase's own status comes back as phaseStatus). */
|
|
13089
|
+
items?: {
|
|
13090
|
+
phaseId: string;
|
|
13091
|
+
versionTimestamp: number;
|
|
13092
|
+
name?: string;
|
|
13093
|
+
description?: string;
|
|
13094
|
+
status?: string;
|
|
13095
|
+
priority?: string;
|
|
13096
|
+
position?: number;
|
|
13097
|
+
wbs_code?: string;
|
|
13098
|
+
/** @enum {string} */
|
|
13099
|
+
date_mode?: "auto" | "manual";
|
|
13100
|
+
start_date?: string | null;
|
|
13101
|
+
end_date?: string | null;
|
|
13102
|
+
/** @enum {string|null} */
|
|
13103
|
+
color?: "#3b82f6" | "#f59e0b" | "#8b5cf6" | "#ec4899" | "#06b6d4" | "#14b8a6" | "#6366f1" | "#6b7280" | null;
|
|
13104
|
+
}[];
|
|
12839
13105
|
};
|
|
12840
13106
|
};
|
|
12841
13107
|
};
|
|
@@ -12919,6 +13185,8 @@ export interface operations {
|
|
|
12919
13185
|
"application/json": {
|
|
12920
13186
|
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
12921
13187
|
projectId?: string;
|
|
13188
|
+
/** @description Optional. Narrows a friendly-id lookup to one plan, given as the plan's UUID or friendly id (such as PLN-3). Phase ids are numbered per plan, so PHA-2 exists in every plan and planId is what makes one unique. Ignored when phaseId is a UUID. */
|
|
13189
|
+
planId?: string;
|
|
12922
13190
|
phaseId: string;
|
|
12923
13191
|
};
|
|
12924
13192
|
};
|
|
@@ -13357,8 +13625,10 @@ export interface operations {
|
|
|
13357
13625
|
title: string;
|
|
13358
13626
|
/** @description Phase to assign to. */
|
|
13359
13627
|
phaseId?: string;
|
|
13628
|
+
/** @description The work item this one belongs to in the work hierarchy: an epic for a story, a story for its tasks or test cases. Any item in the same project, in any plan or phase. Not the plan outline nesting, which setPlanItemParent sets. Give its UUID or friendly id (such as IMP-12 or TAS-3). Rules: the same project; no loops (an item cannot sit inside its own children); at most 5 levels, counting this item's own children. */
|
|
13629
|
+
parentItemId?: string;
|
|
13360
13630
|
description?: string;
|
|
13361
|
-
/** @description Type. Default: task
|
|
13631
|
+
/** @description Type. Default: task, which takes a TAS- id. Override only to put another kind of work item in the plan, for example a user_story (a STY- id) or a test_case (a TC- id); the id's prefix follows the type. Valid values: feature, enhancement, bug, tech_debt, architecture_gap, documentation_gap, risk, epic, user_story, requirement, test_case, spike, task. */
|
|
13362
13632
|
type?: string;
|
|
13363
13633
|
/**
|
|
13364
13634
|
* @description Initial status. Default: captured.
|
|
@@ -13449,6 +13719,8 @@ export interface operations {
|
|
|
13449
13719
|
relationships?: Record<string, never>;
|
|
13450
13720
|
/** @description Free-form JSON stored alongside the task. On updateTask this MERGES rather than replaces. */
|
|
13451
13721
|
metadata?: Record<string, never>;
|
|
13722
|
+
/** @description Optional. Answer with only these fields instead of the whole task, for example ["id", "versionTimestamp"]. Any of the task's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored. */
|
|
13723
|
+
fields?: string[];
|
|
13452
13724
|
};
|
|
13453
13725
|
};
|
|
13454
13726
|
};
|
|
@@ -13537,6 +13809,8 @@ export interface operations {
|
|
|
13537
13809
|
priority?: string;
|
|
13538
13810
|
/** @description Filter by phase. */
|
|
13539
13811
|
phaseId?: string;
|
|
13812
|
+
/** @description Only the children of this item in the work hierarchy (its UUID or friendly id, such as IMP-12), whatever plan or phase they are in. "none" lists only the items with no parent. The work hierarchy is not the plan outline nesting (setPlanItemParent). */
|
|
13813
|
+
parentItemId?: string;
|
|
13540
13814
|
/** @description Grep across title, friendlyId and description. Substring by default; a regular expression when isRegex:true; case-insensitive unless caseSensitive:true. */
|
|
13541
13815
|
query?: string;
|
|
13542
13816
|
/** @description Treat query as a regular expression (grep -E), e.g. "ACME-\d+". Default false (literal substring). */
|
|
@@ -13719,11 +13993,17 @@ export interface operations {
|
|
|
13719
13993
|
"application/json": {
|
|
13720
13994
|
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
13721
13995
|
projectId?: string;
|
|
13722
|
-
|
|
13723
|
-
|
|
13724
|
-
|
|
13996
|
+
/** @description Optional. Narrows a friendly-id lookup (such as TAS-55) to one plan, given as the plan's UUID or friendly id (such as PLN-3): the task must be in that plan. It never moves anything (plan_id does that) and is ignored when the id is a UUID. */
|
|
13997
|
+
planId?: string;
|
|
13998
|
+
/** @description Required unless you send items. The task's UUID or friendly id (such as TAS-55). */
|
|
13999
|
+
taskId?: string;
|
|
14000
|
+
/** @description Required unless you send items. The task's current versionTimestamp (its updated_at in epoch ms), as listTasks, getPlan, getTask or your last write of it returned. */
|
|
14001
|
+
versionTimestamp?: number;
|
|
13725
14002
|
title?: string;
|
|
14003
|
+
/** @description Changing the type converts the task and its id takes the new type's prefix, keeping its number (TAS-12 becomes STY-12 as a user_story): the answer's note then gives the new id, and the old one still resolves. */
|
|
13726
14004
|
type?: string;
|
|
14005
|
+
/** @description The work item this one belongs to in the work hierarchy: an epic for a story, a story for its tasks or test cases. Any item in the same project, in any plan or phase. Not the plan outline nesting, which setPlanItemParent sets. Give its UUID or friendly id (such as IMP-12 or TAS-3). Rules: the same project; no loops (an item cannot sit inside its own children); at most 5 levels, counting this item's own children. null removes the parent. */
|
|
14006
|
+
parentItemId?: string | null;
|
|
13727
14007
|
/** @enum {string} */
|
|
13728
14008
|
status?: "captured" | "triaging" | "shaped" | "approved" | "ready_for_agent" | "in_progress" | "ready_for_review" | "in_review" | "blocked" | "done" | "rejected" | "deferred";
|
|
13729
14009
|
priority?: string;
|
|
@@ -13818,6 +14098,79 @@ export interface operations {
|
|
|
13818
14098
|
plan_id?: string;
|
|
13819
14099
|
/** @description Assign to phase. Null to unassign. */
|
|
13820
14100
|
phase_id?: string;
|
|
14101
|
+
/** @description Optional. Answer with only these fields instead of the whole task, for example ["id", "versionTimestamp"]. Any of the task's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored. */
|
|
14102
|
+
fields?: string[];
|
|
14103
|
+
/** @description Optional bulk form: update up to 200 tasks in one call, each entry { taskId, versionTimestamp, ...the fields to change } with the same fields as a single call. Every entry is checked and written on its own (permission, optimistic lock, audit), so one entry's conflict or error never stops the others. The answer has one row per entry, in your order: { index, id, status: "updated", versionTimestamp } or { index, id, status: "conflict" or "failed", error } (a conflict also carries currentVersionTimestamp), plus summary { requested, updated, failed, conflicts }. With items, send nothing else at the top level except projectId, planId and fields; fields then picks extra fields for each updated row (a row's status is its outcome, so the task's own status comes back as taskStatus). */
|
|
14104
|
+
items?: {
|
|
14105
|
+
taskId: string;
|
|
14106
|
+
versionTimestamp: number;
|
|
14107
|
+
title?: string;
|
|
14108
|
+
type?: string;
|
|
14109
|
+
parentItemId?: string | null;
|
|
14110
|
+
/** @enum {string} */
|
|
14111
|
+
status?: "captured" | "triaging" | "shaped" | "approved" | "ready_for_agent" | "in_progress" | "ready_for_review" | "in_review" | "blocked" | "done" | "rejected" | "deferred";
|
|
14112
|
+
priority?: string;
|
|
14113
|
+
urgency?: string;
|
|
14114
|
+
owner_id?: string | null;
|
|
14115
|
+
owner_team_id?: string | null;
|
|
14116
|
+
target_date?: string;
|
|
14117
|
+
start_date?: string;
|
|
14118
|
+
end_date?: string;
|
|
14119
|
+
position?: number;
|
|
14120
|
+
description?: string;
|
|
14121
|
+
wbs_code?: string;
|
|
14122
|
+
percent_complete?: number;
|
|
14123
|
+
problem_statement?: string;
|
|
14124
|
+
desired_outcome?: string;
|
|
14125
|
+
business_impact?: string;
|
|
14126
|
+
user_impact?: string;
|
|
14127
|
+
why_now?: string;
|
|
14128
|
+
acceptance_criteria?: (string | {
|
|
14129
|
+
id?: string;
|
|
14130
|
+
text: string;
|
|
14131
|
+
updated_at?: string;
|
|
14132
|
+
updated_by?: string;
|
|
14133
|
+
updated_by_credential_name?: string;
|
|
14134
|
+
})[];
|
|
14135
|
+
checklist?: {
|
|
14136
|
+
id?: string;
|
|
14137
|
+
text: string;
|
|
14138
|
+
due_date?: string;
|
|
14139
|
+
completed?: boolean;
|
|
14140
|
+
completed_at?: string;
|
|
14141
|
+
completed_by?: string;
|
|
14142
|
+
completed_by_credential_name?: string;
|
|
14143
|
+
updated_at?: string;
|
|
14144
|
+
updated_by?: string;
|
|
14145
|
+
updated_by_credential_name?: string;
|
|
14146
|
+
}[];
|
|
14147
|
+
constraints?: string[];
|
|
14148
|
+
non_goals?: string[];
|
|
14149
|
+
impacted_documents?: Record<string, never>[];
|
|
14150
|
+
linked_document_ids?: string[];
|
|
14151
|
+
impacted_diagrams?: Record<string, never>[];
|
|
14152
|
+
impacted_components?: string[];
|
|
14153
|
+
impacted_repositories?: string[];
|
|
14154
|
+
agent_ready?: boolean;
|
|
14155
|
+
agent_missing_info?: string[];
|
|
14156
|
+
agent_recommended_action?: string;
|
|
14157
|
+
agent_complexity?: string;
|
|
14158
|
+
agent_confidence?: number;
|
|
14159
|
+
agent_brief?: string;
|
|
14160
|
+
resolution_summary?: string;
|
|
14161
|
+
resolution_pr_url?: string;
|
|
14162
|
+
docs_updated?: boolean;
|
|
14163
|
+
follow_up_needed?: boolean;
|
|
14164
|
+
blocked_comment?: string;
|
|
14165
|
+
rejection_comment?: string;
|
|
14166
|
+
completion_comment?: string;
|
|
14167
|
+
reopened_comment?: string;
|
|
14168
|
+
relationships?: Record<string, never>;
|
|
14169
|
+
metadata?: Record<string, never>;
|
|
14170
|
+
metadata_replace?: boolean;
|
|
14171
|
+
plan_id?: string;
|
|
14172
|
+
phase_id?: string;
|
|
14173
|
+
}[];
|
|
13821
14174
|
};
|
|
13822
14175
|
};
|
|
13823
14176
|
};
|
|
@@ -13984,9 +14337,9 @@ export interface operations {
|
|
|
13984
14337
|
requestBody?: {
|
|
13985
14338
|
content: {
|
|
13986
14339
|
"application/json": {
|
|
13987
|
-
/** @description Item ID to
|
|
14340
|
+
/** @description Item ID to indent or un-indent in the plan outline. */
|
|
13988
14341
|
itemId: string;
|
|
13989
|
-
/** @description
|
|
14342
|
+
/** @description The outline parent's ID, in the same plan and phase. Null to un-indent. Not the work hierarchy parent (parentItemId). */
|
|
13990
14343
|
parentId?: string;
|
|
13991
14344
|
};
|
|
13992
14345
|
};
|