Skip to content

Commit fb2f2f4

Browse files
Steffen Fagerström Christensenclaude
andcommitted
docs(quick-260521-a01): API spec update — new section check, player-id, webinar-design-id
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent fadb563 commit fb2f2f4

3 files changed

Lines changed: 113 additions & 1 deletion

File tree

.planning/STATE.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ See: .planning/PROJECT.md (updated 2026-04-23)
2828
Phase: 24 — COMPLETE
2929
Plan: 1/1 complete
3030
Status: Milestone v1.5 complete — all phases done
31-
Last activity: 2026-05-13 - Completed quick task 260513-a06: Review command documentation and make sure commands listed in the root README reflect available commands
31+
Last activity: 2026-05-21 - Completed quick task 260521-a01: Review updated API spec and add new options/features to CLI and skill
3232

3333
Progress: [██████████] 100%
3434

@@ -122,6 +122,7 @@ None — v1.5 milestone complete.
122122
| 260508-dnq | Release v1.3.3: docs, skill update, version bump, and tags | 2026-05-08 | 7d682c2 | [260508-dnq-release-v1-3-3-docs-skill-update-version](./quick/260508-dnq-release-v1-3-3-docs-skill-update-version/) |
123123
| 260513-aab | Add seo get/status/update commands, update SKILL.md, release v1.3.4 | 2026-05-13 | 1038e93 | [260513-aab-api-spec-update-seo-commands-release-v1-3-4](./quick/260513-aab-api-spec-update-seo-commands-release-v1-3-4/) |
124124
| 260513-a06 | Review command documentation and make sure commands listed in the root README reflect available commands | 2026-05-13 | 35e4eda | [260513-a06-readme-commands-sync](./quick/260513-a06-readme-commands-sync/) |
125+
| 260521-a01 | Review updated API spec and add new options/features to CLI and skill | 2026-05-21 | fadb563 | [260521-a01-api-spec-review-add-new-options](./quick/260521-a01-api-spec-review-add-new-options/) |
125126

126127
## Session Continuity
127128

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
quick_id: 260521-a01
3+
slug: api-spec-review-add-new-options
4+
description: Review updated API spec and add new options/features to CLI and skill
5+
date: 2026-05-21
6+
status: in-progress
7+
---
8+
9+
# Quick Task 260521-a01: API Spec Update — New Options and Features
10+
11+
## Summary of Changes
12+
13+
Diff between latest live API spec and committed spec reveals:
14+
15+
1. **NEW ENDPOINT**: `POST /photo/section/check-generate-available` — checks if AI chapter generation is available for a video
16+
2. **NEW PARAM**: `player_id` (integer) on `POST /app/add` — "Add a contextual player being forked"
17+
3. **NEW PARAM**: `webinar_design_id` (integer) on `POST /live/create`, `POST /live/update`, `POST /live/repeat` — "Assign a webinar design by id to this webinar"
18+
19+
## Tasks
20+
21+
### Task 1: Update spec file and regenerate types
22+
23+
- **files**: `packages/twentythree-cli/specs/twentythree-api-swagger.json`, `packages/twentythree-cli/src/api/types.ts`
24+
- **action**: Copy downloaded spec and regenerate types via `pnpm generate-types`
25+
- **verify**: Types file updated with new endpoint + parameters
26+
- **done**: [ ]
27+
28+
### Task 2: Add `player-id` flag to `app add`
29+
30+
- **files**: `packages/twentythree-cli/src/commands/app/add.ts`
31+
- **action**: Add optional `--player-id` integer flag mapping to `player_id` body param
32+
- **verify**: Flag present, sent in body when provided
33+
- **done**: [ ]
34+
35+
### Task 3: Add `webinar-design-id` to webinar create/update/repeat
36+
37+
- **files**:
38+
- `packages/twentythree-cli/src/commands/webinar/create.ts`
39+
- `packages/twentythree-cli/src/commands/webinar/update.ts`
40+
- `packages/twentythree-cli/src/commands/webinar/repeat.ts`
41+
- **action**: Add optional `--webinar-design-id` integer flag to each; send as `webinar_design_id` in body (flag mode only for update)
42+
- **verify**: Flag present in each command, correctly mapped in body
43+
- **done**: [ ]
44+
45+
### Task 4: Add `video section check-generate-available` command
46+
47+
- **files**: `packages/twentythree-cli/src/commands/video/section/check-generate-available.ts`
48+
- **action**: Create new command that POSTs to `/photo/section/check-generate-available` with `photo_id` (required) and optional `fields`; outputs `section_generation_available_p` boolean
49+
- **verify**: Command file created, manifest updated after build
50+
- **done**: [ ]
51+
52+
### Task 5: Update skill documentation
53+
54+
- **files**:
55+
- `packages/twentythree-skills/.cursor/skills/twentythree/reference/video.md`
56+
- `packages/twentythree-skills/.cursor/skills/twentythree/reference/webinar.md`
57+
- **action**:
58+
- Add `video section check-generate-available` command section after `video section generate`
59+
- Add `--webinar-design-id` flag to webinar create, update, and repeat sections
60+
- **verify**: Both files updated with accurate documentation
61+
- **done**: [ ]
62+
63+
### Task 6: TypeScript check
64+
65+
- **files**: N/A
66+
- **action**: Run `pnpm --filter twentythree-cli exec tsc --noEmit` to confirm no new type errors
67+
- **verify**: Clean compile (ignoring pre-existing errors)
68+
- **done**: [ ]
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
quick_id: 260521-a01
3+
slug: api-spec-review-add-new-options
4+
status: complete
5+
date: 2026-05-21
6+
---
7+
8+
# Quick Task 260521-a01: API Spec Update Summary
9+
10+
## What changed
11+
12+
Downloaded latest TwentyThree API spec and compared against committed version. Four sets of changes found and implemented.
13+
14+
## Changes made
15+
16+
### New endpoint: `video section check-generate-available`
17+
- New command file: `src/commands/video/section/check-generate-available.ts`
18+
- POSTs to `/photo/section/check-generate-available`
19+
- Accepts video ID (positional) + optional `--fields`
20+
- Outputs whether AI chapter generation is available (`section_generation_available_p`)
21+
- Useful as a pre-check before calling `video section generate`
22+
23+
### New flag: `--player-id` on `app add`
24+
- Adds optional `--player-id` integer flag to `src/commands/app/add.ts`
25+
- Maps to `player_id` body param: "Add a contextual player being forked"
26+
27+
### New flag: `--webinar-design-id` on webinar create/update/repeat
28+
- Added to `src/commands/webinar/create.ts`, `update.ts`, `repeat.ts`
29+
- Maps to `webinar_design_id` body param: "Assign a webinar design by id to this webinar"
30+
- In `update.ts`: flag mode only (consistent with `--seo-policy` pattern)
31+
32+
### Spec + types regenerated
33+
- Updated `specs/twentythree-api-swagger.json` to latest live spec
34+
- Regenerated `src/api/types.ts` via `pnpm generate-types`
35+
- Manifest regenerated via `pnpm build` (oclif manifest runs postbuild)
36+
37+
### Skill documentation updated
38+
- `reference/video.md`: Added `video section check-generate-available` section after `video section generate`
39+
- `reference/webinar.md`: Added `--webinar-design-id` row to create, update, and repeat flag tables
40+
41+
## Verification
42+
- TypeScript: clean compile (`tsc --noEmit` no errors)
43+
- Tests: 167 passed, 0 failed

0 commit comments

Comments
 (0)