w-api-docs

Name: w-api-docs
Author: blockmatic

Refresh API docs from the owning schema source; never edit generated OpenAPI by hand.

by blockmatic(0) 0 installs

Free

Free account. Installing gives you the manifest plus copy-paste snippets.

See reviews

About

Imported from blockmatic/basilic-skills (skills/w-api-docs/SKILL.md) via skills.sh. Install upstream with npx skills add blockmatic/basilic-skills --skill w-api-docs. Copyright stays with the author.

Update API documentation from the source of truth (TypeBox/Fastify routes, or the repo's documented generator). Never edit generated OpenAPI, generated clients, or generated SQL directly.

Read the API docs MDX and the generator README. Identify the owning source and the generate script in package.json.
Change the owning schema or route, not the generated artifact.
Run the documented generate command. Check drift scripts if the repo has them.
Update adopter MDX only for behavior that changed. Do not invent auth, rate-limit, or versioning policy.
Docs: /w-docs if behavior or commands changed.

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

# after Install: the listing is in your workspace's routing pool - a plan picks it for its slot
curl -s -X POST https://api.opensmartroute.ai/api/v1/route -H 'Authorization: Bearer $OSR_API_KEY' -H 'Content-Type: application/json' -d '{"text": "...", "plan": true}'

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

blockmatic-basilic-skills-w-api-docs.ocm.jsonjson

{
  "ocm": "1",
  "id": "blockmatic-basilic-skills-w-api-docs",
  "kind": "skill",
  "name": "w-api-docs",
  "description": "Refresh API docs from the owning schema source; never edit generated OpenAPI by hand.",
  "publisher": "blockmatic",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "coding"
    ],
    "tags": [
      "skill-md",
      "skills-sh"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Refresh API docs from the owning schema source; never edit generated OpenAPI by hand."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "skills.sh",
      "repository": "https://github.com/blockmatic/basilic-skills",
      "path": "skills/w-api-docs/SKILL.md",
      "ref": "HEAD",
      "url": "https://www.skills.sh/blockmatic/basilic-skills/w-api-docs",
      "key": "blockmatic/basilic-skills/skills/w-api-docs/SKILL.md"
    }
  },
  "instructions": "Update API documentation from the source of truth (TypeBox/Fastify routes, or the repo's documented generator). Never edit generated OpenAPI, generated clients, or generated SQL directly.\n\n1. Read the API docs MDX and the generator README. Identify the owning source and the generate script in package.json.\n2. Change the owning schema or route, not the generated artifact.\n3. Run the documented generate command. Check drift scripts if the repo has them.\n4. Update adopter MDX only for behavior that changed. Do not invent auth, rate-limit, or versioning policy.\n5. Docs: `/w-docs` if behavior or co",
  "cost": {
    "context_tokens": 153
  }
}

Fetch it by URL: GET /api/v1/registry/blockmatic-basilic-skills-w-api-docs/manifest?version=1.0.0

About

Use it

Manifest

Reviews