Files
accounted/skills/openapi-to-skill/scripts/openapi-inventory.d.mts
T
Jakob Wennberg 11b82cbb91 feat(api): installable accounted-api agent skill + openapi-to-skill generator (#1516)
* feat(api): installable accounted-api agent skill + openapi-to-skill generator

Three layers, per the July/August 2026 agent-skills ecosystem (skills.sh /
npx skills add, as used by Stripe/Cloudflare/Supabase for their APIs):

- skills/openapi-to-skill/: generic, installable skill that turns any
  OpenAPI spec into a consumer-side integration skill, with a portable
  stdlib-only inventory/condenser tool and an output template + quality
  checklist encoding the distill-not-restate methodology.
- skills/accounted-api/: the installable skill for our own API, rendered
  deterministically by scripts/api-skill/generate.ts from the v1 endpoint
  registry + hand-authored overlays (auth, conventions, domain gotchas).
  CI gate: npm run apiskill:check (core-build.yml).
- lib/api/v1/registry.ts: generateOpenApiSpec now emits requestBody (incl.
  multipart binary parts) and path parameters, and the Zod converter learned
  .default()/z.record()/.pipe()/.transform(), so the public spec carries
  request contracts instead of prose-only.

Docs: /docs/api landing + /llms.txt now point agents at the skill install;
corrected the stale test-key description in the landing (test keys read
real data and force dry-run writes; they are not sandbox-company bound).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(skills): escape backslashes in markdown table cells (CodeQL js/incomplete-sanitization)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Jakob Wennberg <311770904+jakobwennberg-oss@users.noreply.github.com>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-08-11 12:45:19 +02:00

46 lines
1.2 KiB
TypeScript

/** Type surface of openapi-inventory.mjs for TypeScript consumers. */
export interface OperationObjectLite {
operationId?: string
summary?: string
description?: string
tags?: string[]
deprecated?: boolean
parameters?: unknown[]
requestBody?: unknown
responses?: Record<string, unknown>
[extension: string]: unknown
}
export interface OperationEntry {
path: string
method: string
op: OperationObjectLite
pathItem: Record<string, unknown>
segments: string[]
depth: number
group: string
}
export interface Inventory {
title: string
version: string
description: string
servers: string[]
securitySchemes: Record<string, unknown>
operationCount: number
groups: Array<{ name: string; operations: OperationEntry[] }>
}
export function loadSpec(specPath: string): unknown
export function resolveRef(spec: unknown, ref: string): unknown
export function condenseSchema(
spec: unknown,
schema: unknown,
opts?: { depth?: number; seen?: Set<string> },
): string
export function listOperations(spec: unknown): OperationEntry[]
export function buildInventory(spec: unknown): Inventory
export function formatOpLine(entry: OperationEntry): string
export function renderOperationMd(spec: unknown, entry: OperationEntry): string