Skip to content

Commit bff0365

Browse files
RundownAPI v0.1 spec complete
Full documentation: spec structure, required/recommended/optional fields, security model, implementation guide. Includes Threadbaire Server as reference implementation.
1 parent 8ba06db commit bff0365

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ A RundownAPI endpoint returns JSON with these fields:
3636

3737
| Field | What it is |
3838
|-------|-----------|
39-
| `rundown_version` | Version of the spec (currently `"0.1"`) |
39+
| `rundown_version` | Version of the spec (currently `"0.1"`). This refers to the spec version, not your API's version. If your API has its own versioning, add it as an optional field. |
4040
| `base_url` | Where the API lives |
4141
| `auth` | How to authenticate (method, parameter names, header format) |
4242
| `purpose` | What this API does, in plain language. One or two sentences. |
@@ -319,6 +319,10 @@ const base_url = `${protocol}://${host}`;
319319

320320
**Test it with an AI.** Give Claude or ChatGPT the URL and ask it to integrate. Watch what works and what confuses it. Update your `ai_instructions` based on what you see.
321321

322+
### Reference implementation
323+
324+
Threadbaire Server includes a working `/api/rundown` endpoint: [github.com/threadbaire/server](https://github.com/threadbaire/server)
325+
322326
## License
323327

324328
CC BY-SA 4.0 — Use it, adapt it, build on it. Keep it open and credit the source.

0 commit comments

Comments
 (0)