Skip to content

docs(api-reference): 补 safari SignedURLs 的 artifact frame 字段（api-review 2026-10-21） #1116

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
Oct 22, 2026
Merged

docs(api-reference): 补 safari SignedURLs 的 artifact frame 字段（api-review 2026-10-21） #1116

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
16 changes: 16 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 @@ -25283,6 +25283,18 @@
"type": "integer",
"description": "Validity of both URLs in seconds. Always `300`."
},
"frame_url": {
"type": "string",
"description": "Sandboxed iframe URL (`/safari/artifact/f/<token>/<file name>`) that serves this file for an embedded preview. The token in the path is its only credential; it expires with `frame_expires_in`."
},
"frame_base": {
"type": "string",
"description": "Frame URL directory of this artifact version, ending with `/`; append a file's relative path to load any file of a multi-file version. Empty, and therefore omitted, for single-object rows, whose frame route resolves only the file's own name."
},
"frame_expires_in": {
"type": "integer",
"description": "Validity of `frame_url` and `frame_base` in seconds. Always `43200` (12 hours)."
},
"name": {
"type": "string",
"description": "File name including extension."
Expand All @@ -25301,6 +25313,8 @@
"download_url",
"preview_url",
"expires_in",
"frame_url",
"frame_expires_in",
"name",
"size",
"content_type"
Expand Down Expand Up @@ -61623,6 +61637,8 @@
"download_url": "/safari/artifact/stream?mode=download&t=eyJmaWxlX2lkIjoicGZfU2RoRUE1ZmJaSkduSHp3ck5KTU1TQiJ9.c2lnbmF0dXJl",
"preview_url": "/safari/artifact/stream?mode=preview&t=eyJmaWxlX2lkIjoicGZfU2RoRUE1ZmJaSkduSHp3ck5KTU1TQiJ9.c2lnbmF0dXJl",
"expires_in": 300,
"frame_url": "/safari/artifact/f/eyJmaWxlX2lkIjoicGZfU2RoRUE1ZmJaSkduSHp3ck5KTU1TQiJ9.c2lnbmF0dXJl/checkout-latency-postmortem.html",
"frame_expires_in": 43200,
"name": "checkout-latency-postmortem.html",
"size": 18996,
"content_type": "text/html"
Expand Down
16 changes: 16 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 @@ -25283,6 +25283,18 @@
"type": "integer",
"description": "两个链接的有效期，单位秒。固定为 `300`。"
},
"frame_url": {
"type": "string",
"description": "沙箱 iframe 地址（`/safari/artifact/f/<token>/<file name>`），供内嵌预览加载该文件。路径中的 token 是它唯一的凭据，随 `frame_expires_in` 过期。"
},
"frame_base": {
"type": "string",
"description": "该产物版本的 frame 目录地址，以 `/` 结尾；在其后拼接文件相对路径即可加载多文件版本中的任意文件。单文件记录该值为空，因此被省略，其 frame 路由只解析该文件自身的名字。"
},
"frame_expires_in": {
"type": "integer",
"description": "`frame_url` 与 `frame_base` 的有效期，单位秒。固定为 `43200`（12 小时）。"
},
"name": {
"type": "string",
"description": "文件名（含扩展名）。"
Expand All @@ -25301,6 +25313,8 @@
"download_url",
"preview_url",
"expires_in",
"frame_url",
"frame_expires_in",
"name",
"size",
"content_type"
Expand Down Expand Up @@ -61623,6 +61637,8 @@
"download_url": "/safari/artifact/stream?mode=download&t=eyJmaWxlX2lkIjoicGZfU2RoRUE1ZmJaSkduSHp3ck5KTU1TQiJ9.c2lnbmF0dXJl",
"preview_url": "/safari/artifact/stream?mode=preview&t=eyJmaWxlX2lkIjoicGZfU2RoRUE1ZmJaSkduSHp3ck5KTU1TQiJ9.c2lnbmF0dXJl",
"expires_in": 300,
"frame_url": "/safari/artifact/f/eyJmaWxlX2lkIjoicGZfU2RoRUE1ZmJaSkduSHp3ck5KTU1TQiJ9.c2lnbmF0dXJl/checkout-latency-postmortem.html",
"frame_expires_in": 43200,
"name": "checkout-latency-postmortem.html",
"size": 18996,
"content_type": "text/html"
Expand Down
16 changes: 16 additions & 0 deletions api-reference/safari.openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4495,6 +4495,8 @@
"download_url": "/safari/artifact/stream?mode=download&t=eyJmaWxlX2lkIjoicGZfU2RoRUE1ZmJaSkduSHp3ck5KTU1TQiJ9.c2lnbmF0dXJl",
"preview_url": "/safari/artifact/stream?mode=preview&t=eyJmaWxlX2lkIjoicGZfU2RoRUE1ZmJaSkduSHp3ck5KTU1TQiJ9.c2lnbmF0dXJl",
"expires_in": 300,
"frame_url": "/safari/artifact/f/eyJmaWxlX2lkIjoicGZfU2RoRUE1ZmJaSkduSHp3ck5KTU1TQiJ9.c2lnbmF0dXJl/checkout-latency-postmortem.html",
"frame_expires_in": 43200,
"name": "checkout-latency-postmortem.html",
"size": 18996,
"content_type": "text/html"
Expand Down Expand Up @@ -9483,6 +9485,18 @@
"type": "integer",
"description": "Validity of both URLs in seconds. Always `300`."
},
"frame_url": {
"type": "string",
"description": "Sandboxed iframe URL (`/safari/artifact/f/<token>/<file name>`) that serves this file for an embedded preview. The token in the path is its only credential; it expires with `frame_expires_in`."
},
"frame_base": {
"type": "string",
"description": "Frame URL directory of this artifact version, ending with `/`; append a file's relative path to load any file of a multi-file version. Empty, and therefore omitted, for single-object rows, whose frame route resolves only the file's own name."
},
"frame_expires_in": {
"type": "integer",
"description": "Validity of `frame_url` and `frame_base` in seconds. Always `43200` (12 hours)."
},
"name": {
"type": "string",
"description": "File name including extension."
Expand All @@ -9501,6 +9515,8 @@
"download_url",
"preview_url",
"expires_in",
"frame_url",
"frame_expires_in",
"name",
"size",
"content_type"
Expand Down
16 changes: 16 additions & 0 deletions api-reference/safari.openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4495,6 +4495,8 @@
"download_url": "/safari/artifact/stream?mode=download&t=eyJmaWxlX2lkIjoicGZfU2RoRUE1ZmJaSkduSHp3ck5KTU1TQiJ9.c2lnbmF0dXJl",
"preview_url": "/safari/artifact/stream?mode=preview&t=eyJmaWxlX2lkIjoicGZfU2RoRUE1ZmJaSkduSHp3ck5KTU1TQiJ9.c2lnbmF0dXJl",
"expires_in": 300,
"frame_url": "/safari/artifact/f/eyJmaWxlX2lkIjoicGZfU2RoRUE1ZmJaSkduSHp3ck5KTU1TQiJ9.c2lnbmF0dXJl/checkout-latency-postmortem.html",
"frame_expires_in": 43200,
"name": "checkout-latency-postmortem.html",
"size": 18996,
"content_type": "text/html"
Expand Down Expand Up @@ -9483,6 +9485,18 @@
"type": "integer",
"description": "两个链接的有效期，单位秒。固定为 `300`。"
},
"frame_url": {
"type": "string",
"description": "沙箱 iframe 地址（`/safari/artifact/f/<token>/<file name>`），供内嵌预览加载该文件。路径中的 token 是它唯一的凭据，随 `frame_expires_in` 过期。"
},
"frame_base": {
"type": "string",
"description": "该产物版本的 frame 目录地址，以 `/` 结尾；在其后拼接文件相对路径即可加载多文件版本中的任意文件。单文件记录该值为空，因此被省略，其 frame 路由只解析该文件自身的名字。"
},
"frame_expires_in": {
"type": "integer",
"description": "`frame_url` 与 `frame_base` 的有效期，单位秒。固定为 `43200`（12 小时）。"
},
"name": {
"type": "string",
"description": "文件名（含扩展名）。"
Expand All @@ -9501,6 +9515,8 @@
"download_url",
"preview_url",
"expires_in",
"frame_url",
"frame_expires_in",
"name",
"size",
"content_type"
Expand Down
Loading