File size: 22,701 Bytes
311fa35
 
 
49489bc
311fa35
 
 
 
 
 
 
 
b093efe
311fa35
 
 
 
 
 
 
 
 
 
 
 
 
 
 
f554a33
 
 
 
 
311fa35
b093efe
 
 
 
 
 
 
 
 
 
 
 
311fa35
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
60e647e
 
 
 
 
 
311fa35
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
b093efe
 
 
311fa35
 
 
 
 
 
 
b093efe
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
311fa35
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
b093efe
311fa35
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
b093efe
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
311fa35
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
import { CALLBACK_EVENTS } from "./callbacks.js";
import { VERSION } from "./version.js";

export const OPENAPI_TITLE = "Pitlane API";
export const OPENAPI_VERSION = "1.0.0";

const jobSchema = {
  type: "object",
  description:
    "Job metadata persisted in meta.json. Provider API keys and webhook secrets are never included.",
  properties: {
    id: { type: "string" },
    kind: { type: "string", enum: ["video", "clip"] },
    topic: { type: "string" },
    archetype: { type: "string" },
    pacing: { type: "string" },
    platform: { type: "string" },
    status: {
      type: "string",
      enum: ["queued", "running", "completed", "failed", "cancelled", "unknown"],
    },
    createdAt: { type: "string", format: "date-time" },
    completedAt: { type: "string", format: "date-time" },
    noAiAssets: { type: "boolean" },
    retryOf: { type: "string", description: "Original job id when created via /retry." },
    metadata: { type: "object", additionalProperties: true },
    stages: { type: "object", additionalProperties: true },
    videoPath: { type: "string", nullable: true },
    posterPath: {
      type: "string",
      nullable: true,
      description: "Still frame of the finished short.",
    },
    runDir: { type: "string", nullable: true },
    source: {
      type: "object",
      nullable: true,
      additionalProperties: true,
      description: "Clip jobs: the downloaded source and the window that was fetched.",
    },
    clips: {
      type: "array",
      nullable: true,
      description: "Clip jobs: every vertical clip that was cut.",
      items: { type: "object", additionalProperties: true },
    },
    score: { type: "object", additionalProperties: true },
    costEstimate: { type: "object", additionalProperties: true },
    actualCost: { type: "object", additionalProperties: true },
    error: { type: "string" },
    links: { $ref: "#/components/schemas/JobLinks" },
  },
  required: ["id", "topic", "status", "createdAt", "stages"],
} as const;

const createJobSchema = {
  type: "object",
  required: ["topic"],
  properties: {
    topic: { type: "string", maxLength: 500 },
    archetype: { type: "string" },
    pacing: { type: "string" },
    platform: { type: "string", default: "youtube" },
    dryRun: { type: "boolean", default: false },
    noMusic: { type: "boolean", default: false },
    noVideo: { type: "boolean", default: false },
    noAiAssets: {
      type: "boolean",
      default: false,
      description:
        "Disable AI image and AI video generation. Scenes use stock media when available and procedural text cards otherwise.",
    },
    direction: { type: "string", description: "Creative direction text (max 10 KB UTF-8)." },
    score: {
      type: "object",
      additionalProperties: true,
      description: "A previously saved DirectorScore to replay instead of generating a new one.",
    },
    metadata: {
      type: "object",
      additionalProperties: true,
      description: "Caller-defined metadata stored with the job (max 8 KB JSON).",
    },
    idempotencyKey: {
      type: "string",
      maxLength: 255,
      description: "Alternative to the Idempotency-Key header.",
    },
    callbackUrl: {
      type: "string",
      format: "uri",
      description: "HTTPS endpoint that receives signed job lifecycle webhooks.",
    },
    callbackSecret: {
      type: "string",
      maxLength: 512,
      description: "HMAC-SHA256 signing secret. Never stored in meta.json.",
    },
    callbackEvents: {
      type: "array",
      items: { type: "string", enum: [...CALLBACK_EVENTS] },
    },
    callback: {
      type: "object",
      properties: {
        url: { type: "string", format: "uri" },
        secret: { type: "string" },
        events: { type: "array", items: { type: "string", enum: [...CALLBACK_EVENTS] } },
      },
      required: ["url"],
    },
    providers: {
      type: "object",
      properties: {
        llm: { type: "string" },
        tts: { type: "string" },
        image: { type: "string" },
        stock: { type: "string" },
        video: { type: "string" },
        videoModel: { type: "string" },
        music: { type: "string" },
        llmModel: { type: "string" },
        llmFallbackModels: {
          type: "array",
          items: { type: "string" },
          maxItems: 5,
          description: "Ordered backup model IDs tried when the primary model fails.",
        },
        llmBaseUrl: { type: "string", format: "uri" },
        llmAuthType: { type: "string", enum: ["auto", "none", "bearer", "custom-header"] },
        llmAuthHeader: { type: "string" },
        searchProvider: { type: "string" },
      },
    },
    keys: {
      type: "object",
      additionalProperties: { type: "string" },
      description:
        "Bring-your-own-key credentials for this job. Sent to the worker through Redis and never written to meta.json.",
    },
  },
} as const;

