Skip to content

Commit 730bbc0

Browse files
committed
docs(readme): remove JSON for automation section
1 parent adfcc65 commit 730bbc0

File tree

1 file changed

+0
-38
lines changed

1 file changed

+0
-38
lines changed

README.md

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -253,44 +253,6 @@ Each delta operation contains complete requirement blocks that will be merged in
253253
- diff: Show unified diff between a change’s deltas and current specs.
254254
- archive: Apply deltas to specs and move the change to `openspec/changes/archive/`. Supports `--skip-specs`.
255255

256-
## JSON for Automation
257-
258-
Specs:
259-
260-
```bash
261-
openspec show auth --json --no-scenarios
262-
```
263-
264-
Outputs shape:
265-
266-
```json
267-
{
268-
"id": "auth",
269-
"title": "Auth Specification",
270-
"overview": "...",
271-
"requirementCount": 1,
272-
"requirements": [{ "text": "...", "scenarios": [] }],
273-
"metadata": { "version": "1.0.0", "format": "openspec" }
274-
}
275-
```
276-
277-
Changes:
278-
279-
```bash
280-
openspec show add-2fa --json --deltas-only
281-
```
282-
283-
Outputs shape:
284-
285-
```json
286-
{
287-
"id": "add-2fa",
288-
"title": "Add 2FA",
289-
"deltaCount": 1,
290-
"deltas": [{ "spec": "auth", "operation": "ADDED", "name": "Two-Factor Authentication", "raw": "..." }]
291-
}
292-
```
293-
294256
## AI Integration
295257

296258
OpenSpec is built for AI-driven development. Your AI assistant creates and manages all specs and changes.

0 commit comments

Comments
 (0)