Skip to content

docs: rename the README to Nomba OpenAPI Spec, add banner and agent-skills sections #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samaxbytez merged 2 commits into from
Nov 4, 2026
Merged

docs: rename the README to Nomba OpenAPI Spec, add banner and agent-skills sections #4

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2908023
docs: rename the README to Nomba OpenAPI Spec and add banner and agen…
samaxbytez Nov 4, 2026
820b3dd
Merge branch 'main' into docs/readme-name-banner
samaxbytez Nov 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# openapi
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/NombaOSS/openapi/main/.github/assets/banner-dark.svg">
<img alt="Nomba OpenAPI Spec" src="https://raw.githubusercontent.com/NombaOSS/openapi/main/.github/assets/banner-light.svg" width="100%">
</picture>

# Nomba OpenAPI Spec

[![CI](https://github.com/NombaOSS/openapi/actions/workflows/ci.yml/badge.svg)](https://github.com/NombaOSS/openapi/actions/workflows/ci.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
Expand Down Expand Up @@ -32,6 +37,16 @@ Render it as a single HTML page:
npm ci && npm run docs # writes dist/index.html
```

## Building with an AI coding agent?

Install the [Nomba agent skills](https://github.com/NombaOSS/skills) so Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI and other agents write Nomba integrations the safe way: idempotency references, requery on timeouts, refunds only when final, and webhook verification.

```bash
npx skills add NombaOSS/skills
```

In Claude Code you can also use `/plugin marketplace add NombaOSS/skills` and then `/plugin install nomba@nomba`.

## Where it comes from

The source of truth is the API reference at [developer.nomba.com](https://developer.nomba.com/nomba-api-reference/introduction). Each reference page embeds the OpenAPI definition for its endpoint; `npm run sync` fetches every page, merges them, and splits the result into `openapi/` (one file per path and per schema).
Expand Down
Loading