📦

w-api-docs

Name: w-api-docs
Author: blockmatic

Revisão do conteúdo r1 Seguro ⚙️ Comandos externos

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.

Suporta: Claude Codex Code(CC)

🥉 77 Bronze

Instalar com meu Agente

Copie esta solicitação para o seu Agente. Ela inclui a página canônica do Skill e o manifesto.

Solicitação do agente

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.

Seu Agente ainda deve apresentar o plano e solicitar qualquer confirmação exigida pela política de segurança.

Recursos legíveis por agentes

Use estes links quando um agente de IA, crawler ou script precisar de contexto limpo em vez de ler a página completa.

Detalhe em Markdown GET /skills/blockmatic-w-api-docs.md manifest assinado GET /api/skills/blockmatic-w-api-docs/manifest lockfile assinado GET /api/skills/blockmatic-w-api-docs/lockfile

Testar

Usando "w-api-docs". An endpoint response changed and the generated API reference is outdated.

Resultado esperado:

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.

Usando "w-api-docs". A contributor proposes editing the generated OpenAPI file directly.

Resultado esperado:

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

Auditoria de segurança

Seguro

v1 • 20/09/2026 Abrir o relatório versionado

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.

Arquivos analisados

Linhas analisadas

Itens de revisão

Falsos positivos ignorados

Fatores de risco

⚙️ Comandos externos (1)

SKILL.md:13

A auditoria estática e semântica concluída mais recente não detectou achados de segurança confirmados. Isso não comprova que a skill não tenha efeitos colaterais.

Auditado por: codex

Compartilhar e citar este relatório

Compartilhe o relatório de avaliação versionado, o badge neutro, o cartão incorporável e as citações. A Skillstore apresenta evidências sem decidir se este Skill é seguro.

Abrir o relatório versionado

Copiar link do relatório

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

Badge 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)

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>

Cartão incorporável

<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>

Citações acadêmicas (APA · BibTeX · CFF)

Citação 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

Citação 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"

Pontuação do Skillstore

Por que esta pontuação Confiança das evidências: Médio

Arquitetura

Manutenibilidade

Conteúdo

Comunidade

Conformidade com a especificação

O que você pode criar

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.

Teste estes prompts

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.

Boas práticas

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.

Evitar

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.

Perguntas frequentes

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.

Detalhes do desenvolvedor

Autor

blockmatic

Licença

MIT

Revisão da Skillstore

Aviso de versão

O autor não declarou uma versão.

Repositório

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

Referência

da80e8e31e67c66709203bc863d62c9424451362

Atualidade da manutenção

20/09/2026

Uso

0 downloads · 0 visualizações

Estrutura de arquivos

📄 SKILL.md