Skip to content

Commit dece57d

Browse files
authored
Merge pull request #397 from flashcatcloud/feat/rum-application-repositories
docs(api): document linked source code repositories on RUM applications
2 parents 1708c59 + 7e3a424 commit dece57d

4 files changed

Lines changed: 192 additions & 0 deletions

File tree

‎api-reference/openapi.en.json‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19425,6 +19425,14 @@
1942519425
"$ref": "#/components/schemas/RumApplicationLinks",
1942619426
"description": "Optional external-link integration configuration."
1942719427
},
19428+
"repositories": {
19429+
"type": "array",
19430+
"items": {
19431+
"$ref": "#/components/schemas/RumApplicationRepository"
19432+
},
19433+
"maxItems": 10,
19434+
"description": "Source code repositories to link, in order; the first entry is the primary repository. At most 10 entries."
19435+
},
1942819436
"no_geo": {
1942919437
"description": "Do not infer geographic location.",
1943019438
"type": "boolean"
@@ -19571,6 +19579,14 @@
1957119579
"$ref": "#/components/schemas/RumApplicationLinks",
1957219580
"description": "External-link integration configuration."
1957319581
},
19582+
"repositories": {
19583+
"type": "array",
19584+
"items": {
19585+
"$ref": "#/components/schemas/RumApplicationRepository"
19586+
},
19587+
"maxItems": 10,
19588+
"description": "Linked source code repositories, in order; the first entry is the primary repository. Linking grants no access by itself: AI sessions can only read repositories granted to the account's GitHub App installations."
19589+
},
1957419590
"no_geo": {
1957519591
"description": "If `true`, geographic location is not inferred from IP.",
1957619592
"type": "boolean"
@@ -19827,6 +19843,15 @@
1982719843
"description": "External-link integration configuration. Omit to leave unchanged.",
1982819844
"x-flashduty-preserve-absence": true
1982919845
},
19846+
"repositories": {
19847+
"type": "array",
19848+
"items": {
19849+
"$ref": "#/components/schemas/RumApplicationRepository"
19850+
},
19851+
"maxItems": 10,
19852+
"description": "Replaces the linked source code repositories when present; an empty array removes all links, and omitting the field leaves them unchanged. At most 10 entries.",
19853+
"x-flashduty-preserve-absence": true
19854+
},
1983019855
"no_geo": {
1983119856
"description": "When `true`, stop inferring geographic location from IP; when `false`, resume inferring it. Omit to leave unchanged.",
1983219857
"type": [
@@ -29286,6 +29311,29 @@
2928629311
"description": "Why the recipient was skipped. Only present when `status` is `skipped`. `not_member` — not an active member of the caller's account; `no_email` — the member has no email address on file; `email_disabled` — the member's notification preferences for this kind of message exclude email; `duplicate` — this recipient already received a message from the same AI SRE session turn; `rate_limited` — this recipient has already been sent 20 emails through this endpoint within the last hour; `send_failed` — enqueueing the email failed."
2928729312
}
2928829313
}
29314+
},
29315+
"RumApplicationRepository": {
29316+
"type": "object",
29317+
"description": "Source code repository that builds the application.",
29318+
"required": [
29319+
"repo"
29320+
],
29321+
"properties": {
29322+
"repo": {
29323+
"type": "string",
29324+
"description": "GitHub repository in `owner/name` form.",
29325+
"examples": [
29326+
"acme/web-app"
29327+
]
29328+
},
29329+
"subdir": {
29330+
"type": "string",
29331+
"description": "Directory holding the application inside the repository, relative to the repository root. `.` is the repository root; an empty value is saved as `.`.",
29332+
"examples": [
29333+
"apps/web"
29334+
]
29335+
}
29336+
}
2928929337
}
2929029338
},
2929129339
"securitySchemes": {

‎api-reference/openapi.zh.json‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19425,6 +19425,14 @@
1942519425
"$ref": "#/components/schemas/RumApplicationLinks",
1942619426
"description": "外部链接集成配置,可选。"
1942719427
},
19428+
"repositories": {
19429+
"type": "array",
19430+
"items": {
19431+
"$ref": "#/components/schemas/RumApplicationRepository"
19432+
},
19433+
"maxItems": 10,
19434+
"description": "要关联的代码仓库,有序;第一个为主仓库。最多 10 个。"
19435+
},
1942819436
"no_geo": {
1942919437
"description": "不推断地理位置。",
1943019438
"type": "boolean"
@@ -19571,6 +19579,14 @@
1957119579
"$ref": "#/components/schemas/RumApplicationLinks",
1957219580
"description": "外部链接集成配置。"
1957319581
},
19582+
"repositories": {
19583+
"type": "array",
19584+
"items": {
19585+
"$ref": "#/components/schemas/RumApplicationRepository"
19586+
},
19587+
"maxItems": 10,
19588+
"description": "关联的代码仓库,有序;第一个为主仓库。关联本身不授予任何访问权限:AI 会话只能读取本账户 GitHub App 安装已授权的仓库。"
19589+
},
1957419590
"no_geo": {
1957519591
"description": "为 `true` 时不推断地理位置。",
1957619592
"type": "boolean"
@@ -19827,6 +19843,15 @@
1982719843
"description": "外部链接集成配置;不传则保持不变。",
1982819844
"x-flashduty-preserve-absence": true
1982919845
},
19846+
"repositories": {
19847+
"type": "array",
19848+
"items": {
19849+
"$ref": "#/components/schemas/RumApplicationRepository"
19850+
},
19851+
"maxItems": 10,
19852+
"description": "传入时整体替换关联的代码仓库;传空数组表示清空,不传则保持不变。最多 10 个。",
19853+
"x-flashduty-preserve-absence": true
19854+
},
1983019855
"no_geo": {
1983119856
"description": "为 `true` 时不再基于 IP 推断地理位置,为 `false` 时恢复推断;不传则保持不变。",
1983219857
"type": [
@@ -29286,6 +29311,29 @@
2928629311
"description": "跳过原因,仅当 `status` 为 `skipped` 时出现。`not_member` —— 不是调用方账户的活跃成员;`no_email` —— 该成员没有邮箱地址;`email_disabled` —— 该成员针对此类消息的通知偏好中未包含邮件;`duplicate` —— 该收件人在同一个 AI SRE 会话轮次中已经收到过一次消息;`rate_limited` —— 该收件人通过该接口在过去一小时内已被发送 20 封邮件;`send_failed` —— 邮件入队失败。"
2928729312
}
2928829313
}
29314+
},
29315+
"RumApplicationRepository": {
29316+
"type": "object",
29317+
"description": "构建该应用的代码仓库。",
29318+
"required": [
29319+
"repo"
29320+
],
29321+
"properties": {
29322+
"repo": {
29323+
"type": "string",
29324+
"description": "GitHub 仓库,格式为 `owner/name`。",
29325+
"examples": [
29326+
"acme/web-app"
29327+
]
29328+
},
29329+
"subdir": {
29330+
"type": "string",
29331+
"description": "应用在仓库内所在的目录,相对仓库根目录。`.` 表示仓库根目录;传空值时保存为 `.`。",
29332+
"examples": [
29333+
"apps/web"
29334+
]
29335+
}
29336+
}
2928929337
}
2929029338
},
2929129339
"securitySchemes": {

‎api-reference/rum.openapi.en.json‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -610,6 +610,14 @@
610610
"$ref": "#/components/schemas/RumApplicationLinks",
611611
"description": "Optional external-link integration configuration."
612612
},
613+
"repositories": {
614+
"type": "array",
615+
"items": {
616+
"$ref": "#/components/schemas/RumApplicationRepository"
617+
},
618+
"maxItems": 10,
619+
"description": "Source code repositories to link, in order; the first entry is the primary repository. At most 10 entries."
620+
},
613621
"no_geo": {
614622
"description": "Do not infer geographic location.",
615623
"type": "boolean"
@@ -756,6 +764,14 @@
756764
"$ref": "#/components/schemas/RumApplicationLinks",
757765
"description": "External-link integration configuration."
758766
},
767+
"repositories": {
768+
"type": "array",
769+
"items": {
770+
"$ref": "#/components/schemas/RumApplicationRepository"
771+
},
772+
"maxItems": 10,
773+
"description": "Linked source code repositories, in order; the first entry is the primary repository. Linking grants no access by itself: AI sessions can only read repositories granted to the account's GitHub App installations."
774+
},
759775
"no_geo": {
760776
"description": "If `true`, geographic location is not inferred from IP.",
761777
"type": "boolean"
@@ -1012,6 +1028,15 @@
10121028
"description": "External-link integration configuration. Omit to leave unchanged.",
10131029
"x-flashduty-preserve-absence": true
10141030
},
1031+
"repositories": {
1032+
"type": "array",
1033+
"items": {
1034+
"$ref": "#/components/schemas/RumApplicationRepository"
1035+
},
1036+
"maxItems": 10,
1037+
"description": "Replaces the linked source code repositories when present; an empty array removes all links, and omitting the field leaves them unchanged. At most 10 entries.",
1038+
"x-flashduty-preserve-absence": true
1039+
},
10151040
"no_geo": {
10161041
"description": "When `true`, stop inferring geographic location from IP; when `false`, resume inferring it. Omit to leave unchanged.",
10171042
"type": [
@@ -3938,6 +3963,29 @@
39383963
}
39393964
},
39403965
"type": "object"
3966+
},
3967+
"RumApplicationRepository": {
3968+
"type": "object",
3969+
"description": "Source code repository that builds the application.",
3970+
"required": [
3971+
"repo"
3972+
],
3973+
"properties": {
3974+
"repo": {
3975+
"type": "string",
3976+
"description": "GitHub repository in `owner/name` form.",
3977+
"examples": [
3978+
"acme/web-app"
3979+
]
3980+
},
3981+
"subdir": {
3982+
"type": "string",
3983+
"description": "Directory holding the application inside the repository, relative to the repository root. `.` is the repository root; an empty value is saved as `.`.",
3984+
"examples": [
3985+
"apps/web"
3986+
]
3987+
}
3988+
}
39413989
}
39423990
},
39433991
"securitySchemes": {

‎api-reference/rum.openapi.zh.json‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -610,6 +610,14 @@
610610
"$ref": "#/components/schemas/RumApplicationLinks",
611611
"description": "外部链接集成配置,可选。"
612612
},
613+
"repositories": {
614+
"type": "array",
615+
"items": {
616+
"$ref": "#/components/schemas/RumApplicationRepository"
617+
},
618+
"maxItems": 10,
619+
"description": "要关联的代码仓库,有序;第一个为主仓库。最多 10 个。"
620+
},
613621
"no_geo": {
614622
"description": "不推断地理位置。",
615623
"type": "boolean"
@@ -756,6 +764,14 @@
756764
"$ref": "#/components/schemas/RumApplicationLinks",
757765
"description": "外部链接集成配置。"
758766
},
767+
"repositories": {
768+
"type": "array",
769+
"items": {
770+
"$ref": "#/components/schemas/RumApplicationRepository"
771+
},
772+
"maxItems": 10,
773+
"description": "关联的代码仓库,有序;第一个为主仓库。关联本身不授予任何访问权限:AI 会话只能读取本账户 GitHub App 安装已授权的仓库。"
774+
},
759775
"no_geo": {
760776
"description": "为 `true` 时不推断地理位置。",
761777
"type": "boolean"
@@ -1012,6 +1028,15 @@
10121028
"description": "外部链接集成配置;不传则保持不变。",
10131029
"x-flashduty-preserve-absence": true
10141030
},
1031+
"repositories": {
1032+
"type": "array",
1033+
"items": {
1034+
"$ref": "#/components/schemas/RumApplicationRepository"
1035+
},
1036+
"maxItems": 10,
1037+
"description": "传入时整体替换关联的代码仓库;传空数组表示清空,不传则保持不变。最多 10 个。",
1038+
"x-flashduty-preserve-absence": true
1039+
},
10151040
"no_geo": {
10161041
"description": "为 `true` 时不再基于 IP 推断地理位置,为 `false` 时恢复推断;不传则保持不变。",
10171042
"type": [
@@ -3938,6 +3963,29 @@
39383963
}
39393964
},
39403965
"type": "object"
3966+
},
3967+
"RumApplicationRepository": {
3968+
"type": "object",
3969+
"description": "构建该应用的代码仓库。",
3970+
"required": [
3971+
"repo"
3972+
],
3973+
"properties": {
3974+
"repo": {
3975+
"type": "string",
3976+
"description": "GitHub 仓库,格式为 `owner/name`。",
3977+
"examples": [
3978+
"acme/web-app"
3979+
]
3980+
},
3981+
"subdir": {
3982+
"type": "string",
3983+
"description": "应用在仓库内所在的目录,相对仓库根目录。`.` 表示仓库根目录;传空值时保存为 `.`。",
3984+
"examples": [
3985+
"apps/web"
3986+
]
3987+
}
3988+
}
39413989
}
39423990
},
39433991
"securitySchemes": {

0 commit comments

Comments
 (0)