w-api-docs
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.
自分のエージェントでインストール
このリクエストをエージェントにコピーしてください。正規の 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.エージェントは引き続き計画を提示し、セキュリティポリシーで必要な確認を求める必要があります。
エージェントが読めるリソース
AI エージェント、クローラー、スクリプトがページ全体ではなく整理されたコンテキストを必要とする場合は、これらのリンクを使ってください。
テストする
「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.
セキュリティ監査
安全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)
このレポートを共有・引用
バージョン付き評価レポート、中立的なバッジ、埋め込みカード、引用を共有できます。Skillstore は証拠を報告しますが、この Skill が安全かどうかは判断しません。
レポートリンクをコピー
https://skillstore.io/skills/blockmatic-w-api-docs/audits/1?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdownバッジ
[](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/1BibTeX形式の引用
@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.
これらのプロンプトを試す
Trace this API documentation change to its owning schema, route, or documented generator. List the files and the evidence for each relationship.
Review the requested API behavior change and produce a concise update plan. Separate source changes, generation steps, drift checks, and adopter documentation.
Inspect the repository workflow for generating API documentation. Identify the documented command, expected outputs, and available drift checks, then report any missing evidence.
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?
Should I edit generated OpenAPI files directly?
What sources can own an API change?
Does this skill run the generator?
Does it define authentication or rate limits?
When should adopter MDX change?
開発者情報
作成者
blockmaticライセンス
MIT
Skillstore リビジョン
r1
バージョンに関する注意
作者はバージョンを宣言していません。
参照
da80e8e31e67c66709203bc863d62c9424451362
メンテナンスの新しさ
2026/9/20
利用状況
0 ダウンロード · 0 閲覧
ファイル構成
📄 SKILL.md