Skip to content

chore: 重新同步公开契约;homepage 指向 s1.dev (v0.2.1) - #2

Merged
fatwang2 merged 1 commit into
mainfrom
chore/resync-contract-and-urls
Aug 19, 2026
Merged

fatwang2 merged 1 commit into
mainfrom
chore/resync-contract-and-urls

Conversation

@fatwang2

Copy link
Copy Markdown
Member

vendored 的 openapi 快照已落后 canonical 一个版本,而 src/generated.ts 正是从这份快照生成的 —— 也就是说客户端类型是按一份过期契约生成的。

端点 canonical 本仓库快照
POST /search 无 404 仍声明 404
POST /news 无 404 仍声明 404
POST /screenshot 有 403 缺 403
POST /crawl、/screenshot requestBody 更深层也有差异

同步后重跑 npm run generate 重建类型(src/generated.ts 56+/32-)。

新快照同时带上了每个 operation 的 description —— 上游刚补的选型指引(什么时候该用这个端点、和兄弟端点怎么配合、成本多少),所以生成的类型注释里也能读到。

homepage

此前指向 www.search1api.com/docs/integrations/sdks,该域名已于 2026-08 迁走,靠 301 才活着。改为产品域名 https://s1.dev —— 这是包管理器和 agent 确认「官方 SDK」而非同名第三方包的依据。

版本

0.2.0 → 0.2.1(X-Search1API-Client 头同步),package-lock.json 已同步。typecheck 与 9 项测试通过。

⚠️ 合并顺序

需等 fatwang2/search1api#171 合并、gateway 自动部署之后再打 v0.2.1 tag,否则 vendored 快照会领先线上契约。

相关

fatwang2/search1api#171 · search1api-cli#8 · search1api-mcp#28 · search1api-python

🤖 Generated with Claude Code

vendored 的 openapi 快照已落后 canonical 一个版本,而 src/generated.ts 正是
从这份快照生成的 —— 也就是说客户端类型是按一份过期契约生成的:

- POST /search、/news 仍声明了 canonical 已移除的 404
- POST /screenshot 缺少 canonical 新增的 403
- /crawl、/screenshot 的 requestBody 也有更深层差异

同步后重跑 npm run generate 重建类型。新快照同时带上了每个 operation 的
description(上游刚补的选型指引),所以生成的类型注释里也能读到。

homepage 此前指向 www.search1api.com/docs/integrations/sdks —— 域名已于
2026-08 迁走,靠 301 才活着;改为产品域名 https://s1.dev,这也是包管理器和
agent 确认「官方 SDK」的依据。

0.2.0 → 0.2.1(X-Search1API-Client 头同步)。typecheck 与 9 项测试通过。

⚠️ 需等 gateway 部署后再打 tag,否则 vendored 快照会领先线上契约。

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@fatwang2
fatwang2 merged commit acec6eb into main Aug 19, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant