You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Full documentation: spec structure, required/recommended/optional fields, security model, implementation guide. Includes Threadbaire Server as reference implementation.
Copy file name to clipboardExpand all lines: README.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ A RundownAPI endpoint returns JSON with these fields:
36
36
37
37
| Field | What it is |
38
38
|-------|-----------|
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.|
40
40
|`base_url`| Where the API lives |
41
41
|`auth`| How to authenticate (method, parameter names, header format) |
42
42
|`purpose`| What this API does, in plain language. One or two sentences. |
**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.
321
321
322
+
### Reference implementation
323
+
324
+
Threadbaire Server includes a working `/api/rundown` endpoint: [github.com/threadbaire/server](https://github.com/threadbaire/server)
325
+
322
326
## License
323
327
324
328
CC BY-SA 4.0 — Use it, adapt it, build on it. Keep it open and credit the source.
0 commit comments