sailfork 0.2.1 → 0.3.0
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/AGENTS.md +3 -0
- package/dist/index.cjs +58 -1
- package/dist/index.js +58 -1
- package/dist/tools.cjs +245 -0
- package/dist/tools.js +245 -0
- package/dist/types/core/version.d.ts +1 -1
- package/dist/types/generated/api.d.ts +24 -0
- package/dist/types/generated/index.d.ts +1 -1
- package/dist/types/generated/ops.d.ts +39 -0
- package/dist/types/generated/types.d.ts +90 -0
- package/dist/types-cjs/core/version.d.ts +1 -1
- package/dist/types-cjs/generated/api.d.ts +24 -0
- package/dist/types-cjs/generated/index.d.ts +1 -1
- package/dist/types-cjs/generated/ops.d.ts +39 -0
- package/dist/types-cjs/generated/types.d.ts +90 -0
- package/llms.txt +3 -0
- package/package.json +1 -1
package/AGENTS.md
CHANGED
|
@@ -108,6 +108,8 @@ const repo = sf.repo("acme/api");
|
|
|
108
108
|
|
|
109
109
|
### issues
|
|
110
110
|
|
|
111
|
+
- `sf.issues.answer(input)`: Answer a question on an issue, replacing an earlier answer: `choices` are option labels (one for `single`, any for `multi`), `text` the free-text answer of a `text` question or an `other` answer. You need write access or the issue's lease. Scope `repo:write`, write, retry idempotent.
|
|
112
|
+
- `sf.issues.ask(input)`: Ask a person a question on an issue and read the answer back later from the issue's context (`asks`). `single` takes one of 2 to 10 options, `multi` any number of them, `text` free text; `other` lets a choice question also take free text. The issue reads as needing input, and its assignee is told, until it is answered. You need the issue's lease or write access. Scope `repo:write`, write, retry once.
|
|
111
113
|
- `sf.issues.claim(input)`: Delegate an issue to yourself or your agent for a lease, or renew the lease. The issue returns to ready if the lease lapses. Scope `repo:write`, write, retry idempotent.
|
|
112
114
|
- `sf.issues.close(input)`: Close an issue with a reason, after posting an optional comment. Without a `reason` it is `done`, or `duplicate` when `duplicateOf` names the issue it repeats. Scope `repo:write`, destructive, retry idempotent.
|
|
113
115
|
- `sf.issues.comment(input)`: Comment on an issue, or post a progress update as whoever holds its lease. Scope `repo:write`, write, retry idempotent.
|
|
@@ -128,6 +130,7 @@ const repo = sf.repo("acme/api");
|
|
|
128
130
|
- `sf.issues.similar(input)`: Check for issues the title reads like, open ones closest first, to look through before filing a duplicate. Scope `repo:read`, read, retry safe.
|
|
129
131
|
- `sf.issues.start(input)`: Claim an issue and open a caisson on its branch, or return the live caisson already working on it. Safe to repeat. Scope `repo:write`, write, retry idempotent.
|
|
130
132
|
- `sf.issues.subscribe(input)`: Follow an issue to be notified of its activity, or stop following it. Needs only read access. Scope `repo:read`, write, retry idempotent.
|
|
133
|
+
- `sf.issues.unask(input)`: Take a question back from an issue, answered or not, once its answer is used or it no longer matters. You need the issue's lease or write access. Scope `repo:write`, write, retry idempotent.
|
|
131
134
|
- `sf.issues.unreact(input)`: Take your reaction back from an issue. Scope `repo:read`, write, retry idempotent.
|
|
132
135
|
- `sf.issues.update(input)`: Change any field of an issue. A field left out stays; `null` clears the ones that can be cleared. An issue's author may change its words and whether it is open without write access. Scope `repo:write`, write, retry idempotent.
|
|
133
136
|
|
package/dist/index.cjs
CHANGED
|
@@ -604,7 +604,7 @@ async function resolveToken(host, option) {
|
|
|
604
604
|
}
|
|
605
605
|
|
|
606
606
|
// src/core/version.ts
|
|
607
|
-
var VERSION = "0.
|
|
607
|
+
var VERSION = "0.3.0";
|
|
608
608
|
var API_VERSION = "2026-12-01";
|
|
609
609
|
|
|
610
610
|
// src/core/client.ts
|
|
@@ -1705,6 +1705,32 @@ var ops = {
|
|
|
1705
1705
|
long: false,
|
|
1706
1706
|
paginated: false
|
|
1707
1707
|
},
|
|
1708
|
+
"issues.answer": {
|
|
1709
|
+
id: "issues.answer",
|
|
1710
|
+
method: "POST",
|
|
1711
|
+
path: "/api/repos/{owner}/{repo}/issues/{number}/asks/{id}/answer",
|
|
1712
|
+
pathParams: ["owner", "repo", "number", "id"],
|
|
1713
|
+
queryParams: [],
|
|
1714
|
+
bodyParams: ["choices", "text"],
|
|
1715
|
+
effect: "write",
|
|
1716
|
+
retry: "idempotent",
|
|
1717
|
+
held: false,
|
|
1718
|
+
long: false,
|
|
1719
|
+
paginated: false
|
|
1720
|
+
},
|
|
1721
|
+
"issues.ask": {
|
|
1722
|
+
id: "issues.ask",
|
|
1723
|
+
method: "POST",
|
|
1724
|
+
path: "/api/repos/{owner}/{repo}/issues/{number}/asks",
|
|
1725
|
+
pathParams: ["owner", "repo", "number"],
|
|
1726
|
+
queryParams: [],
|
|
1727
|
+
bodyParams: ["kind", "text", "options", "recommended", "other"],
|
|
1728
|
+
effect: "write",
|
|
1729
|
+
retry: "none",
|
|
1730
|
+
held: false,
|
|
1731
|
+
long: false,
|
|
1732
|
+
paginated: false
|
|
1733
|
+
},
|
|
1708
1734
|
"issues.claim": {
|
|
1709
1735
|
id: "issues.claim",
|
|
1710
1736
|
method: "POST",
|
|
@@ -1965,6 +1991,19 @@ var ops = {
|
|
|
1965
1991
|
long: false,
|
|
1966
1992
|
paginated: false
|
|
1967
1993
|
},
|
|
1994
|
+
"issues.unask": {
|
|
1995
|
+
id: "issues.unask",
|
|
1996
|
+
method: "DELETE",
|
|
1997
|
+
path: "/api/repos/{owner}/{repo}/issues/{number}/asks/{id}",
|
|
1998
|
+
pathParams: ["owner", "repo", "number", "id"],
|
|
1999
|
+
queryParams: [],
|
|
2000
|
+
bodyParams: [],
|
|
2001
|
+
effect: "write",
|
|
2002
|
+
retry: "idempotent",
|
|
2003
|
+
held: false,
|
|
2004
|
+
long: false,
|
|
2005
|
+
paginated: false
|
|
2006
|
+
},
|
|
1968
2007
|
"issues.unreact": {
|
|
1969
2008
|
id: "issues.unreact",
|
|
1970
2009
|
method: "DELETE",
|
|
@@ -2971,6 +3010,12 @@ class IssuesResource {
|
|
|
2971
3010
|
constructor(core) {
|
|
2972
3011
|
this.core = core;
|
|
2973
3012
|
}
|
|
3013
|
+
answer(input, opts) {
|
|
3014
|
+
return this.core.request(ops["issues.answer"], input, opts);
|
|
3015
|
+
}
|
|
3016
|
+
ask(input, opts) {
|
|
3017
|
+
return this.core.request(ops["issues.ask"], input, opts);
|
|
3018
|
+
}
|
|
2974
3019
|
claim(input, opts) {
|
|
2975
3020
|
return this.core.request(ops["issues.claim"], input, opts);
|
|
2976
3021
|
}
|
|
@@ -3032,6 +3077,9 @@ class IssuesResource {
|
|
|
3032
3077
|
subscribe(input, opts) {
|
|
3033
3078
|
return this.core.request(ops["issues.subscribe"], input, opts);
|
|
3034
3079
|
}
|
|
3080
|
+
unask(input, opts) {
|
|
3081
|
+
return this.core.request(ops["issues.unask"], input, opts);
|
|
3082
|
+
}
|
|
3035
3083
|
unreact(input, opts) {
|
|
3036
3084
|
return this.core.request(ops["issues.unreact"], input, opts);
|
|
3037
3085
|
}
|
|
@@ -3584,6 +3632,12 @@ class RepoIssuesResource {
|
|
|
3584
3632
|
this.core = core;
|
|
3585
3633
|
this.bound = bound;
|
|
3586
3634
|
}
|
|
3635
|
+
answer(input, opts) {
|
|
3636
|
+
return this.core.request(ops["issues.answer"], { ...input, owner: this.bound["owner"], repo: this.bound["repo"] }, opts);
|
|
3637
|
+
}
|
|
3638
|
+
ask(input, opts) {
|
|
3639
|
+
return this.core.request(ops["issues.ask"], { ...input, owner: this.bound["owner"], repo: this.bound["repo"] }, opts);
|
|
3640
|
+
}
|
|
3587
3641
|
claim(input, opts) {
|
|
3588
3642
|
return this.core.request(ops["issues.claim"], { ...input, owner: this.bound["owner"], repo: this.bound["repo"] }, opts);
|
|
3589
3643
|
}
|
|
@@ -3642,6 +3696,9 @@ class RepoIssuesResource {
|
|
|
3642
3696
|
subscribe(input, opts) {
|
|
3643
3697
|
return this.core.request(ops["issues.subscribe"], { ...input, owner: this.bound["owner"], repo: this.bound["repo"] }, opts);
|
|
3644
3698
|
}
|
|
3699
|
+
unask(input, opts) {
|
|
3700
|
+
return this.core.request(ops["issues.unask"], { ...input, owner: this.bound["owner"], repo: this.bound["repo"] }, opts);
|
|
3701
|
+
}
|
|
3645
3702
|
unreact(input, opts) {
|
|
3646
3703
|
return this.core.request(ops["issues.unreact"], { ...input, owner: this.bound["owner"], repo: this.bound["repo"] }, opts);
|
|
3647
3704
|
}
|
package/dist/index.js
CHANGED
|
@@ -500,7 +500,7 @@ async function resolveToken(host, option) {
|
|
|
500
500
|
}
|
|
501
501
|
|
|
502
502
|
// src/core/version.ts
|
|
503
|
-
var VERSION = "0.
|
|
503
|
+
var VERSION = "0.3.0";
|
|
504
504
|
var API_VERSION = "2026-12-01";
|
|
505
505
|
|
|
506
506
|
// src/core/client.ts
|
|
@@ -1601,6 +1601,32 @@ var ops = {
|
|
|
1601
1601
|
long: false,
|
|
1602
1602
|
paginated: false
|
|
1603
1603
|
},
|
|
1604
|
+
"issues.answer": {
|
|
1605
|
+
id: "issues.answer",
|
|
1606
|
+
method: "POST",
|
|
1607
|
+
path: "/api/repos/{owner}/{repo}/issues/{number}/asks/{id}/answer",
|
|
1608
|
+
pathParams: ["owner", "repo", "number", "id"],
|
|
1609
|
+
queryParams: [],
|
|
1610
|
+
bodyParams: ["choices", "text"],
|
|
1611
|
+
effect: "write",
|
|
1612
|
+
retry: "idempotent",
|
|
1613
|
+
held: false,
|
|
1614
|
+
long: false,
|
|
1615
|
+
paginated: false
|
|
1616
|
+
},
|
|
1617
|
+
"issues.ask": {
|
|
1618
|
+
id: "issues.ask",
|
|
1619
|
+
method: "POST",
|
|
1620
|
+
path: "/api/repos/{owner}/{repo}/issues/{number}/asks",
|
|
1621
|
+
pathParams: ["owner", "repo", "number"],
|
|
1622
|
+
queryParams: [],
|
|
1623
|
+
bodyParams: ["kind", "text", "options", "recommended", "other"],
|
|
1624
|
+
effect: "write",
|
|
1625
|
+
retry: "none",
|
|
1626
|
+
held: false,
|
|
1627
|
+
long: false,
|
|
1628
|
+
paginated: false
|
|
1629
|
+
},
|
|
1604
1630
|
"issues.claim": {
|
|
1605
1631
|
id: "issues.claim",
|
|
1606
1632
|
method: "POST",
|
|
@@ -1861,6 +1887,19 @@ var ops = {
|
|
|
1861
1887
|
long: false,
|
|
1862
1888
|
paginated: false
|
|
1863
1889
|
},
|
|
1890
|
+
"issues.unask": {
|
|
1891
|
+
id: "issues.unask",
|
|
1892
|
+
method: "DELETE",
|
|
1893
|
+
path: "/api/repos/{owner}/{repo}/issues/{number}/asks/{id}",
|
|
1894
|
+
pathParams: ["owner", "repo", "number", "id"],
|
|
1895
|
+
queryParams: [],
|
|
1896
|
+
bodyParams: [],
|
|
1897
|
+
effect: "write",
|
|
1898
|
+
retry: "idempotent",
|
|
1899
|
+
held: false,
|
|
1900
|
+
long: false,
|
|
1901
|
+
paginated: false
|
|
1902
|
+
},
|
|
1864
1903
|
"issues.unreact": {
|
|
1865
1904
|
id: "issues.unreact",
|
|
1866
1905
|
method: "DELETE",
|
|
@@ -2867,6 +2906,12 @@ class IssuesResource {
|
|
|
2867
2906
|
constructor(core) {
|
|
2868
2907
|
this.core = core;
|
|
2869
2908
|
}
|
|
2909
|
+
answer(input, opts) {
|
|
2910
|
+
return this.core.request(ops["issues.answer"], input, opts);
|
|
2911
|
+
}
|
|
2912
|
+
ask(input, opts) {
|
|
2913
|
+
return this.core.request(ops["issues.ask"], input, opts);
|
|
2914
|
+
}
|
|
2870
2915
|
claim(input, opts) {
|
|
2871
2916
|
return this.core.request(ops["issues.claim"], input, opts);
|
|
2872
2917
|
}
|
|
@@ -2928,6 +2973,9 @@ class IssuesResource {
|
|
|
2928
2973
|
subscribe(input, opts) {
|
|
2929
2974
|
return this.core.request(ops["issues.subscribe"], input, opts);
|
|
2930
2975
|
}
|
|
2976
|
+
unask(input, opts) {
|
|
2977
|
+
return this.core.request(ops["issues.unask"], input, opts);
|
|
2978
|
+
}
|
|
2931
2979
|
unreact(input, opts) {
|
|
2932
2980
|
return this.core.request(ops["issues.unreact"], input, opts);
|
|
2933
2981
|
}
|
|
@@ -3480,6 +3528,12 @@ class RepoIssuesResource {
|
|
|
3480
3528
|
this.core = core;
|
|
3481
3529
|
this.bound = bound;
|
|
3482
3530
|
}
|
|
3531
|
+
answer(input, opts) {
|
|
3532
|
+
return this.core.request(ops["issues.answer"], { ...input, owner: this.bound["owner"], repo: this.bound["repo"] }, opts);
|
|
3533
|
+
}
|
|
3534
|
+
ask(input, opts) {
|
|
3535
|
+
return this.core.request(ops["issues.ask"], { ...input, owner: this.bound["owner"], repo: this.bound["repo"] }, opts);
|
|
3536
|
+
}
|
|
3483
3537
|
claim(input, opts) {
|
|
3484
3538
|
return this.core.request(ops["issues.claim"], { ...input, owner: this.bound["owner"], repo: this.bound["repo"] }, opts);
|
|
3485
3539
|
}
|
|
@@ -3538,6 +3592,9 @@ class RepoIssuesResource {
|
|
|
3538
3592
|
subscribe(input, opts) {
|
|
3539
3593
|
return this.core.request(ops["issues.subscribe"], { ...input, owner: this.bound["owner"], repo: this.bound["repo"] }, opts);
|
|
3540
3594
|
}
|
|
3595
|
+
unask(input, opts) {
|
|
3596
|
+
return this.core.request(ops["issues.unask"], { ...input, owner: this.bound["owner"], repo: this.bound["repo"] }, opts);
|
|
3597
|
+
}
|
|
3541
3598
|
unreact(input, opts) {
|
|
3542
3599
|
return this.core.request(ops["issues.unreact"], { ...input, owner: this.bound["owner"], repo: this.bound["repo"] }, opts);
|
|
3543
3600
|
}
|
package/dist/tools.cjs
CHANGED
|
@@ -801,6 +801,32 @@ var ops = {
|
|
|
801
801
|
long: false,
|
|
802
802
|
paginated: false
|
|
803
803
|
},
|
|
804
|
+
"issues.answer": {
|
|
805
|
+
id: "issues.answer",
|
|
806
|
+
method: "POST",
|
|
807
|
+
path: "/api/repos/{owner}/{repo}/issues/{number}/asks/{id}/answer",
|
|
808
|
+
pathParams: ["owner", "repo", "number", "id"],
|
|
809
|
+
queryParams: [],
|
|
810
|
+
bodyParams: ["choices", "text"],
|
|
811
|
+
effect: "write",
|
|
812
|
+
retry: "idempotent",
|
|
813
|
+
held: false,
|
|
814
|
+
long: false,
|
|
815
|
+
paginated: false
|
|
816
|
+
},
|
|
817
|
+
"issues.ask": {
|
|
818
|
+
id: "issues.ask",
|
|
819
|
+
method: "POST",
|
|
820
|
+
path: "/api/repos/{owner}/{repo}/issues/{number}/asks",
|
|
821
|
+
pathParams: ["owner", "repo", "number"],
|
|
822
|
+
queryParams: [],
|
|
823
|
+
bodyParams: ["kind", "text", "options", "recommended", "other"],
|
|
824
|
+
effect: "write",
|
|
825
|
+
retry: "none",
|
|
826
|
+
held: false,
|
|
827
|
+
long: false,
|
|
828
|
+
paginated: false
|
|
829
|
+
},
|
|
804
830
|
"issues.claim": {
|
|
805
831
|
id: "issues.claim",
|
|
806
832
|
method: "POST",
|
|
@@ -1061,6 +1087,19 @@ var ops = {
|
|
|
1061
1087
|
long: false,
|
|
1062
1088
|
paginated: false
|
|
1063
1089
|
},
|
|
1090
|
+
"issues.unask": {
|
|
1091
|
+
id: "issues.unask",
|
|
1092
|
+
method: "DELETE",
|
|
1093
|
+
path: "/api/repos/{owner}/{repo}/issues/{number}/asks/{id}",
|
|
1094
|
+
pathParams: ["owner", "repo", "number", "id"],
|
|
1095
|
+
queryParams: [],
|
|
1096
|
+
bodyParams: [],
|
|
1097
|
+
effect: "write",
|
|
1098
|
+
retry: "idempotent",
|
|
1099
|
+
held: false,
|
|
1100
|
+
long: false,
|
|
1101
|
+
paginated: false
|
|
1102
|
+
},
|
|
1064
1103
|
"issues.unreact": {
|
|
1065
1104
|
id: "issues.unreact",
|
|
1066
1105
|
method: "DELETE",
|
|
@@ -4537,6 +4576,171 @@ cursor at or behind the stored one leaves it as it is, so two readers cannot rew
|
|
|
4537
4576
|
tab: "tab"
|
|
4538
4577
|
}
|
|
4539
4578
|
},
|
|
4579
|
+
{
|
|
4580
|
+
name: "issue_answer",
|
|
4581
|
+
op: "issues.answer",
|
|
4582
|
+
description: "Answer a question on an issue, replacing an earlier answer: `choices` are option labels (one for `single`, any for `multi`), `text` the free-text answer of a `text` question or an `other` answer. You need write access or the issue's lease.",
|
|
4583
|
+
schema: {
|
|
4584
|
+
additionalProperties: false,
|
|
4585
|
+
description: "Answer a question on an issue, replacing an earlier answer: `choices` are option labels (one for `single`, any for\n`multi`), `text` the free-text answer of a `text` question or an `other` answer. You need write access or the\nissue's lease.",
|
|
4586
|
+
properties: {
|
|
4587
|
+
choices: {
|
|
4588
|
+
default: [],
|
|
4589
|
+
description: "The labels of the options picked.",
|
|
4590
|
+
items: {
|
|
4591
|
+
type: "string"
|
|
4592
|
+
},
|
|
4593
|
+
type: "array"
|
|
4594
|
+
},
|
|
4595
|
+
id: {
|
|
4596
|
+
description: "The question's id, from the issue's context.",
|
|
4597
|
+
type: "string"
|
|
4598
|
+
},
|
|
4599
|
+
number: {
|
|
4600
|
+
description: "Issue number.",
|
|
4601
|
+
format: "int64",
|
|
4602
|
+
type: "integer"
|
|
4603
|
+
},
|
|
4604
|
+
org: {
|
|
4605
|
+
description: "The repository's owner: a user or an org handle.",
|
|
4606
|
+
type: "string"
|
|
4607
|
+
},
|
|
4608
|
+
repo: {
|
|
4609
|
+
description: "The repository's name.",
|
|
4610
|
+
type: "string"
|
|
4611
|
+
},
|
|
4612
|
+
text: {
|
|
4613
|
+
default: "",
|
|
4614
|
+
description: "The answer in your own words.",
|
|
4615
|
+
type: "string"
|
|
4616
|
+
}
|
|
4617
|
+
},
|
|
4618
|
+
required: [
|
|
4619
|
+
"org",
|
|
4620
|
+
"repo",
|
|
4621
|
+
"number",
|
|
4622
|
+
"id"
|
|
4623
|
+
],
|
|
4624
|
+
type: "object"
|
|
4625
|
+
},
|
|
4626
|
+
renames: {
|
|
4627
|
+
choices: "choices",
|
|
4628
|
+
id: "id",
|
|
4629
|
+
number: "number",
|
|
4630
|
+
org: "owner",
|
|
4631
|
+
repo: "repo",
|
|
4632
|
+
text: "text"
|
|
4633
|
+
}
|
|
4634
|
+
},
|
|
4635
|
+
{
|
|
4636
|
+
name: "issue_ask",
|
|
4637
|
+
op: "issues.ask",
|
|
4638
|
+
description: "Ask a person a question on an issue and read the answer back later from the issue's context (`asks`). `single` takes one of 2 to 10 options, `multi` any number of them, `text` free text; `other` lets a choice question also take free text. The issue reads as needing input, and its assignee is told, until it is answered. You need the issue's lease or write access.",
|
|
4639
|
+
schema: {
|
|
4640
|
+
$defs: {
|
|
4641
|
+
AskKind: {
|
|
4642
|
+
description: "How a person answers an [`IssueAsk`]: `single` (one option), `multi` (any number of options) or `text` (free text).",
|
|
4643
|
+
enum: [
|
|
4644
|
+
"single",
|
|
4645
|
+
"multi",
|
|
4646
|
+
"text"
|
|
4647
|
+
],
|
|
4648
|
+
type: "string"
|
|
4649
|
+
},
|
|
4650
|
+
AskOptionInput: {
|
|
4651
|
+
anyOf: [
|
|
4652
|
+
{
|
|
4653
|
+
type: "string"
|
|
4654
|
+
},
|
|
4655
|
+
{
|
|
4656
|
+
$ref: "#/$defs/IssueAskOption"
|
|
4657
|
+
}
|
|
4658
|
+
],
|
|
4659
|
+
description: "An option as an asker writes it: its label alone, or the label with a description."
|
|
4660
|
+
},
|
|
4661
|
+
IssueAskOption: {
|
|
4662
|
+
properties: {
|
|
4663
|
+
description: {
|
|
4664
|
+
type: [
|
|
4665
|
+
"string",
|
|
4666
|
+
"null"
|
|
4667
|
+
]
|
|
4668
|
+
},
|
|
4669
|
+
label: {
|
|
4670
|
+
type: "string"
|
|
4671
|
+
}
|
|
4672
|
+
},
|
|
4673
|
+
required: [
|
|
4674
|
+
"label"
|
|
4675
|
+
],
|
|
4676
|
+
type: "object"
|
|
4677
|
+
}
|
|
4678
|
+
},
|
|
4679
|
+
additionalProperties: false,
|
|
4680
|
+
description: "Ask a person a question on an issue and read the answer back later from the issue's context (`asks`). `single`\ntakes one of 2 to 10 options, `multi` any number of them, `text` free text; `other` lets a choice question also take\nfree text. The issue reads as needing input, and its assignee is told, until it is answered. You need the issue's\nlease or write access.",
|
|
4681
|
+
properties: {
|
|
4682
|
+
kind: {
|
|
4683
|
+
$ref: "#/$defs/AskKind",
|
|
4684
|
+
description: "`single` (pick one option), `multi` (pick any) or `text` (free text)."
|
|
4685
|
+
},
|
|
4686
|
+
number: {
|
|
4687
|
+
description: "Issue number.",
|
|
4688
|
+
format: "int64",
|
|
4689
|
+
type: "integer"
|
|
4690
|
+
},
|
|
4691
|
+
options: {
|
|
4692
|
+
default: [],
|
|
4693
|
+
description: "The choices of a `single` or `multi` question, 2 to 10, each a label or `{label, description}`; none for\n`text`.",
|
|
4694
|
+
items: {
|
|
4695
|
+
$ref: "#/$defs/AskOptionInput"
|
|
4696
|
+
},
|
|
4697
|
+
type: "array"
|
|
4698
|
+
},
|
|
4699
|
+
org: {
|
|
4700
|
+
description: "The repository's owner: a user or an org handle.",
|
|
4701
|
+
type: "string"
|
|
4702
|
+
},
|
|
4703
|
+
other: {
|
|
4704
|
+
default: false,
|
|
4705
|
+
description: "true lets a `single` or `multi` question also take an answer in the person's own words.",
|
|
4706
|
+
type: "boolean"
|
|
4707
|
+
},
|
|
4708
|
+
recommended: {
|
|
4709
|
+
description: "The label of the option you suggest.",
|
|
4710
|
+
type: [
|
|
4711
|
+
"string",
|
|
4712
|
+
"null"
|
|
4713
|
+
]
|
|
4714
|
+
},
|
|
4715
|
+
repo: {
|
|
4716
|
+
description: "The repository's name.",
|
|
4717
|
+
type: "string"
|
|
4718
|
+
},
|
|
4719
|
+
text: {
|
|
4720
|
+
description: "The whole question, in Markdown, with what the person needs to answer it (up to 2000 characters).",
|
|
4721
|
+
type: "string"
|
|
4722
|
+
}
|
|
4723
|
+
},
|
|
4724
|
+
required: [
|
|
4725
|
+
"org",
|
|
4726
|
+
"repo",
|
|
4727
|
+
"number",
|
|
4728
|
+
"kind",
|
|
4729
|
+
"text"
|
|
4730
|
+
],
|
|
4731
|
+
type: "object"
|
|
4732
|
+
},
|
|
4733
|
+
renames: {
|
|
4734
|
+
kind: "kind",
|
|
4735
|
+
number: "number",
|
|
4736
|
+
options: "options",
|
|
4737
|
+
org: "owner",
|
|
4738
|
+
other: "other",
|
|
4739
|
+
recommended: "recommended",
|
|
4740
|
+
repo: "repo",
|
|
4741
|
+
text: "text"
|
|
4742
|
+
}
|
|
4743
|
+
},
|
|
4540
4744
|
{
|
|
4541
4745
|
name: "issue_claim",
|
|
4542
4746
|
op: "issues.claim",
|
|
@@ -5727,6 +5931,47 @@ repository.`,
|
|
|
5727
5931
|
repo: "repo"
|
|
5728
5932
|
}
|
|
5729
5933
|
},
|
|
5934
|
+
{
|
|
5935
|
+
name: "issue_unask",
|
|
5936
|
+
op: "issues.unask",
|
|
5937
|
+
description: "Take a question back from an issue, answered or not, once its answer is used or it no longer matters. You need the issue's lease or write access.",
|
|
5938
|
+
schema: {
|
|
5939
|
+
description: `Take a question back from an issue, answered or not, once its answer is used or it no longer matters. You need
|
|
5940
|
+
the issue's lease or write access.`,
|
|
5941
|
+
properties: {
|
|
5942
|
+
id: {
|
|
5943
|
+
description: "The question's id, from the issue's context.",
|
|
5944
|
+
type: "string"
|
|
5945
|
+
},
|
|
5946
|
+
number: {
|
|
5947
|
+
description: "Issue number.",
|
|
5948
|
+
format: "int64",
|
|
5949
|
+
type: "integer"
|
|
5950
|
+
},
|
|
5951
|
+
org: {
|
|
5952
|
+
description: "The repository's owner: a user or an org handle.",
|
|
5953
|
+
type: "string"
|
|
5954
|
+
},
|
|
5955
|
+
repo: {
|
|
5956
|
+
description: "The repository's name.",
|
|
5957
|
+
type: "string"
|
|
5958
|
+
}
|
|
5959
|
+
},
|
|
5960
|
+
required: [
|
|
5961
|
+
"org",
|
|
5962
|
+
"repo",
|
|
5963
|
+
"number",
|
|
5964
|
+
"id"
|
|
5965
|
+
],
|
|
5966
|
+
type: "object"
|
|
5967
|
+
},
|
|
5968
|
+
renames: {
|
|
5969
|
+
id: "id",
|
|
5970
|
+
number: "number",
|
|
5971
|
+
org: "owner",
|
|
5972
|
+
repo: "repo"
|
|
5973
|
+
}
|
|
5974
|
+
},
|
|
5730
5975
|
{
|
|
5731
5976
|
name: "issue_update",
|
|
5732
5977
|
op: "issues.update",
|
package/dist/tools.js
CHANGED
|
@@ -754,6 +754,32 @@ var ops = {
|
|
|
754
754
|
long: false,
|
|
755
755
|
paginated: false
|
|
756
756
|
},
|
|
757
|
+
"issues.answer": {
|
|
758
|
+
id: "issues.answer",
|
|
759
|
+
method: "POST",
|
|
760
|
+
path: "/api/repos/{owner}/{repo}/issues/{number}/asks/{id}/answer",
|
|
761
|
+
pathParams: ["owner", "repo", "number", "id"],
|
|
762
|
+
queryParams: [],
|
|
763
|
+
bodyParams: ["choices", "text"],
|
|
764
|
+
effect: "write",
|
|
765
|
+
retry: "idempotent",
|
|
766
|
+
held: false,
|
|
767
|
+
long: false,
|
|
768
|
+
paginated: false
|
|
769
|
+
},
|
|
770
|
+
"issues.ask": {
|
|
771
|
+
id: "issues.ask",
|
|
772
|
+
method: "POST",
|
|
773
|
+
path: "/api/repos/{owner}/{repo}/issues/{number}/asks",
|
|
774
|
+
pathParams: ["owner", "repo", "number"],
|
|
775
|
+
queryParams: [],
|
|
776
|
+
bodyParams: ["kind", "text", "options", "recommended", "other"],
|
|
777
|
+
effect: "write",
|
|
778
|
+
retry: "none",
|
|
779
|
+
held: false,
|
|
780
|
+
long: false,
|
|
781
|
+
paginated: false
|
|
782
|
+
},
|
|
757
783
|
"issues.claim": {
|
|
758
784
|
id: "issues.claim",
|
|
759
785
|
method: "POST",
|
|
@@ -1014,6 +1040,19 @@ var ops = {
|
|
|
1014
1040
|
long: false,
|
|
1015
1041
|
paginated: false
|
|
1016
1042
|
},
|
|
1043
|
+
"issues.unask": {
|
|
1044
|
+
id: "issues.unask",
|
|
1045
|
+
method: "DELETE",
|
|
1046
|
+
path: "/api/repos/{owner}/{repo}/issues/{number}/asks/{id}",
|
|
1047
|
+
pathParams: ["owner", "repo", "number", "id"],
|
|
1048
|
+
queryParams: [],
|
|
1049
|
+
bodyParams: [],
|
|
1050
|
+
effect: "write",
|
|
1051
|
+
retry: "idempotent",
|
|
1052
|
+
held: false,
|
|
1053
|
+
long: false,
|
|
1054
|
+
paginated: false
|
|
1055
|
+
},
|
|
1017
1056
|
"issues.unreact": {
|
|
1018
1057
|
id: "issues.unreact",
|
|
1019
1058
|
method: "DELETE",
|
|
@@ -4490,6 +4529,171 @@ cursor at or behind the stored one leaves it as it is, so two readers cannot rew
|
|
|
4490
4529
|
tab: "tab"
|
|
4491
4530
|
}
|
|
4492
4531
|
},
|
|
4532
|
+
{
|
|
4533
|
+
name: "issue_answer",
|
|
4534
|
+
op: "issues.answer",
|
|
4535
|
+
description: "Answer a question on an issue, replacing an earlier answer: `choices` are option labels (one for `single`, any for `multi`), `text` the free-text answer of a `text` question or an `other` answer. You need write access or the issue's lease.",
|
|
4536
|
+
schema: {
|
|
4537
|
+
additionalProperties: false,
|
|
4538
|
+
description: "Answer a question on an issue, replacing an earlier answer: `choices` are option labels (one for `single`, any for\n`multi`), `text` the free-text answer of a `text` question or an `other` answer. You need write access or the\nissue's lease.",
|
|
4539
|
+
properties: {
|
|
4540
|
+
choices: {
|
|
4541
|
+
default: [],
|
|
4542
|
+
description: "The labels of the options picked.",
|
|
4543
|
+
items: {
|
|
4544
|
+
type: "string"
|
|
4545
|
+
},
|
|
4546
|
+
type: "array"
|
|
4547
|
+
},
|
|
4548
|
+
id: {
|
|
4549
|
+
description: "The question's id, from the issue's context.",
|
|
4550
|
+
type: "string"
|
|
4551
|
+
},
|
|
4552
|
+
number: {
|
|
4553
|
+
description: "Issue number.",
|
|
4554
|
+
format: "int64",
|
|
4555
|
+
type: "integer"
|
|
4556
|
+
},
|
|
4557
|
+
org: {
|
|
4558
|
+
description: "The repository's owner: a user or an org handle.",
|
|
4559
|
+
type: "string"
|
|
4560
|
+
},
|
|
4561
|
+
repo: {
|
|
4562
|
+
description: "The repository's name.",
|
|
4563
|
+
type: "string"
|
|
4564
|
+
},
|
|
4565
|
+
text: {
|
|
4566
|
+
default: "",
|
|
4567
|
+
description: "The answer in your own words.",
|
|
4568
|
+
type: "string"
|
|
4569
|
+
}
|
|
4570
|
+
},
|
|
4571
|
+
required: [
|
|
4572
|
+
"org",
|
|
4573
|
+
"repo",
|
|
4574
|
+
"number",
|
|
4575
|
+
"id"
|
|
4576
|
+
],
|
|
4577
|
+
type: "object"
|
|
4578
|
+
},
|
|
4579
|
+
renames: {
|
|
4580
|
+
choices: "choices",
|
|
4581
|
+
id: "id",
|
|
4582
|
+
number: "number",
|
|
4583
|
+
org: "owner",
|
|
4584
|
+
repo: "repo",
|
|
4585
|
+
text: "text"
|
|
4586
|
+
}
|
|
4587
|
+
},
|
|
4588
|
+
{
|
|
4589
|
+
name: "issue_ask",
|
|
4590
|
+
op: "issues.ask",
|
|
4591
|
+
description: "Ask a person a question on an issue and read the answer back later from the issue's context (`asks`). `single` takes one of 2 to 10 options, `multi` any number of them, `text` free text; `other` lets a choice question also take free text. The issue reads as needing input, and its assignee is told, until it is answered. You need the issue's lease or write access.",
|
|
4592
|
+
schema: {
|
|
4593
|
+
$defs: {
|
|
4594
|
+
AskKind: {
|
|
4595
|
+
description: "How a person answers an [`IssueAsk`]: `single` (one option), `multi` (any number of options) or `text` (free text).",
|
|
4596
|
+
enum: [
|
|
4597
|
+
"single",
|
|
4598
|
+
"multi",
|
|
4599
|
+
"text"
|
|
4600
|
+
],
|
|
4601
|
+
type: "string"
|
|
4602
|
+
},
|
|
4603
|
+
AskOptionInput: {
|
|
4604
|
+
anyOf: [
|
|
4605
|
+
{
|
|
4606
|
+
type: "string"
|
|
4607
|
+
},
|
|
4608
|
+
{
|
|
4609
|
+
$ref: "#/$defs/IssueAskOption"
|
|
4610
|
+
}
|
|
4611
|
+
],
|
|
4612
|
+
description: "An option as an asker writes it: its label alone, or the label with a description."
|
|
4613
|
+
},
|
|
4614
|
+
IssueAskOption: {
|
|
4615
|
+
properties: {
|
|
4616
|
+
description: {
|
|
4617
|
+
type: [
|
|
4618
|
+
"string",
|
|
4619
|
+
"null"
|
|
4620
|
+
]
|
|
4621
|
+
},
|
|
4622
|
+
label: {
|
|
4623
|
+
type: "string"
|
|
4624
|
+
}
|
|
4625
|
+
},
|
|
4626
|
+
required: [
|
|
4627
|
+
"label"
|
|
4628
|
+
],
|
|
4629
|
+
type: "object"
|
|
4630
|
+
}
|
|
4631
|
+
},
|
|
4632
|
+
additionalProperties: false,
|
|
4633
|
+
description: "Ask a person a question on an issue and read the answer back later from the issue's context (`asks`). `single`\ntakes one of 2 to 10 options, `multi` any number of them, `text` free text; `other` lets a choice question also take\nfree text. The issue reads as needing input, and its assignee is told, until it is answered. You need the issue's\nlease or write access.",
|
|
4634
|
+
properties: {
|
|
4635
|
+
kind: {
|
|
4636
|
+
$ref: "#/$defs/AskKind",
|
|
4637
|
+
description: "`single` (pick one option), `multi` (pick any) or `text` (free text)."
|
|
4638
|
+
},
|
|
4639
|
+
number: {
|
|
4640
|
+
description: "Issue number.",
|
|
4641
|
+
format: "int64",
|
|
4642
|
+
type: "integer"
|
|
4643
|
+
},
|
|
4644
|
+
options: {
|
|
4645
|
+
default: [],
|
|
4646
|
+
description: "The choices of a `single` or `multi` question, 2 to 10, each a label or `{label, description}`; none for\n`text`.",
|
|
4647
|
+
items: {
|
|
4648
|
+
$ref: "#/$defs/AskOptionInput"
|
|
4649
|
+
},
|
|
4650
|
+
type: "array"
|
|
4651
|
+
},
|
|
4652
|
+
org: {
|
|
4653
|
+
description: "The repository's owner: a user or an org handle.",
|
|
4654
|
+
type: "string"
|
|
4655
|
+
},
|
|
4656
|
+
other: {
|
|
4657
|
+
default: false,
|
|
4658
|
+
description: "true lets a `single` or `multi` question also take an answer in the person's own words.",
|
|
4659
|
+
type: "boolean"
|
|
4660
|
+
},
|
|
4661
|
+
recommended: {
|
|
4662
|
+
description: "The label of the option you suggest.",
|
|
4663
|
+
type: [
|
|
4664
|
+
"string",
|
|
4665
|
+
"null"
|
|
4666
|
+
]
|
|
4667
|
+
},
|
|
4668
|
+
repo: {
|
|
4669
|
+
description: "The repository's name.",
|
|
4670
|
+
type: "string"
|
|
4671
|
+
},
|
|
4672
|
+
text: {
|
|
4673
|
+
description: "The whole question, in Markdown, with what the person needs to answer it (up to 2000 characters).",
|
|
4674
|
+
type: "string"
|
|
4675
|
+
}
|
|
4676
|
+
},
|
|
4677
|
+
required: [
|
|
4678
|
+
"org",
|
|
4679
|
+
"repo",
|
|
4680
|
+
"number",
|
|
4681
|
+
"kind",
|
|
4682
|
+
"text"
|
|
4683
|
+
],
|
|
4684
|
+
type: "object"
|
|
4685
|
+
},
|
|
4686
|
+
renames: {
|
|
4687
|
+
kind: "kind",
|
|
4688
|
+
number: "number",
|
|
4689
|
+
options: "options",
|
|
4690
|
+
org: "owner",
|
|
4691
|
+
other: "other",
|
|
4692
|
+
recommended: "recommended",
|
|
4693
|
+
repo: "repo",
|
|
4694
|
+
text: "text"
|
|
4695
|
+
}
|
|
4696
|
+
},
|
|
4493
4697
|
{
|
|
4494
4698
|
name: "issue_claim",
|
|
4495
4699
|
op: "issues.claim",
|
|
@@ -5680,6 +5884,47 @@ repository.`,
|
|
|
5680
5884
|
repo: "repo"
|
|
5681
5885
|
}
|
|
5682
5886
|
},
|
|
5887
|
+
{
|
|
5888
|
+
name: "issue_unask",
|
|
5889
|
+
op: "issues.unask",
|
|
5890
|
+
description: "Take a question back from an issue, answered or not, once its answer is used or it no longer matters. You need the issue's lease or write access.",
|
|
5891
|
+
schema: {
|
|
5892
|
+
description: `Take a question back from an issue, answered or not, once its answer is used or it no longer matters. You need
|
|
5893
|
+
the issue's lease or write access.`,
|
|
5894
|
+
properties: {
|
|
5895
|
+
id: {
|
|
5896
|
+
description: "The question's id, from the issue's context.",
|
|
5897
|
+
type: "string"
|
|
5898
|
+
},
|
|
5899
|
+
number: {
|
|
5900
|
+
description: "Issue number.",
|
|
5901
|
+
format: "int64",
|
|
5902
|
+
type: "integer"
|
|
5903
|
+
},
|
|
5904
|
+
org: {
|
|
5905
|
+
description: "The repository's owner: a user or an org handle.",
|
|
5906
|
+
type: "string"
|
|
5907
|
+
},
|
|
5908
|
+
repo: {
|
|
5909
|
+
description: "The repository's name.",
|
|
5910
|
+
type: "string"
|
|
5911
|
+
}
|
|
5912
|
+
},
|
|
5913
|
+
required: [
|
|
5914
|
+
"org",
|
|
5915
|
+
"repo",
|
|
5916
|
+
"number",
|
|
5917
|
+
"id"
|
|
5918
|
+
],
|
|
5919
|
+
type: "object"
|
|
5920
|
+
},
|
|
5921
|
+
renames: {
|
|
5922
|
+
id: "id",
|
|
5923
|
+
number: "number",
|
|
5924
|
+
org: "owner",
|
|
5925
|
+
repo: "repo"
|
|
5926
|
+
}
|
|
5927
|
+
},
|
|
5683
5928
|
{
|
|
5684
5929
|
name: "issue_update",
|
|
5685
5930
|
op: "issues.update",
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.
|
|
1
|
+
export declare const VERSION = "0.3.0";
|
|
2
2
|
export declare const API_VERSION = "2026-12-01";
|
|
@@ -267,6 +267,14 @@ export declare class InboxResource {
|
|
|
267
267
|
export declare class IssuesResource {
|
|
268
268
|
private readonly core;
|
|
269
269
|
constructor(core: Core);
|
|
270
|
+
/**
|
|
271
|
+
* Answer a question on an issue, replacing an earlier answer: `choices` are option labels (one for `single`, any for `multi`), `text` the free-text answer of a `text` question or an `other` answer. You need write access or the issue's lease.
|
|
272
|
+
*/
|
|
273
|
+
answer(input: T.IssuesAnswerInput, opts?: RequestOptions): Promise<T.IssuesAnswerOutput>;
|
|
274
|
+
/**
|
|
275
|
+
* Ask a person a question on an issue and read the answer back later from the issue's context (`asks`). `single` takes one of 2 to 10 options, `multi` any number of them, `text` free text; `other` lets a choice question also take free text. The issue reads as needing input, and its assignee is told, until it is answered. You need the issue's lease or write access.
|
|
276
|
+
*/
|
|
277
|
+
ask(input: T.IssuesAskInput, opts?: RequestOptions): Promise<T.IssuesAskOutput>;
|
|
270
278
|
/**
|
|
271
279
|
* Delegate an issue to yourself or your agent for a lease, or renew the lease. The issue returns to ready if the lease lapses.
|
|
272
280
|
*/
|
|
@@ -349,6 +357,10 @@ export declare class IssuesResource {
|
|
|
349
357
|
* Follow an issue to be notified of its activity, or stop following it. Needs only read access.
|
|
350
358
|
*/
|
|
351
359
|
subscribe(input: T.IssuesSubscribeInput, opts?: RequestOptions): Promise<T.IssuesSubscribeOutput>;
|
|
360
|
+
/**
|
|
361
|
+
* Take a question back from an issue, answered or not, once its answer is used or it no longer matters. You need the issue's lease or write access.
|
|
362
|
+
*/
|
|
363
|
+
unask(input: T.IssuesUnaskInput, opts?: RequestOptions): Promise<T.IssuesUnaskOutput>;
|
|
352
364
|
/**
|
|
353
365
|
* Take your reaction back from an issue.
|
|
354
366
|
*/
|
|
@@ -972,6 +984,14 @@ export declare class RepoIssuesResource {
|
|
|
972
984
|
private readonly core;
|
|
973
985
|
private readonly bound;
|
|
974
986
|
constructor(core: Core, bound: RepoBound);
|
|
987
|
+
/**
|
|
988
|
+
* Answer a question on an issue, replacing an earlier answer: `choices` are option labels (one for `single`, any for `multi`), `text` the free-text answer of a `text` question or an `other` answer. You need write access or the issue's lease.
|
|
989
|
+
*/
|
|
990
|
+
answer(input: Omit<T.IssuesAnswerInput, 'owner' | 'repo'>, opts?: RequestOptions): Promise<T.IssuesAnswerOutput>;
|
|
991
|
+
/**
|
|
992
|
+
* Ask a person a question on an issue and read the answer back later from the issue's context (`asks`). `single` takes one of 2 to 10 options, `multi` any number of them, `text` free text; `other` lets a choice question also take free text. The issue reads as needing input, and its assignee is told, until it is answered. You need the issue's lease or write access.
|
|
993
|
+
*/
|
|
994
|
+
ask(input: Omit<T.IssuesAskInput, 'owner' | 'repo'>, opts?: RequestOptions): Promise<T.IssuesAskOutput>;
|
|
975
995
|
/**
|
|
976
996
|
* Delegate an issue to yourself or your agent for a lease, or renew the lease. The issue returns to ready if the lease lapses.
|
|
977
997
|
*/
|
|
@@ -1050,6 +1070,10 @@ export declare class RepoIssuesResource {
|
|
|
1050
1070
|
* Follow an issue to be notified of its activity, or stop following it. Needs only read access.
|
|
1051
1071
|
*/
|
|
1052
1072
|
subscribe(input: Omit<T.IssuesSubscribeInput, 'owner' | 'repo'>, opts?: RequestOptions): Promise<T.IssuesSubscribeOutput>;
|
|
1073
|
+
/**
|
|
1074
|
+
* Take a question back from an issue, answered or not, once its answer is used or it no longer matters. You need the issue's lease or write access.
|
|
1075
|
+
*/
|
|
1076
|
+
unask(input: Omit<T.IssuesUnaskInput, 'owner' | 'repo'>, opts?: RequestOptions): Promise<T.IssuesUnaskOutput>;
|
|
1053
1077
|
/**
|
|
1054
1078
|
* Take your reaction back from an issue.
|
|
1055
1079
|
*/
|
|
@@ -2,4 +2,4 @@ export * from "./api.js";
|
|
|
2
2
|
export { type OpId, ops } from "./ops.js";
|
|
3
3
|
export * as tools from "./tools.js";
|
|
4
4
|
export type * as types from "./types.js";
|
|
5
|
-
export type { AffectedMode, AffectedStep, AgentTrackingState, Annotation, ApiError, Artifacts, AutoMerge, BatchItem, BranchUpdated, CaissonAffected, CaissonAsk, CaissonAstMatch, CaissonAstMatches, CaissonBase, CaissonBashResult, CaissonBatchResult, CaissonChange, CaissonChangeRequest, CaissonChanged, CaissonCommitted, CaissonEdit, CaissonFileRead, CaissonFilesRead, CaissonGlob, CaissonGrep, CaissonGrepCount, CaissonGrepLine, CaissonGrepMatch, CaissonLocated, CaissonLspAnswer, CaissonLspPlace, CaissonLspProgress, CaissonLspQuestion, CaissonLspRenamed, CaissonLspStopped, CaissonPage, CaissonPolicy, CaissonPull, CaissonRefused, CaissonReview, CaissonReviewStatus, CaissonRow, CaissonShipped, CaissonTested, Check, CheckRun, CheckRunAction, CheckRunApp, CheckRunApp2, CheckRunBody, CheckRunBrief, CheckRunList, CheckRunOutput, CheckRunText, CheckSource, CheckState, CheckStep, ChecksState, Claim, CloneDefaults, CloneDefaultsEdit, CloseReason, CodeLine, CodeSnippet, CommentKind, CommentProof, ConflictFile, ConflictKind, ConflictResolution, ConflictSide, ConflictTake, ContextVisibility, CreatedIssue, Delegate, DelegateAsk, DelegateRequest, DeletionScheduled, DiffSide, ErrorCode, ErrorLocation, Event, EventPage, EventSubscription, FailedStep, FileHit, FindingResolution, GithubInstallUrl, GithubInstallation, GithubRepo, GrepMode, Held, HeldDecided, HeldListing, HeldRequest, Hidden, HideReason, Inbox, InboxCounts, InboxItem, Issue, IssueComment, IssueContext, IssueDetail, IssueEvent, IssuePage, IssuePriority, IssueStage, IssueStarted, IssueState, IssueStatus, ItemRef, KeyProof, Label, LabelItem, LabelList, MeUpdated, MergeMethod, Mergeable, Milestone, MilestoneItem, MilestoneList, MilestoneState, MyIssue, MyIssues, NoContent, Opener, PathHit, PathRule, Proof, ProofSource, Pull, PullChecks, PullComment, PullCommit, PullConflicts, PullDetail, PullFile, PullHunk, PullLine, PullMerge, PullPage, PullPatchState, PullThread, QueueBatch, QueueDropped, QueueEntry, QueueStatus, Reaction, Reaction2, ReactionKind, RecoveryCodeList, RefHit, RefHit2, RefResults, RefResults2, RelatedItem, RelatedKind, RelatedLink, RelatedWork, RepoHit, RepoInfo, RepoNote, RepoNoteLimits, RepoNotes, ReviewChange, ReviewComment, ReviewFinding, ReviewFindingInput, ReviewPacket, ReviewRisk, ReviewSince, ReviewSinceFinding, Rollup, Run, RunArtifact, RunCancelled, RunEvent, RunFailures, RunId, RunJob, RunLogPage, RunLogs, RunStep, RunStepLog, RunTests, RunWait, Runs, Sandbox, SandboxBackground, SandboxCaisson, SandboxClass, SandboxExecResult, SandboxHostRef, SandboxIdle, SandboxKind, SandboxOrigin, SandboxPage, SandboxTokenMode, SandboxUsage, SandboxWait, SearchResults, SessionStep, SimilarIssue, SimilarIssues, SkippedWorkflow, SshKey, StackEntry, StopMode, SubIssue, Surface, SymbolHit, SymbolHit2, SymbolResults, SymbolResults2, TestFailure, Token, TokenCreated, TotpSetup, Verdict, Visibility, WaitAnswer, WaitTarget, WorkspaceUnread } from "./types.js";
|
|
5
|
+
export type { AffectedMode, AffectedStep, AgentTrackingState, Annotation, ApiError, Artifacts, AskKind, AskOptionInput, AutoMerge, BatchItem, BranchUpdated, CaissonAffected, CaissonAsk, CaissonAstMatch, CaissonAstMatches, CaissonBase, CaissonBashResult, CaissonBatchResult, CaissonChange, CaissonChangeRequest, CaissonChanged, CaissonCommitted, CaissonEdit, CaissonFileRead, CaissonFilesRead, CaissonGlob, CaissonGrep, CaissonGrepCount, CaissonGrepLine, CaissonGrepMatch, CaissonLocated, CaissonLspAnswer, CaissonLspPlace, CaissonLspProgress, CaissonLspQuestion, CaissonLspRenamed, CaissonLspStopped, CaissonPage, CaissonPolicy, CaissonPull, CaissonRefused, CaissonReview, CaissonReviewStatus, CaissonRow, CaissonShipped, CaissonTested, Check, CheckRun, CheckRunAction, CheckRunApp, CheckRunApp2, CheckRunBody, CheckRunBrief, CheckRunList, CheckRunOutput, CheckRunText, CheckSource, CheckState, CheckStep, ChecksState, Claim, CloneDefaults, CloneDefaultsEdit, CloseReason, CodeLine, CodeSnippet, CommentKind, CommentProof, ConflictFile, ConflictKind, ConflictResolution, ConflictSide, ConflictTake, ContextVisibility, CreatedIssue, Delegate, DelegateAsk, DelegateRequest, DeletionScheduled, DiffSide, ErrorCode, ErrorLocation, Event, EventPage, EventSubscription, FailedStep, FileHit, FindingResolution, GithubInstallUrl, GithubInstallation, GithubRepo, GrepMode, Held, HeldDecided, HeldListing, HeldRequest, Hidden, HideReason, Inbox, InboxCounts, InboxItem, Issue, IssueAsk, IssueAskAnswer, IssueAskOption, IssueComment, IssueContext, IssueDetail, IssueEvent, IssuePage, IssuePriority, IssueStage, IssueStarted, IssueState, IssueStatus, ItemRef, KeyProof, Label, LabelItem, LabelList, MeUpdated, MergeMethod, Mergeable, Milestone, MilestoneItem, MilestoneList, MilestoneState, MyIssue, MyIssues, NoContent, Opener, PathHit, PathRule, Proof, ProofSource, Pull, PullChecks, PullComment, PullCommit, PullConflicts, PullDetail, PullFile, PullHunk, PullLine, PullMerge, PullPage, PullPatchState, PullThread, QueueBatch, QueueDropped, QueueEntry, QueueStatus, Reaction, Reaction2, ReactionKind, RecoveryCodeList, RefHit, RefHit2, RefResults, RefResults2, RelatedItem, RelatedKind, RelatedLink, RelatedWork, RepoHit, RepoInfo, RepoNote, RepoNoteLimits, RepoNotes, ReviewChange, ReviewComment, ReviewFinding, ReviewFindingInput, ReviewPacket, ReviewRisk, ReviewSince, ReviewSinceFinding, Rollup, Run, RunArtifact, RunCancelled, RunEvent, RunFailures, RunId, RunJob, RunLogPage, RunLogs, RunStep, RunStepLog, RunTests, RunWait, Runs, Sandbox, SandboxBackground, SandboxCaisson, SandboxClass, SandboxExecResult, SandboxHostRef, SandboxIdle, SandboxKind, SandboxOrigin, SandboxPage, SandboxTokenMode, SandboxUsage, SandboxWait, SearchResults, SessionStep, SimilarIssue, SimilarIssues, SkippedWorkflow, SshKey, StackEntry, StopMode, SubIssue, Surface, SymbolHit, SymbolHit2, SymbolResults, SymbolResults2, TestFailure, Token, TokenCreated, TotpSetup, Verdict, Visibility, WaitAnswer, WaitTarget, WorkspaceUnread } from "./types.js";
|
|
@@ -753,6 +753,32 @@ export declare const ops: {
|
|
|
753
753
|
long: false;
|
|
754
754
|
paginated: false;
|
|
755
755
|
};
|
|
756
|
+
'issues.answer': {
|
|
757
|
+
id: string;
|
|
758
|
+
method: 'POST';
|
|
759
|
+
path: string;
|
|
760
|
+
pathParams: string[];
|
|
761
|
+
queryParams: never[];
|
|
762
|
+
bodyParams: string[];
|
|
763
|
+
effect: 'write';
|
|
764
|
+
retry: 'idempotent';
|
|
765
|
+
held: false;
|
|
766
|
+
long: false;
|
|
767
|
+
paginated: false;
|
|
768
|
+
};
|
|
769
|
+
'issues.ask': {
|
|
770
|
+
id: string;
|
|
771
|
+
method: 'POST';
|
|
772
|
+
path: string;
|
|
773
|
+
pathParams: string[];
|
|
774
|
+
queryParams: never[];
|
|
775
|
+
bodyParams: string[];
|
|
776
|
+
effect: 'write';
|
|
777
|
+
retry: 'none';
|
|
778
|
+
held: false;
|
|
779
|
+
long: false;
|
|
780
|
+
paginated: false;
|
|
781
|
+
};
|
|
756
782
|
'issues.claim': {
|
|
757
783
|
id: string;
|
|
758
784
|
method: 'POST';
|
|
@@ -1013,6 +1039,19 @@ export declare const ops: {
|
|
|
1013
1039
|
long: false;
|
|
1014
1040
|
paginated: false;
|
|
1015
1041
|
};
|
|
1042
|
+
'issues.unask': {
|
|
1043
|
+
id: string;
|
|
1044
|
+
method: 'DELETE';
|
|
1045
|
+
path: string;
|
|
1046
|
+
pathParams: string[];
|
|
1047
|
+
queryParams: never[];
|
|
1048
|
+
bodyParams: never[];
|
|
1049
|
+
effect: 'write';
|
|
1050
|
+
retry: 'idempotent';
|
|
1051
|
+
held: false;
|
|
1052
|
+
long: false;
|
|
1053
|
+
paginated: false;
|
|
1054
|
+
};
|
|
1016
1055
|
'issues.unreact': {
|
|
1017
1056
|
id: string;
|
|
1018
1057
|
method: 'DELETE';
|
|
@@ -38,6 +38,10 @@ export type ApiError = {
|
|
|
38
38
|
export type Artifacts = {
|
|
39
39
|
artifacts: RunArtifact[];
|
|
40
40
|
};
|
|
41
|
+
/** How a person answers an [`IssueAsk`]: `single` (one option), `multi` (any number of options) or `text` (free text). */
|
|
42
|
+
export type AskKind = 'single' | 'multi' | 'text';
|
|
43
|
+
/** An option as an asker writes it: its label alone, or the label with a description. */
|
|
44
|
+
export type AskOptionInput = string | IssueAskOption;
|
|
41
45
|
/** A pull request's auto-merge: `GET`, `PUT` and `DELETE pulls/{n}/auto-merge`. */
|
|
42
46
|
export type AutoMerge = {
|
|
43
47
|
/** Who turned it on; the merge is made as them. */
|
|
@@ -914,6 +918,36 @@ export type Issue = {
|
|
|
914
918
|
/** Last write of any kind. */
|
|
915
919
|
updatedAt: string;
|
|
916
920
|
};
|
|
921
|
+
/** A question for a person, answered in place. */
|
|
922
|
+
export type IssueAsk = {
|
|
923
|
+
agent?: string | null;
|
|
924
|
+
/** `None` until someone answers. */
|
|
925
|
+
answer?: IssueAskAnswer | null;
|
|
926
|
+
at: string;
|
|
927
|
+
by: string;
|
|
928
|
+
/** Pass it to `issue answer` and `issue unask`. */
|
|
929
|
+
id: string;
|
|
930
|
+
kind: AskKind;
|
|
931
|
+
options?: IssueAskOption[];
|
|
932
|
+
/** A `single` or `multi` question that also takes free text beside its options. */
|
|
933
|
+
other?: boolean;
|
|
934
|
+
/** The label of the option the asker suggests. */
|
|
935
|
+
recommended?: string | null;
|
|
936
|
+
text: string;
|
|
937
|
+
};
|
|
938
|
+
export type IssueAskAnswer = {
|
|
939
|
+
agent?: string | null;
|
|
940
|
+
at: string;
|
|
941
|
+
by: string;
|
|
942
|
+
/** The labels of the options picked. */
|
|
943
|
+
choices?: string[];
|
|
944
|
+
/** The free text: the whole answer to a `text` question, or what an `other` answer adds. */
|
|
945
|
+
text?: string;
|
|
946
|
+
};
|
|
947
|
+
export type IssueAskOption = {
|
|
948
|
+
description?: string | null;
|
|
949
|
+
label: string;
|
|
950
|
+
};
|
|
917
951
|
export type IssueComment = {
|
|
918
952
|
agent: boolean;
|
|
919
953
|
at: string;
|
|
@@ -935,6 +969,8 @@ export type IssueComment = {
|
|
|
935
969
|
/** Where the work stands, for whoever picks the issue up next. */
|
|
936
970
|
export type IssueContext = {
|
|
937
971
|
agent?: string | null;
|
|
972
|
+
/** Questions with a kind and options, answered in place; an unanswered one makes the issue read as needing input. */
|
|
973
|
+
asks?: IssueAsk[];
|
|
938
974
|
at: string;
|
|
939
975
|
branch?: string | null;
|
|
940
976
|
/** The account that last wrote it. */
|
|
@@ -2958,6 +2994,46 @@ export type InboxReadInput = {
|
|
|
2958
2994
|
tab?: string | null;
|
|
2959
2995
|
};
|
|
2960
2996
|
export type InboxReadOutput = null;
|
|
2997
|
+
/**
|
|
2998
|
+
* Answer a question on an issue, replacing an earlier answer: `choices` are option labels (one for `single`, any for `multi`), `text` the free-text answer of a `text` question or an `other` answer. You need write access or the issue's lease.
|
|
2999
|
+
*/
|
|
3000
|
+
export type IssuesAnswerInput = {
|
|
3001
|
+
/** The labels of the options picked. */
|
|
3002
|
+
choices?: string[];
|
|
3003
|
+
/** The question's id, from the issue's context. */
|
|
3004
|
+
id: string;
|
|
3005
|
+
/** Issue number. */
|
|
3006
|
+
number: number;
|
|
3007
|
+
/** The repository's owner: a user or an org handle. */
|
|
3008
|
+
owner: string;
|
|
3009
|
+
/** The repository's name. */
|
|
3010
|
+
repo: string;
|
|
3011
|
+
/** The answer in your own words. */
|
|
3012
|
+
text?: string;
|
|
3013
|
+
};
|
|
3014
|
+
export type IssuesAnswerOutput = Issue;
|
|
3015
|
+
/**
|
|
3016
|
+
* Ask a person a question on an issue and read the answer back later from the issue's context (`asks`). `single` takes one of 2 to 10 options, `multi` any number of them, `text` free text; `other` lets a choice question also take free text. The issue reads as needing input, and its assignee is told, until it is answered. You need the issue's lease or write access.
|
|
3017
|
+
*/
|
|
3018
|
+
export type IssuesAskInput = {
|
|
3019
|
+
/** `single` (pick one option), `multi` (pick any) or `text` (free text). */
|
|
3020
|
+
kind: AskKind;
|
|
3021
|
+
/** Issue number. */
|
|
3022
|
+
number: number;
|
|
3023
|
+
/** The choices of a `single` or `multi` question, 2 to 10, each a label or `{label, description}`; none for `text`. */
|
|
3024
|
+
options?: AskOptionInput[];
|
|
3025
|
+
/** true lets a `single` or `multi` question also take an answer in the person's own words. */
|
|
3026
|
+
other?: boolean;
|
|
3027
|
+
/** The repository's owner: a user or an org handle. */
|
|
3028
|
+
owner: string;
|
|
3029
|
+
/** The label of the option you suggest. */
|
|
3030
|
+
recommended?: string | null;
|
|
3031
|
+
/** The repository's name. */
|
|
3032
|
+
repo: string;
|
|
3033
|
+
/** The whole question, in Markdown, with what the person needs to answer it (up to 2000 characters). */
|
|
3034
|
+
text: string;
|
|
3035
|
+
};
|
|
3036
|
+
export type IssuesAskOutput = Issue;
|
|
2961
3037
|
/**
|
|
2962
3038
|
* Delegate an issue to yourself or your agent for a lease, or renew the lease. The issue returns to ready if the lease lapses.
|
|
2963
3039
|
*/
|
|
@@ -3320,6 +3396,20 @@ export type IssuesSubscribeInput = {
|
|
|
3320
3396
|
subscribed: boolean;
|
|
3321
3397
|
};
|
|
3322
3398
|
export type IssuesSubscribeOutput = Issue;
|
|
3399
|
+
/**
|
|
3400
|
+
* Take a question back from an issue, answered or not, once its answer is used or it no longer matters. You need the issue's lease or write access.
|
|
3401
|
+
*/
|
|
3402
|
+
export type IssuesUnaskInput = {
|
|
3403
|
+
/** The question's id, from the issue's context. */
|
|
3404
|
+
id: string;
|
|
3405
|
+
/** Issue number. */
|
|
3406
|
+
number: number;
|
|
3407
|
+
/** The repository's owner: a user or an org handle. */
|
|
3408
|
+
owner: string;
|
|
3409
|
+
/** The repository's name. */
|
|
3410
|
+
repo: string;
|
|
3411
|
+
};
|
|
3412
|
+
export type IssuesUnaskOutput = Issue;
|
|
3323
3413
|
/**
|
|
3324
3414
|
* Take your reaction back from an issue.
|
|
3325
3415
|
*/
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.
|
|
1
|
+
export declare const VERSION = "0.3.0";
|
|
2
2
|
export declare const API_VERSION = "2026-12-01";
|
|
@@ -267,6 +267,14 @@ export declare class InboxResource {
|
|
|
267
267
|
export declare class IssuesResource {
|
|
268
268
|
private readonly core;
|
|
269
269
|
constructor(core: Core);
|
|
270
|
+
/**
|
|
271
|
+
* Answer a question on an issue, replacing an earlier answer: `choices` are option labels (one for `single`, any for `multi`), `text` the free-text answer of a `text` question or an `other` answer. You need write access or the issue's lease.
|
|
272
|
+
*/
|
|
273
|
+
answer(input: T.IssuesAnswerInput, opts?: RequestOptions): Promise<T.IssuesAnswerOutput>;
|
|
274
|
+
/**
|
|
275
|
+
* Ask a person a question on an issue and read the answer back later from the issue's context (`asks`). `single` takes one of 2 to 10 options, `multi` any number of them, `text` free text; `other` lets a choice question also take free text. The issue reads as needing input, and its assignee is told, until it is answered. You need the issue's lease or write access.
|
|
276
|
+
*/
|
|
277
|
+
ask(input: T.IssuesAskInput, opts?: RequestOptions): Promise<T.IssuesAskOutput>;
|
|
270
278
|
/**
|
|
271
279
|
* Delegate an issue to yourself or your agent for a lease, or renew the lease. The issue returns to ready if the lease lapses.
|
|
272
280
|
*/
|
|
@@ -349,6 +357,10 @@ export declare class IssuesResource {
|
|
|
349
357
|
* Follow an issue to be notified of its activity, or stop following it. Needs only read access.
|
|
350
358
|
*/
|
|
351
359
|
subscribe(input: T.IssuesSubscribeInput, opts?: RequestOptions): Promise<T.IssuesSubscribeOutput>;
|
|
360
|
+
/**
|
|
361
|
+
* Take a question back from an issue, answered or not, once its answer is used or it no longer matters. You need the issue's lease or write access.
|
|
362
|
+
*/
|
|
363
|
+
unask(input: T.IssuesUnaskInput, opts?: RequestOptions): Promise<T.IssuesUnaskOutput>;
|
|
352
364
|
/**
|
|
353
365
|
* Take your reaction back from an issue.
|
|
354
366
|
*/
|
|
@@ -972,6 +984,14 @@ export declare class RepoIssuesResource {
|
|
|
972
984
|
private readonly core;
|
|
973
985
|
private readonly bound;
|
|
974
986
|
constructor(core: Core, bound: RepoBound);
|
|
987
|
+
/**
|
|
988
|
+
* Answer a question on an issue, replacing an earlier answer: `choices` are option labels (one for `single`, any for `multi`), `text` the free-text answer of a `text` question or an `other` answer. You need write access or the issue's lease.
|
|
989
|
+
*/
|
|
990
|
+
answer(input: Omit<T.IssuesAnswerInput, 'owner' | 'repo'>, opts?: RequestOptions): Promise<T.IssuesAnswerOutput>;
|
|
991
|
+
/**
|
|
992
|
+
* Ask a person a question on an issue and read the answer back later from the issue's context (`asks`). `single` takes one of 2 to 10 options, `multi` any number of them, `text` free text; `other` lets a choice question also take free text. The issue reads as needing input, and its assignee is told, until it is answered. You need the issue's lease or write access.
|
|
993
|
+
*/
|
|
994
|
+
ask(input: Omit<T.IssuesAskInput, 'owner' | 'repo'>, opts?: RequestOptions): Promise<T.IssuesAskOutput>;
|
|
975
995
|
/**
|
|
976
996
|
* Delegate an issue to yourself or your agent for a lease, or renew the lease. The issue returns to ready if the lease lapses.
|
|
977
997
|
*/
|
|
@@ -1050,6 +1070,10 @@ export declare class RepoIssuesResource {
|
|
|
1050
1070
|
* Follow an issue to be notified of its activity, or stop following it. Needs only read access.
|
|
1051
1071
|
*/
|
|
1052
1072
|
subscribe(input: Omit<T.IssuesSubscribeInput, 'owner' | 'repo'>, opts?: RequestOptions): Promise<T.IssuesSubscribeOutput>;
|
|
1073
|
+
/**
|
|
1074
|
+
* Take a question back from an issue, answered or not, once its answer is used or it no longer matters. You need the issue's lease or write access.
|
|
1075
|
+
*/
|
|
1076
|
+
unask(input: Omit<T.IssuesUnaskInput, 'owner' | 'repo'>, opts?: RequestOptions): Promise<T.IssuesUnaskOutput>;
|
|
1053
1077
|
/**
|
|
1054
1078
|
* Take your reaction back from an issue.
|
|
1055
1079
|
*/
|
|
@@ -2,4 +2,4 @@ export * from "./api.js";
|
|
|
2
2
|
export { type OpId, ops } from "./ops.js";
|
|
3
3
|
export * as tools from "./tools.js";
|
|
4
4
|
export type * as types from "./types.js";
|
|
5
|
-
export type { AffectedMode, AffectedStep, AgentTrackingState, Annotation, ApiError, Artifacts, AutoMerge, BatchItem, BranchUpdated, CaissonAffected, CaissonAsk, CaissonAstMatch, CaissonAstMatches, CaissonBase, CaissonBashResult, CaissonBatchResult, CaissonChange, CaissonChangeRequest, CaissonChanged, CaissonCommitted, CaissonEdit, CaissonFileRead, CaissonFilesRead, CaissonGlob, CaissonGrep, CaissonGrepCount, CaissonGrepLine, CaissonGrepMatch, CaissonLocated, CaissonLspAnswer, CaissonLspPlace, CaissonLspProgress, CaissonLspQuestion, CaissonLspRenamed, CaissonLspStopped, CaissonPage, CaissonPolicy, CaissonPull, CaissonRefused, CaissonReview, CaissonReviewStatus, CaissonRow, CaissonShipped, CaissonTested, Check, CheckRun, CheckRunAction, CheckRunApp, CheckRunApp2, CheckRunBody, CheckRunBrief, CheckRunList, CheckRunOutput, CheckRunText, CheckSource, CheckState, CheckStep, ChecksState, Claim, CloneDefaults, CloneDefaultsEdit, CloseReason, CodeLine, CodeSnippet, CommentKind, CommentProof, ConflictFile, ConflictKind, ConflictResolution, ConflictSide, ConflictTake, ContextVisibility, CreatedIssue, Delegate, DelegateAsk, DelegateRequest, DeletionScheduled, DiffSide, ErrorCode, ErrorLocation, Event, EventPage, EventSubscription, FailedStep, FileHit, FindingResolution, GithubInstallUrl, GithubInstallation, GithubRepo, GrepMode, Held, HeldDecided, HeldListing, HeldRequest, Hidden, HideReason, Inbox, InboxCounts, InboxItem, Issue, IssueComment, IssueContext, IssueDetail, IssueEvent, IssuePage, IssuePriority, IssueStage, IssueStarted, IssueState, IssueStatus, ItemRef, KeyProof, Label, LabelItem, LabelList, MeUpdated, MergeMethod, Mergeable, Milestone, MilestoneItem, MilestoneList, MilestoneState, MyIssue, MyIssues, NoContent, Opener, PathHit, PathRule, Proof, ProofSource, Pull, PullChecks, PullComment, PullCommit, PullConflicts, PullDetail, PullFile, PullHunk, PullLine, PullMerge, PullPage, PullPatchState, PullThread, QueueBatch, QueueDropped, QueueEntry, QueueStatus, Reaction, Reaction2, ReactionKind, RecoveryCodeList, RefHit, RefHit2, RefResults, RefResults2, RelatedItem, RelatedKind, RelatedLink, RelatedWork, RepoHit, RepoInfo, RepoNote, RepoNoteLimits, RepoNotes, ReviewChange, ReviewComment, ReviewFinding, ReviewFindingInput, ReviewPacket, ReviewRisk, ReviewSince, ReviewSinceFinding, Rollup, Run, RunArtifact, RunCancelled, RunEvent, RunFailures, RunId, RunJob, RunLogPage, RunLogs, RunStep, RunStepLog, RunTests, RunWait, Runs, Sandbox, SandboxBackground, SandboxCaisson, SandboxClass, SandboxExecResult, SandboxHostRef, SandboxIdle, SandboxKind, SandboxOrigin, SandboxPage, SandboxTokenMode, SandboxUsage, SandboxWait, SearchResults, SessionStep, SimilarIssue, SimilarIssues, SkippedWorkflow, SshKey, StackEntry, StopMode, SubIssue, Surface, SymbolHit, SymbolHit2, SymbolResults, SymbolResults2, TestFailure, Token, TokenCreated, TotpSetup, Verdict, Visibility, WaitAnswer, WaitTarget, WorkspaceUnread } from "./types.js";
|
|
5
|
+
export type { AffectedMode, AffectedStep, AgentTrackingState, Annotation, ApiError, Artifacts, AskKind, AskOptionInput, AutoMerge, BatchItem, BranchUpdated, CaissonAffected, CaissonAsk, CaissonAstMatch, CaissonAstMatches, CaissonBase, CaissonBashResult, CaissonBatchResult, CaissonChange, CaissonChangeRequest, CaissonChanged, CaissonCommitted, CaissonEdit, CaissonFileRead, CaissonFilesRead, CaissonGlob, CaissonGrep, CaissonGrepCount, CaissonGrepLine, CaissonGrepMatch, CaissonLocated, CaissonLspAnswer, CaissonLspPlace, CaissonLspProgress, CaissonLspQuestion, CaissonLspRenamed, CaissonLspStopped, CaissonPage, CaissonPolicy, CaissonPull, CaissonRefused, CaissonReview, CaissonReviewStatus, CaissonRow, CaissonShipped, CaissonTested, Check, CheckRun, CheckRunAction, CheckRunApp, CheckRunApp2, CheckRunBody, CheckRunBrief, CheckRunList, CheckRunOutput, CheckRunText, CheckSource, CheckState, CheckStep, ChecksState, Claim, CloneDefaults, CloneDefaultsEdit, CloseReason, CodeLine, CodeSnippet, CommentKind, CommentProof, ConflictFile, ConflictKind, ConflictResolution, ConflictSide, ConflictTake, ContextVisibility, CreatedIssue, Delegate, DelegateAsk, DelegateRequest, DeletionScheduled, DiffSide, ErrorCode, ErrorLocation, Event, EventPage, EventSubscription, FailedStep, FileHit, FindingResolution, GithubInstallUrl, GithubInstallation, GithubRepo, GrepMode, Held, HeldDecided, HeldListing, HeldRequest, Hidden, HideReason, Inbox, InboxCounts, InboxItem, Issue, IssueAsk, IssueAskAnswer, IssueAskOption, IssueComment, IssueContext, IssueDetail, IssueEvent, IssuePage, IssuePriority, IssueStage, IssueStarted, IssueState, IssueStatus, ItemRef, KeyProof, Label, LabelItem, LabelList, MeUpdated, MergeMethod, Mergeable, Milestone, MilestoneItem, MilestoneList, MilestoneState, MyIssue, MyIssues, NoContent, Opener, PathHit, PathRule, Proof, ProofSource, Pull, PullChecks, PullComment, PullCommit, PullConflicts, PullDetail, PullFile, PullHunk, PullLine, PullMerge, PullPage, PullPatchState, PullThread, QueueBatch, QueueDropped, QueueEntry, QueueStatus, Reaction, Reaction2, ReactionKind, RecoveryCodeList, RefHit, RefHit2, RefResults, RefResults2, RelatedItem, RelatedKind, RelatedLink, RelatedWork, RepoHit, RepoInfo, RepoNote, RepoNoteLimits, RepoNotes, ReviewChange, ReviewComment, ReviewFinding, ReviewFindingInput, ReviewPacket, ReviewRisk, ReviewSince, ReviewSinceFinding, Rollup, Run, RunArtifact, RunCancelled, RunEvent, RunFailures, RunId, RunJob, RunLogPage, RunLogs, RunStep, RunStepLog, RunTests, RunWait, Runs, Sandbox, SandboxBackground, SandboxCaisson, SandboxClass, SandboxExecResult, SandboxHostRef, SandboxIdle, SandboxKind, SandboxOrigin, SandboxPage, SandboxTokenMode, SandboxUsage, SandboxWait, SearchResults, SessionStep, SimilarIssue, SimilarIssues, SkippedWorkflow, SshKey, StackEntry, StopMode, SubIssue, Surface, SymbolHit, SymbolHit2, SymbolResults, SymbolResults2, TestFailure, Token, TokenCreated, TotpSetup, Verdict, Visibility, WaitAnswer, WaitTarget, WorkspaceUnread } from "./types.js";
|
|
@@ -753,6 +753,32 @@ export declare const ops: {
|
|
|
753
753
|
long: false;
|
|
754
754
|
paginated: false;
|
|
755
755
|
};
|
|
756
|
+
'issues.answer': {
|
|
757
|
+
id: string;
|
|
758
|
+
method: 'POST';
|
|
759
|
+
path: string;
|
|
760
|
+
pathParams: string[];
|
|
761
|
+
queryParams: never[];
|
|
762
|
+
bodyParams: string[];
|
|
763
|
+
effect: 'write';
|
|
764
|
+
retry: 'idempotent';
|
|
765
|
+
held: false;
|
|
766
|
+
long: false;
|
|
767
|
+
paginated: false;
|
|
768
|
+
};
|
|
769
|
+
'issues.ask': {
|
|
770
|
+
id: string;
|
|
771
|
+
method: 'POST';
|
|
772
|
+
path: string;
|
|
773
|
+
pathParams: string[];
|
|
774
|
+
queryParams: never[];
|
|
775
|
+
bodyParams: string[];
|
|
776
|
+
effect: 'write';
|
|
777
|
+
retry: 'none';
|
|
778
|
+
held: false;
|
|
779
|
+
long: false;
|
|
780
|
+
paginated: false;
|
|
781
|
+
};
|
|
756
782
|
'issues.claim': {
|
|
757
783
|
id: string;
|
|
758
784
|
method: 'POST';
|
|
@@ -1013,6 +1039,19 @@ export declare const ops: {
|
|
|
1013
1039
|
long: false;
|
|
1014
1040
|
paginated: false;
|
|
1015
1041
|
};
|
|
1042
|
+
'issues.unask': {
|
|
1043
|
+
id: string;
|
|
1044
|
+
method: 'DELETE';
|
|
1045
|
+
path: string;
|
|
1046
|
+
pathParams: string[];
|
|
1047
|
+
queryParams: never[];
|
|
1048
|
+
bodyParams: never[];
|
|
1049
|
+
effect: 'write';
|
|
1050
|
+
retry: 'idempotent';
|
|
1051
|
+
held: false;
|
|
1052
|
+
long: false;
|
|
1053
|
+
paginated: false;
|
|
1054
|
+
};
|
|
1016
1055
|
'issues.unreact': {
|
|
1017
1056
|
id: string;
|
|
1018
1057
|
method: 'DELETE';
|
|
@@ -38,6 +38,10 @@ export type ApiError = {
|
|
|
38
38
|
export type Artifacts = {
|
|
39
39
|
artifacts: RunArtifact[];
|
|
40
40
|
};
|
|
41
|
+
/** How a person answers an [`IssueAsk`]: `single` (one option), `multi` (any number of options) or `text` (free text). */
|
|
42
|
+
export type AskKind = 'single' | 'multi' | 'text';
|
|
43
|
+
/** An option as an asker writes it: its label alone, or the label with a description. */
|
|
44
|
+
export type AskOptionInput = string | IssueAskOption;
|
|
41
45
|
/** A pull request's auto-merge: `GET`, `PUT` and `DELETE pulls/{n}/auto-merge`. */
|
|
42
46
|
export type AutoMerge = {
|
|
43
47
|
/** Who turned it on; the merge is made as them. */
|
|
@@ -914,6 +918,36 @@ export type Issue = {
|
|
|
914
918
|
/** Last write of any kind. */
|
|
915
919
|
updatedAt: string;
|
|
916
920
|
};
|
|
921
|
+
/** A question for a person, answered in place. */
|
|
922
|
+
export type IssueAsk = {
|
|
923
|
+
agent?: string | null;
|
|
924
|
+
/** `None` until someone answers. */
|
|
925
|
+
answer?: IssueAskAnswer | null;
|
|
926
|
+
at: string;
|
|
927
|
+
by: string;
|
|
928
|
+
/** Pass it to `issue answer` and `issue unask`. */
|
|
929
|
+
id: string;
|
|
930
|
+
kind: AskKind;
|
|
931
|
+
options?: IssueAskOption[];
|
|
932
|
+
/** A `single` or `multi` question that also takes free text beside its options. */
|
|
933
|
+
other?: boolean;
|
|
934
|
+
/** The label of the option the asker suggests. */
|
|
935
|
+
recommended?: string | null;
|
|
936
|
+
text: string;
|
|
937
|
+
};
|
|
938
|
+
export type IssueAskAnswer = {
|
|
939
|
+
agent?: string | null;
|
|
940
|
+
at: string;
|
|
941
|
+
by: string;
|
|
942
|
+
/** The labels of the options picked. */
|
|
943
|
+
choices?: string[];
|
|
944
|
+
/** The free text: the whole answer to a `text` question, or what an `other` answer adds. */
|
|
945
|
+
text?: string;
|
|
946
|
+
};
|
|
947
|
+
export type IssueAskOption = {
|
|
948
|
+
description?: string | null;
|
|
949
|
+
label: string;
|
|
950
|
+
};
|
|
917
951
|
export type IssueComment = {
|
|
918
952
|
agent: boolean;
|
|
919
953
|
at: string;
|
|
@@ -935,6 +969,8 @@ export type IssueComment = {
|
|
|
935
969
|
/** Where the work stands, for whoever picks the issue up next. */
|
|
936
970
|
export type IssueContext = {
|
|
937
971
|
agent?: string | null;
|
|
972
|
+
/** Questions with a kind and options, answered in place; an unanswered one makes the issue read as needing input. */
|
|
973
|
+
asks?: IssueAsk[];
|
|
938
974
|
at: string;
|
|
939
975
|
branch?: string | null;
|
|
940
976
|
/** The account that last wrote it. */
|
|
@@ -2958,6 +2994,46 @@ export type InboxReadInput = {
|
|
|
2958
2994
|
tab?: string | null;
|
|
2959
2995
|
};
|
|
2960
2996
|
export type InboxReadOutput = null;
|
|
2997
|
+
/**
|
|
2998
|
+
* Answer a question on an issue, replacing an earlier answer: `choices` are option labels (one for `single`, any for `multi`), `text` the free-text answer of a `text` question or an `other` answer. You need write access or the issue's lease.
|
|
2999
|
+
*/
|
|
3000
|
+
export type IssuesAnswerInput = {
|
|
3001
|
+
/** The labels of the options picked. */
|
|
3002
|
+
choices?: string[];
|
|
3003
|
+
/** The question's id, from the issue's context. */
|
|
3004
|
+
id: string;
|
|
3005
|
+
/** Issue number. */
|
|
3006
|
+
number: number;
|
|
3007
|
+
/** The repository's owner: a user or an org handle. */
|
|
3008
|
+
owner: string;
|
|
3009
|
+
/** The repository's name. */
|
|
3010
|
+
repo: string;
|
|
3011
|
+
/** The answer in your own words. */
|
|
3012
|
+
text?: string;
|
|
3013
|
+
};
|
|
3014
|
+
export type IssuesAnswerOutput = Issue;
|
|
3015
|
+
/**
|
|
3016
|
+
* Ask a person a question on an issue and read the answer back later from the issue's context (`asks`). `single` takes one of 2 to 10 options, `multi` any number of them, `text` free text; `other` lets a choice question also take free text. The issue reads as needing input, and its assignee is told, until it is answered. You need the issue's lease or write access.
|
|
3017
|
+
*/
|
|
3018
|
+
export type IssuesAskInput = {
|
|
3019
|
+
/** `single` (pick one option), `multi` (pick any) or `text` (free text). */
|
|
3020
|
+
kind: AskKind;
|
|
3021
|
+
/** Issue number. */
|
|
3022
|
+
number: number;
|
|
3023
|
+
/** The choices of a `single` or `multi` question, 2 to 10, each a label or `{label, description}`; none for `text`. */
|
|
3024
|
+
options?: AskOptionInput[];
|
|
3025
|
+
/** true lets a `single` or `multi` question also take an answer in the person's own words. */
|
|
3026
|
+
other?: boolean;
|
|
3027
|
+
/** The repository's owner: a user or an org handle. */
|
|
3028
|
+
owner: string;
|
|
3029
|
+
/** The label of the option you suggest. */
|
|
3030
|
+
recommended?: string | null;
|
|
3031
|
+
/** The repository's name. */
|
|
3032
|
+
repo: string;
|
|
3033
|
+
/** The whole question, in Markdown, with what the person needs to answer it (up to 2000 characters). */
|
|
3034
|
+
text: string;
|
|
3035
|
+
};
|
|
3036
|
+
export type IssuesAskOutput = Issue;
|
|
2961
3037
|
/**
|
|
2962
3038
|
* Delegate an issue to yourself or your agent for a lease, or renew the lease. The issue returns to ready if the lease lapses.
|
|
2963
3039
|
*/
|
|
@@ -3320,6 +3396,20 @@ export type IssuesSubscribeInput = {
|
|
|
3320
3396
|
subscribed: boolean;
|
|
3321
3397
|
};
|
|
3322
3398
|
export type IssuesSubscribeOutput = Issue;
|
|
3399
|
+
/**
|
|
3400
|
+
* Take a question back from an issue, answered or not, once its answer is used or it no longer matters. You need the issue's lease or write access.
|
|
3401
|
+
*/
|
|
3402
|
+
export type IssuesUnaskInput = {
|
|
3403
|
+
/** The question's id, from the issue's context. */
|
|
3404
|
+
id: string;
|
|
3405
|
+
/** Issue number. */
|
|
3406
|
+
number: number;
|
|
3407
|
+
/** The repository's owner: a user or an org handle. */
|
|
3408
|
+
owner: string;
|
|
3409
|
+
/** The repository's name. */
|
|
3410
|
+
repo: string;
|
|
3411
|
+
};
|
|
3412
|
+
export type IssuesUnaskOutput = Issue;
|
|
3323
3413
|
/**
|
|
3324
3414
|
* Take your reaction back from an issue.
|
|
3325
3415
|
*/
|
package/llms.txt
CHANGED
|
@@ -91,6 +91,8 @@
|
|
|
91
91
|
|
|
92
92
|
## issues
|
|
93
93
|
|
|
94
|
+
- `sf.issues.answer(input)`: Answer a question on an issue, replacing an earlier answer: `choices` are option labels (one for `single`, any for `multi`), `text` the free-text answer of a `text` question or an `other` answer. You need write access or the issue's lease.
|
|
95
|
+
- `sf.issues.ask(input)`: Ask a person a question on an issue and read the answer back later from the issue's context (`asks`). `single` takes one of 2 to 10 options, `multi` any number of them, `text` free text; `other` lets a choice question also take free text. The issue reads as needing input, and its assignee is told, until it is answered. You need the issue's lease or write access.
|
|
94
96
|
- `sf.issues.claim(input)`: Delegate an issue to yourself or your agent for a lease, or renew the lease. The issue returns to ready if the lease lapses.
|
|
95
97
|
- `sf.issues.close(input)`: Close an issue with a reason, after posting an optional comment. Without a `reason` it is `done`, or `duplicate` when `duplicateOf` names the issue it repeats.
|
|
96
98
|
- `sf.issues.comment(input)`: Comment on an issue, or post a progress update as whoever holds its lease.
|
|
@@ -111,6 +113,7 @@
|
|
|
111
113
|
- `sf.issues.similar(input)`: Check for issues the title reads like, open ones closest first, to look through before filing a duplicate.
|
|
112
114
|
- `sf.issues.start(input)`: Claim an issue and open a caisson on its branch, or return the live caisson already working on it. Safe to repeat.
|
|
113
115
|
- `sf.issues.subscribe(input)`: Follow an issue to be notified of its activity, or stop following it. Needs only read access.
|
|
116
|
+
- `sf.issues.unask(input)`: Take a question back from an issue, answered or not, once its answer is used or it no longer matters. You need the issue's lease or write access.
|
|
114
117
|
- `sf.issues.unreact(input)`: Take your reaction back from an issue.
|
|
115
118
|
- `sf.issues.update(input)`: Change any field of an issue. A field left out stays; `null` clears the ones that can be cleared. An issue's author may change its words and whether it is open without write access.
|
|
116
119
|
|