Skip to content

docs(api): document linked source code repositories on RUM applications #397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ysyneu merged 1 commit into from
Sep 16, 2026
Merged

docs(api): document linked source code repositories on RUM applications #397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions api-reference/openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19376,6 +19376,14 @@
"$ref": "#/components/schemas/RumApplicationLinks",
"description": "Optional external-link integration configuration."
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RumApplicationRepository"
},
"maxItems": 10,
"description": "Source code repositories to link, in order; the first entry is the primary repository. At most 10 entries."
},
"no_geo": {
"description": "Do not infer geographic location.",
"type": "boolean"
Expand Down Expand Up @@ -19522,6 +19530,14 @@
"$ref": "#/components/schemas/RumApplicationLinks",
"description": "External-link integration configuration."
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RumApplicationRepository"
},
"maxItems": 10,
"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."
},
"no_geo": {
"description": "If `true`, geographic location is not inferred from IP.",
"type": "boolean"
Expand Down Expand Up @@ -19778,6 +19794,15 @@
"description": "External-link integration configuration. Omit to leave unchanged.",
"x-flashduty-preserve-absence": true
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RumApplicationRepository"
},
"maxItems": 10,
"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.",
"x-flashduty-preserve-absence": true
},
"no_geo": {
"description": "When `true`, stop inferring geographic location from IP; when `false`, resume inferring it. Omit to leave unchanged.",
"type": [
Expand Down Expand Up @@ -29091,6 +29116,29 @@
"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."
}
}
},
"RumApplicationRepository": {
"type": "object",
"description": "Source code repository that builds the application.",
"required": [
"repo"
],
"properties": {
"repo": {
"type": "string",
"description": "GitHub repository in `owner/name` form.",
"examples": [
"acme/web-app"
]
},
"subdir": {
"type": "string",
"description": "Directory holding the application inside the repository, relative to the repository root. `.` is the repository root; an empty value is saved as `.`.",
"examples": [
"apps/web"
]
}
}
}
},
"securitySchemes": {
Expand Down
48 changes: 48 additions & 0 deletions api-reference/openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19376,6 +19376,14 @@
"$ref": "#/components/schemas/RumApplicationLinks",
"description": "外部链接集成配置，可选。"
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RumApplicationRepository"
},
"maxItems": 10,
"description": "要关联的代码仓库，有序；第一个为主仓库。最多 10 个。"
},
"no_geo": {
"description": "不推断地理位置。",
"type": "boolean"
Expand Down Expand Up @@ -19522,6 +19530,14 @@
"$ref": "#/components/schemas/RumApplicationLinks",
"description": "外部链接集成配置。"
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RumApplicationRepository"
},
"maxItems": 10,
"description": "关联的代码仓库，有序；第一个为主仓库。关联本身不授予任何访问权限：AI 会话只能读取本账户 GitHub App 安装已授权的仓库。"
},
"no_geo": {
"description": "为 `true` 时不推断地理位置。",
"type": "boolean"
Expand Down Expand Up @@ -19778,6 +19794,15 @@
"description": "外部链接集成配置；不传则保持不变。",
"x-flashduty-preserve-absence": true
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RumApplicationRepository"
},
"maxItems": 10,
"description": "传入时整体替换关联的代码仓库；传空数组表示清空，不传则保持不变。最多 10 个。",
"x-flashduty-preserve-absence": true
},
"no_geo": {
"description": "为 `true` 时不再基于 IP 推断地理位置，为 `false` 时恢复推断；不传则保持不变。",
"type": [
Expand Down Expand Up @@ -29091,6 +29116,29 @@
"description": "跳过原因，仅当 `status` 为 `skipped` 时出现。`not_member` —— 不是调用方账户的活跃成员；`no_email` —— 该成员没有邮箱地址；`email_disabled` —— 该成员针对此类消息的通知偏好中未包含邮件；`duplicate` —— 该收件人在同一个 AI SRE 会话轮次中已经收到过一次消息；`rate_limited` —— 该收件人通过该接口在过去一小时内已被发送 20 封邮件；`send_failed` —— 邮件入队失败。"
}
}
},
"RumApplicationRepository": {
"type": "object",
"description": "构建该应用的代码仓库。",
"required": [
"repo"
],
"properties": {
"repo": {
"type": "string",
"description": "GitHub 仓库，格式为 `owner/name`。",
"examples": [
"acme/web-app"
]
},
"subdir": {
"type": "string",
"description": "应用在仓库内所在的目录，相对仓库根目录。`.` 表示仓库根目录；传空值时保存为 `.`。",
"examples": [
"apps/web"
]
}
}
}
},
"securitySchemes": {
Expand Down
48 changes: 48 additions & 0 deletions api-reference/rum.openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -610,6 +610,14 @@
"$ref": "#/components/schemas/RumApplicationLinks",
"description": "Optional external-link integration configuration."
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RumApplicationRepository"
},
"maxItems": 10,
"description": "Source code repositories to link, in order; the first entry is the primary repository. At most 10 entries."
},
"no_geo": {
"description": "Do not infer geographic location.",
"type": "boolean"
Expand Down Expand Up @@ -756,6 +764,14 @@
"$ref": "#/components/schemas/RumApplicationLinks",
"description": "External-link integration configuration."
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RumApplicationRepository"
},
"maxItems": 10,
"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."
},
"no_geo": {
"description": "If `true`, geographic location is not inferred from IP.",
"type": "boolean"
Expand Down Expand Up @@ -1012,6 +1028,15 @@
"description": "External-link integration configuration. Omit to leave unchanged.",
"x-flashduty-preserve-absence": true
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RumApplicationRepository"
},
"maxItems": 10,
"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.",
"x-flashduty-preserve-absence": true
},
"no_geo": {
"description": "When `true`, stop inferring geographic location from IP; when `false`, resume inferring it. Omit to leave unchanged.",
"type": [
Expand Down Expand Up @@ -3938,6 +3963,29 @@
}
},
"type": "object"
},
"RumApplicationRepository": {
"type": "object",
"description": "Source code repository that builds the application.",
"required": [
"repo"
],
"properties": {
"repo": {
"type": "string",
"description": "GitHub repository in `owner/name` form.",
"examples": [
"acme/web-app"
]
},
"subdir": {
"type": "string",
"description": "Directory holding the application inside the repository, relative to the repository root. `.` is the repository root; an empty value is saved as `.`.",
"examples": [
"apps/web"
]
}
}
}
},
"securitySchemes": {
Expand Down
48 changes: 48 additions & 0 deletions api-reference/rum.openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -610,6 +610,14 @@
"$ref": "#/components/schemas/RumApplicationLinks",
"description": "外部链接集成配置，可选。"
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RumApplicationRepository"
},
"maxItems": 10,
"description": "要关联的代码仓库，有序；第一个为主仓库。最多 10 个。"
},
"no_geo": {
"description": "不推断地理位置。",
"type": "boolean"
Expand Down Expand Up @@ -756,6 +764,14 @@
"$ref": "#/components/schemas/RumApplicationLinks",
"description": "外部链接集成配置。"
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RumApplicationRepository"
},
"maxItems": 10,
"description": "关联的代码仓库，有序；第一个为主仓库。关联本身不授予任何访问权限：AI 会话只能读取本账户 GitHub App 安装已授权的仓库。"
},
"no_geo": {
"description": "为 `true` 时不推断地理位置。",
"type": "boolean"
Expand Down Expand Up @@ -1012,6 +1028,15 @@
"description": "外部链接集成配置；不传则保持不变。",
"x-flashduty-preserve-absence": true
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RumApplicationRepository"
},
"maxItems": 10,
"description": "传入时整体替换关联的代码仓库；传空数组表示清空，不传则保持不变。最多 10 个。",
"x-flashduty-preserve-absence": true
},
"no_geo": {
"description": "为 `true` 时不再基于 IP 推断地理位置，为 `false` 时恢复推断；不传则保持不变。",
"type": [
Expand Down Expand Up @@ -3938,6 +3963,29 @@
}
},
"type": "object"
},
"RumApplicationRepository": {
"type": "object",
"description": "构建该应用的代码仓库。",
"required": [
"repo"
],
"properties": {
"repo": {
"type": "string",
"description": "GitHub 仓库，格式为 `owner/name`。",
"examples": [
"acme/web-app"
]
},
"subdir": {
"type": "string",
"description": "应用在仓库内所在的目录，相对仓库根目录。`.` 表示仓库根目录；传空值时保存为 `.`。",
"examples": [
"apps/web"
]
}
}
}
},
"securitySchemes": {
Expand Down
Loading