技能 w-api-docs

📦

w-api-docs

Name: w-api-docs
Author: blockmatic

內容修訂 r1 安全 ⚙️ 外部命令

Refresh API Docs from Source Schemas

API documentation can drift from the schemas and routes that define actual behavior. This skill guides updates from the owning source and keeps generated artifacts out of manual edits.

支援: Claude Codex Code(CC)

🥉 77 銅級

Maintain this Skill? Claim it 🥉 77 銅級

使用我的智慧代理安裝

將此請求複製給你的智慧代理，其中包含權威 Skill 頁面和清單。

智能體請求

Review the Skillstore skill "w-api-docs" from https://skillstore.io/skills/blockmatic-w-api-docs.md and its manifest at https://skillstore.io/api/skills/blockmatic-w-api-docs/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

你的智慧代理仍應顯示其計畫，並依安全政策請求必要確認。

Agent 可讀資源

當 AI Agent、爬蟲或腳本需要乾淨脈絡、而不是讀取完整頁面時，請使用這些連結。

Markdown 詳情 GET /skills/blockmatic-w-api-docs.md 已簽名 manifest GET /api/skills/blockmatic-w-api-docs/manifest 已簽名 lockfile GET /api/skills/blockmatic-w-api-docs/lockfile

測試它

正在使用「w-api-docs」。 An endpoint response changed and the generated API reference is outdated.

預期結果:

The response schema or route is the likely source of truth. Update that source, run the repository generator, check for drift, and revise adopter documentation only when behavior changed.

正在使用「w-api-docs」。 A contributor proposes editing the generated OpenAPI file directly.

預期結果:

Redirect the change to the owning schema or route. Regenerate the OpenAPI artifact using the documented workflow, then review the generated diff.

安全審計

安全

v1 • 2026/9/20 開啟版本化報告

The only static finding is a false positive. The referenced text is a Markdown command reference, not Ruby or shell execution, and no prompt injection or data-exfiltration intent is evident.

已掃描檔案

分析行數

複核項目

已忽略的誤報

風險因素

⚙️ 外部命令 (1)

SKILL.md:13

最近一次完成的靜態與語意稽核未偵測到已確認的安全發現。這並不能證明該 Skill 沒有副作用。

審計單位: codex

分享與引用此報告

分享版本化評估報告、中性徽章、嵌入卡片與引用。Skillstore 只報告證據，不判斷該 Skill 是否安全。

開啟版本化報告

複製報告連結

https://skillstore.io/skills/blockmatic-w-api-docs/audits/1?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown 徽章

[![Skillstore security assessment](https://skillstore.io/badges/skills/blockmatic-w-api-docs/security.svg)](https://skillstore.io/skills/blockmatic-w-api-docs?utm_source=security_passport_badge)

HTML 徽章

<a href="https://skillstore.io/skills/blockmatic-w-api-docs?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/blockmatic-w-api-docs/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

嵌入卡片

<iframe src="https://skillstore.io/embed/skills/blockmatic-w-api-docs.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>

學術引用 (APA · BibTeX · CFF)

APA 引用

blockmatic. (2026). w-api-docs security audit report (audit version 1) [Author version unspecified]. Skillstore. https://skillstore.io/skills/blockmatic-w-api-docs/audits/1

BibTeX 引用

@techreport{blockmatic-blockmatic-w-api-docs-2026,
  author = {blockmatic},
  title = {w-api-docs security audit report (audit version 1)},
  institution = {Skillstore},
  year = {2026},
  number = {1},
  url = {https://skillstore.io/skills/blockmatic-w-api-docs/audits/1},
  note = {Author version unspecified}
}

CITATION.cff

cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "w-api-docs security audit report (audit version 1)"
version: "unspecified"
type: report
authors:
  - name: "blockmatic"
date-released: "2026-09-20"
url: "https://skillstore.io/skills/blockmatic-w-api-docs/audits/1"
identifiers:
  - type: other
    value: "skillstore:blockmatic-w-api-docs:audit:1"
    description: "Skillstore immutable audit report identifier"

Skillstore 評分

評分依據證據置信度: 中

架構

可維護性

內容

社群

規範符合度

你可以打造什麼

Maintain OpenAPI References

Use the workflow to trace an endpoint change to its owning schema, regenerate the documentation, and check for drift.

Review Documentation Changes

Use the workflow to confirm that API docs describe implemented behavior without hand-editing generated files.

Coordinate Schema Updates

Use the workflow to plan source changes, generated documentation updates, and adopter MDX changes in one review.

試試這些提示

Find the Source of Truth

Trace this API documentation change to its owning schema, route, or documented generator. List the files and the evidence for each relationship.

Plan a Documentation Refresh

Review the requested API behavior change and produce a concise update plan. Separate source changes, generation steps, drift checks, and adopter documentation.

Validate Generated Docs

Inspect the repository workflow for generating API documentation. Identify the documented command, expected outputs, and available drift checks, then report any missing evidence.

Audit a Cross-Layer Change

Analyze this API change across schemas, routes, generated documentation, and adopter MDX. Recommend only source-owned edits and flag undocumented policy assumptions.

最佳實務

Trace every documentation change to an owning schema, route, or documented generator.
Run the repository generation and drift checks after changing API behavior.
Document only verified behavior and clearly separate evidence from assumptions.

避免

Do not hand-edit generated OpenAPI files or generated clients.
Do not invent authentication, rate-limit, or versioning policy.
Do not update adopter documentation when the API behavior has not changed.

常見問題

What problem does this skill solve?

It helps keep API documentation aligned with the schemas and routes that define actual behavior.

Should I edit generated OpenAPI files directly?

No. Change the owning schema or route, then use the repository generator.

What sources can own an API change?

The owning source may be a TypeBox schema, a Fastify route, or another documented repository source.

Does this skill run the generator?

It provides the workflow and decision guidance. The surrounding agent or developer must run repository commands.

Does it define authentication or rate limits?

No. It explicitly avoids inventing policies that the repository does not document.

When should adopter MDX change?

Update adopter MDX only when the API behavior changed and the existing guidance is affected.

開發者詳細資訊

作者

blockmatic

授權

MIT

Skillstore 修訂

版本提示

作者未聲明版本。

儲存庫

https://github.com/blockmatic/basilic-skills/tree/5fa16493413923e31f1df31f7260224f0f291d9e/skills/w-api-docs

引用

da80e8e31e67c66709203bc863d62c9424451362

維護新鮮度

2026/9/20

使用量

0 次下載 · 0 次瀏覽

檔案結構

📄 SKILL.md