const errorSchema = {
  type: "object",
  properties: { error: { type: "string" } },
  required: ["error"],
} as const;

const jobLinksSchema = {
  type: "object",
  properties: {
    self: { type: "string" },
    events: { type: "string" },
    artifacts: { type: "string" },
    video: { type: "string", nullable: true },
    poster: { type: "string", nullable: true },
    clips: { type: "array", nullable: true, items: { type: "string" } },
    clipsIndex: { type: "string", nullable: true },
    score: { type: "string" },
    log: { type: "string" },
    cancel: { type: "string", nullable: true },
    retry: { type: "string", nullable: true },
  },
} as const;

const createClipSchema = {
  type: "object",
  required: ["sourceUrl"],
  properties: {
    sourceUrl: {
      type: "string",
      format: "uri",
      description:
        "Any yt-dlp-supported source: YouTube, Twitch, Kick, X, TikTok, or a direct video URL.",
    },
    count: { type: "integer", minimum: 1, maximum: 10, default: 3 },
    minSeconds: { type: "number", minimum: 5, maximum: 120, default: 20 },
    maxSeconds: { type: "number", minimum: 10, maximum: 180, default: 60 },
    fit: {
      type: "string",
      enum: ["blur", "crop"],
      default: "blur",
      description: "How a landscape source is shaped to 9:16. Blur keeps the whole frame.",
    },
    captions: {
      type: "boolean",
      default: true,
      description: "Burn word-timed captions. Turn off when the source already has them.",
    },
    hook: { type: "boolean", default: true, description: "Burn the clip's hook line for 3s." },
    title: { type: "string", maxLength: 120 },
    startSeconds: { type: "number", minimum: 0 },
    endSeconds: { type: "number", minimum: 0 },
    liveFromStart: {
      type: "boolean",
      default: false,
      description: "For a live stream, read from the start of the broadcast instead of from now.",
    },
    maxSourceMinutes: {
      type: "number",
      minimum: 1,
      maximum: 240,
      default: 60,
      description: "Hard cap on downloaded source length.",
    },
    providers: { type: "object", additionalProperties: true },
    keys: { type: "object", additionalProperties: { type: "string" } },
    metadata: { type: "object", additionalProperties: true },
    idempotencyKey: { type: "string", maxLength: 255 },
  },
} as const;

const standardErrors = {
  "400": { $ref: "#/components/responses/BadRequest" },
  "401": { $ref: "#/components/responses/Unauthorized" },
  "404": { $ref: "#/components/responses/NotFound" },
  "409": { $ref: "#/components/responses/Conflict" },
} as const;

const jobIdParameter = {
  name: "id",
  in: "path",
  required: true,
  schema: { type: "string" },
} as const;

export interface OpenApiOptions {
  serverUrl?: string;
  apiKeyRequired?: boolean;
}

/**
 * Build the OpenAPI 3.1 description of the REST API. Kept as a pure function so
 * it can be tested and served without touching Redis or the filesystem.
 */
