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.
Installer avec mon Agent
Copiez cette demande dans votre Agent. Elle contient la page Skill de référence et le manifeste.
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.Votre Agent doit toujours présenter son plan et demander toute confirmation exigée par la politique de sécurité.
Ressources lisibles par les agents
Utilisez ces liens lorsqu’un Agent IA, un crawler ou un script a besoin d’un contexte propre au lieu de lire toute la page.
Tester
Utilisation de « w-api-docs ». An endpoint response changed and the generated API reference is outdated.
RĂ©sultat attendu:
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.
Utilisation de « w-api-docs ». A contributor proposes editing the generated OpenAPI file directly.
RĂ©sultat attendu:
Redirect the change to the owning schema or route. Regenerate the OpenAPI artifact using the documented workflow, then review the generated diff.
Audit de sécurité
SûrThe 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.
Facteurs de risque
⚙️ Commandes externes (1)
Partager et citer ce rapport
Partagez le rapport d’évaluation versionné, le badge neutre, la carte intégrable et les citations. Skillstore présente les preuves sans décider si ce Skill est sûr.
Copier le lien du rapport
https://skillstore.io/skills/blockmatic-w-api-docs/audits/1?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportBadge Markdown
[](https://skillstore.io/skills/blockmatic-w-api-docs?utm_source=security_passport_badge)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>Carte intégrable
<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>Citations académiques (APA · BibTeX · CFF)
Citation 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/1Citation 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"
Score Skillstore
Pourquoi ce score Niveau de confiance des preuves: MoyenCe que vous pouvez créer
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.
Essayez ces prompts
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.
Bonnes pratiques
- 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.
Éviter
- 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.
Foire aux questions
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?
Détails du développeur
Auteur
blockmaticLicence
MIT
RĂ©vision Skillstore
r1
Avis de version
L’auteur n’a déclaré aucune version.
RĂ©f
da80e8e31e67c66709203bc863d62c9424451362
RĂ©cence de maintenance
20/09/2026
Utilisation
0 téléchargements · 0 vues
Structure de fichiers
đź“„ SKILL.md