Skip to content

QuickstartProof v1.0.0 — static cURL/OpenAPI consistency checks

Marketplace
Marketplace

Choose a tag to compare

View all tags
@jacobw26 jacobw26 released this 04 Sep 10:03
v1.0.0
a21ebbf

QuickstartProof v1.0.0 introduces a read-only, dependency-free GitHub Action that compares copy-paste cURL examples in one Markdown or MDX quickstart with one same-repository OpenAPI 3.0–3.2 document.

Highlights

  • Checks HTTP method, path, server, parameters, required fields, and supported literal JSON examples.
  • Produces source-linked annotations, a compact job summary, and bounded JSON output.
  • Returns one honest state: aligned-on-static-checks, changes-found, or insufficient-public-input.
  • Uses Node.js 24 with no runtime dependencies.

Safety boundary

QuickstartProof never executes cURL or repository code, calls the documented API, reads secrets, installs packages, or uploads source content. Ambiguous or unsupported evidence fails closed as insufficient-public-input. An aligned result is not certification of runtime correctness, security, availability, or compliance.

Verification

  • 29/29 Action tests passed in GitHub Actions.
  • 12/12 synthetic fixture repositories produced their exact expected states.
  • The committed bundle is 55,294 bytes.
  • Bundle SHA-256: 76EF7559527A3AE7CED573CBA12E0EC61DC20EA422C09E0189785668B35095AD
  • Release commit: a21ebbf

Security-conscious consumers can pin the full release commit: a21ebbf

Assets 2
Loading