export function buildOpenApiDocument(options: OpenApiOptions = {}): Record<string, unknown> {
  return {
    openapi: "3.1.0",
    info: {
      title: OPENAPI_TITLE,
      version: OPENAPI_VERSION,
      description:
        "Create and manage OpenReels video generation jobs, stream progress, download artifacts, and receive signed webhooks.",
      license: { name: "MIT" },
    },
    servers: [{ url: options.serverUrl ?? "/", description: "This OpenReels server" }],
    tags: [
      { name: "System" },
      { name: "Catalog" },
      { name: "Jobs" },
      { name: "Artifacts" },
      { name: "Realtime" },
    ],
    components: {
      securitySchemes: {
        bearerAuth: { type: "http", scheme: "bearer" },
        apiKeyAuth: { type: "apiKey", in: "header", name: "X-API-Key" },
        queryApiKey: {
          type: "apiKey",
          in: "query",
          name: "api_key",
          description: "Only for EventSource/media URLs that cannot set headers.",
        },
      },
      schemas: {
        Job: jobSchema,
        JobLinks: jobLinksSchema,
        CreateJobRequest: createJobSchema,
        CreateClipRequest: createClipSchema,
        Error: errorSchema,
      },
      responses: {
        BadRequest: {
          description: "Invalid request",
          content: { "application/json": { schema: { $ref: "#/components/schemas/Error" } } },
        },
        Unauthorized: {
          description: "Missing or invalid API key",
          content: { "application/json": { schema: { $ref: "#/components/schemas/Error" } } },
        },
        NotFound: {
          description: "Resource not found",
          content: { "application/json": { schema: { $ref: "#/components/schemas/Error" } } },
        },
        Conflict: {
          description: "Job state does not allow the operation",
          content: { "application/json": { schema: { $ref: "#/components/schemas/Error" } } },
        },
      },
    },
    ...(options.apiKeyRequired ? { security: [{ bearerAuth: [] }, { apiKeyAuth: [] }] } : {}),
    paths: {
      "/api/v1/health": {
        get: {
          tags: ["System"],
          summary: "Health check",
          security: [],
          responses: {
            "200": {
              description: "Server health, Redis connectivity, configured key names, and version.",
            },
          },
        },
      },
      "/api/v1/openapi.json": {
        get: {
          tags: ["System"],
          summary: "OpenAPI document",
          security: [],
          responses: { "200": { description: "This document" } },
        },
      },
      "/api/v1/docs": {
        get: {
          tags: ["System"],
          summary: "Interactive API documentation",
          security: [],
          responses: { "200": { description: "HTML documentation page" } },
        },
      },
      "/api/v1/capabilities": {
        get: {
          tags: ["System"],
          summary: "Server capabilities and limits",
          responses: { "200": { description: "Feature flags, provider catalog, and limits" } },
        },
      },
      "/api/v1/stats": {
        get: {
          tags: ["System"],
          summary: "Aggregate job statistics",
          responses: { "200": { description: "Job counts and total cost" } },
        },
      },
      "/api/v1/archetypes": {
        get: {
          tags: ["Catalog"],
          summary: "List archetypes",
          responses: { "200": { description: "Available visual archetypes" } },
        },
      },
      "/api/v1/platforms": {
        get: {
          tags: ["Catalog"],
          summary: "List platforms",
          responses: { "200": { description: "Supported output platforms" } },
        },
      },
      "/api/v1/providers": {
        get: {
          tags: ["Catalog"],
          summary: "List provider keys",
          responses: { "200": { description: "Supported provider keys and labels" } },
        },
      },
      "/api/v1/jobs": {
        get: {
          tags: ["Jobs"],
          summary: "List jobs",
          parameters: [
            { name: "status", in: "query", schema: { type: "string" } },
            { name: "archetype", in: "query", schema: { type: "string" } },
            { name: "platform", in: "query", schema: { type: "string" } },
            { name: "q", in: "query", schema: { type: "string" } },
            { name: "since", in: "query", schema: { type: "string", format: "date-time" } },
            { name: "until", in: "query", schema: { type: "string", format: "date-time" } },
            {
              name: "sort",
              in: "query",
              schema: { type: "string", enum: ["newest", "oldest"] },
            },
            { name: "limit", in: "query", schema: { type: "integer", minimum: 1, maximum: 100 } },
            { name: "offset", in: "query", schema: { type: "integer", minimum: 0 } },
          ],
          responses: {
            "200": {
              description: "Paginated jobs",
              content: {
                "application/json": {
                  schema: {
                    type: "object",
                    properties: {
                      jobs: { type: "array", items: { $ref: "#/components/schemas/Job" } },
                      total: { type: "integer" },
                      limit: { type: "integer" },
                      offset: { type: "integer" },
                      hasMore: { type: "boolean" },
                    },
                  },
                },
              },
            },
          },
        },
        post: {
          tags: ["Jobs"],
          summary: "Create a job",
          parameters: [
            {
              name: "Idempotency-Key",
              in: "header",
              schema: { type: "string", maxLength: 255 },
              description: "Replay-safe job creation.",
            },
          ],
          requestBody: {
            required: true,
            content: {
              "application/json": { schema: { $ref: "#/components/schemas/CreateJobRequest" } },
            },
          },
          responses: {
            "201": {
              description: "Job queued",
              content: {
                "application/json": { schema: { $ref: "#/components/schemas/Job" } },
              },
            },
            "200": {
              description:
                "Existing job returned for a replayed Idempotency-Key (Idempotency-Replayed: true)",
              content: {
                "application/json": { schema: { $ref: "#/components/schemas/Job" } },
              },
            },
            ...standardErrors,
          },
        },
      },
      "/api/v1/clips": {
        post: {
          tags: ["Clips"],
          summary: "Cut vertical clips from a video or stream",
          description:
            "Downloads the source, transcribes it, chooses self-contained moments, and renders each one at 1080x1920 with burned captions. Returns a normal job, so progress, cancel, retry and artifacts use the same endpoints.",
          parameters: [
            {
              name: "Idempotency-Key",
              in: "header",
              schema: { type: "string", maxLength: 255 },
            },
          ],
          requestBody: {
            required: true,
            content: {
              "application/json": { schema: { $ref: "#/components/schemas/CreateClipRequest" } },
            },
          },
          responses: {
            "201": {
              description: "Clip job queued",
              content: {
                "application/json": { schema: { $ref: "#/components/schemas/Job" } },
              },
            },
            "200": {
              description: "Existing job returned for a replayed Idempotency-Key",
              content: {
                "application/json": { schema: { $ref: "#/components/schemas/Job" } },
              },
            },
            ...standardErrors,
          },
        },
      },
      "/api/v1/jobs/batch": {
        post: {
          tags: ["Jobs"],
          summary: "Create up to 25 jobs in one request",
          requestBody: {
            required: true,
            content: {
              "application/json": {
                schema: {
                  type: "object",
                  properties: {
                    jobs: {
                      type: "array",
                      maxItems: 25,
                      items: { $ref: "#/components/schemas/CreateJobRequest" },
                    },
                  },
                  required: ["jobs"],
                },
              },
            },
          },
          responses: {
            "201": {
              description: "Created jobs and per-item errors",
              content: {
                "application/json": {
                  schema: {
                    type: "object",
                    properties: {
                      jobs: { type: "array", items: { $ref: "#/components/schemas/Job" } },
                      errors: {
                        type: "array",
                        items: {
                          type: "object",
                          properties: {
                            index: { type: "integer" },
                            error: { type: "string" },
                          },
                        },
                      },
                    },
                  },
                },
              },
            },
            ...standardErrors,
          },
        },
      },
      "/api/v1/jobs/{id}": {
        get: {
          tags: ["Jobs"],
          summary: "Get a job",
          parameters: [jobIdParameter],
          responses: {
            "200": {
              description: "Job metadata and links",
              content: {
                "application/json": { schema: { $ref: "#/components/schemas/Job" } },
              },
            },
            ...standardErrors,
          },
        },
        delete: {
          tags: ["Jobs"],
          summary: "Delete a finished job and its artifacts",
          parameters: [jobIdParameter],
          responses: {
            "200": { description: "Job deleted" },
            ...standardErrors,
          },
        },
      },
      "/api/v1/jobs/{id}/cancel": {
        post: {
          tags: ["Jobs"],
          summary: "Cancel a queued or running job",
          parameters: [jobIdParameter],
          responses: {
            "200": { description: "Cancellation requested" },
            ...standardErrors,
          },
        },
      },
      "/api/v1/jobs/{id}/retry": {
        post: {
          tags: ["Jobs"],
          summary: "Re-run a finished job as a new job",
          parameters: [jobIdParameter],
          responses: {
            "201": {
              description: "New job queued",
              content: {
                "application/json": { schema: { $ref: "#/components/schemas/Job" } },
              },
            },
            ...standardErrors,
          },
        },
      },
      "/api/v1/jobs/{id}/events": {
        get: {
          tags: ["Realtime"],
          summary: "Stream job progress with Server-Sent Events",
          description:
            "Emits job:snapshot, stage:<name>, job:completed, job:failed, and job:cancelled events. Use ?api_key= when the EventSource API cannot set headers.",
          parameters: [jobIdParameter],
          responses: { "200": { description: "text/event-stream" } },
        },
      },
      "/api/v1/jobs/{id}/artifacts": {
        get: {
          tags: ["Artifacts"],
          summary: "List job artifacts",
          parameters: [jobIdParameter],
          responses: {
            "200": {
              description: "Files with sizes, timestamps, content types, and download URLs",
              content: {
                "application/json": {
                  schema: {
                    type: "object",
                    properties: {
                      jobId: { type: "string" },
                      artifacts: {
                        type: "array",
                        items: {
                          type: "object",
                          properties: {
                            path: { type: "string" },
                            size: { type: "integer" },
                            modifiedAt: { type: "string", format: "date-time" },
                            contentType: { type: "string" },
                            url: { type: "string" },
                          },
                        },
                      },
                    },
                  },
                },
              },
            },
            ...standardErrors,
          },
        },
      },
      "/api/v1/jobs/{id}/artifacts/{path}": {
        get: {
          tags: ["Artifacts"],
          summary: "Download an artifact",
          parameters: [
            jobIdParameter,
            { name: "path", in: "path", required: true, schema: { type: "string" } },
          ],
          responses: {
            "200": { description: "File contents" },
            "403": { description: "Path traversal or symlink rejected" },
            ...standardErrors,
          },
        },
      },
      "/api/v1/jobs/{id}/video": {
        get: {
          tags: ["Artifacts"],
          summary: "Download the rendered video",
          parameters: [jobIdParameter],
          responses: { "200": { description: "MP4 video" }, ...standardErrors },
        },
      },
      "/api/v1/jobs/{id}/score": {
        get: {
          tags: ["Artifacts"],
          summary: "Get the DirectorScore",
          parameters: [jobIdParameter],
          responses: {
            "200": { description: "DirectorScore JSON" },
            ...standardErrors,
          },
        },
      },
      "/api/v1/jobs/{id}/log": {
        get: {
          tags: ["Artifacts"],
          summary: "Get the run log",
          parameters: [jobIdParameter],
          responses: {
            "200": { description: "Run log JSON" },
            ...standardErrors,
          },
        },
      },
    },
  };
}

/** Small HTML shell that renders the OpenAPI document with Redoc. */
export function renderDocsHtml(): string {
  return `<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>${OPENAPI_TITLE}</title>
    <style>body { margin: 0; padding: 0; }</style>
  </head>
  <body>
    <redoc spec-url="/api/v1/openapi.json"></redoc>
    <script src="https://cdn.redoc.ly/redoc/latest/bundled/redoc.standalone.js"></script>
  </body>
</html>`;
}

/** Version reported by health and capabilities endpoints. */
export const API_VERSION = VERSION;