Interface SiteDTO

站点在注册表中的完整描述,站点注册接口与查询接口的返回数据。

NameData TypeRequiredDescription
namestringYes站点名,全局唯一
domainstringNo绑定域名,缺省时站点仅可经路径前缀访问
sourceKindstringYes来源类型
sourceUrlstringNogit 仓库地址,sourceKind 为 `git` 时存在
refstringNogit 分支或标签,sourceKind 为 `git` 时存在
pagesnumberYes站点页面总数
builtAtstringYes最近一次构建完成时间,ISO 8601 格式
type SiteDTO = {
  /** 站点名,全局唯一 */
  name: string
  /** 绑定域名,缺省时站点仅可经路径前缀访问 */
  domain?: string
  /** 来源类型 */
  sourceKind: 'git' | 'artifact'
  /** git 仓库地址,sourceKind 为 `git` 时存在 */
  sourceUrl?: string
  /** git 分支或标签,sourceKind 为 `git` 时存在 */
  ref?: string
  /** 站点页面总数 */
  pages: number
  /** 最近一次构建完成时间,ISO 8601 格式 */
  builtAt: string
}
{
  "name": "my-docs",
  "domain": "docs.example.com",
  "sourceKind": "git",
  "sourceUrl": "https://github.com/acme/docs.git",
  "ref": "main",
  "pages": 42,
  "builtAt": "2026-01-12T08:30:00.000Z"
}