BondForge OpenAPI

Authoritative OpenAPI 3.1 specification for the BondForge API.

• Spec: openapi/bondforge.yaml
• Current spec version: 1.0.0

What this repo is for

This repo exists to keep the API contract versioned, reviewable, and close to engineering workflows:

• API-first change review (diffs on the spec)
• Validation & linting in CI
• A single source-of-truth for client SDK / server stubs generation

Quick start

1) Install tooling

This repo uses Node-based tools for validation & docs.

npm install

2) Validate the spec

npm run validate
npm run lint

3) Preview API docs locally

npm run docs

This will start a local docs server powered by Redocly.

Generating client SDKs (examples)

These commands are intentionally opt-in (no generated code committed by default).

You can generate SDKs using openapi-generator:

npm run gen:php
npm run gen:python
npm run gen:csharp
npm run gen:ts

Generated output will land in generated/ (gitignored by default).

Repo conventions

• Contract changes require review. Treat openapi/bondforge.yaml like production code.
• Prefer backward-compatible changes where possible.
• When making breaking changes, bump the info.version and document it in CHANGELOG.md.

Support

If you’re inside the BondForge org: open an issue in this repo and tag api.