@roborean/api-types 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -11,7 +11,7 @@
11
11
  "health"
12
12
  ],
13
13
  "summary": "Health",
14
- "description": "Return liveness and engine version.",
14
+ "description": "Return liveness and engine version.\n\nReturns:\n Mapping with ``status`` and ``engineVersion`` keys.",
15
15
  "operationId": "health_health_get",
16
16
  "responses": {
17
17
  "200": {
@@ -37,7 +37,7 @@
37
37
  "projects"
38
38
  ],
39
39
  "summary": "List Projects",
40
- "description": "List project summaries.",
40
+ "description": "List project summaries.\n\nArgs:\n state: Shared repositories and run service.\n _principal: Resolved caller identity (auth stub).\n\nReturns:\n Summary rows for each stored project.",
41
41
  "operationId": "list_projects_v1_projects_get",
42
42
  "responses": {
43
43
  "200": {
@@ -61,7 +61,7 @@
61
61
  "projects"
62
62
  ],
63
63
  "summary": "Create Project",
64
- "description": "Create a stored project.",
64
+ "description": "Create a stored project.\n\nArgs:\n body: Create request containing the project document.\n state: Shared repositories and run service.\n _principal: Resolved caller identity (auth stub).\n\nReturns:\n Redacted project detail for the created project.",
65
65
  "operationId": "create_project_v1_projects_post",
66
66
  "requestBody": {
67
67
  "content": {
@@ -103,7 +103,7 @@
103
103
  "projects"
104
104
  ],
105
105
  "summary": "Get Project",
106
- "description": "Fetch one project.",
106
+ "description": "Fetch one project.\n\nArgs:\n project_id: Identifier of the project to load.\n state: Shared repositories and run service.\n _principal: Resolved caller identity (auth stub).\n\nReturns:\n Redacted project detail for the requested project.",
107
107
  "operationId": "get_project_v1_projects__project_id__get",
108
108
  "parameters": [
109
109
  {
@@ -144,7 +144,7 @@
144
144
  "projects"
145
145
  ],
146
146
  "summary": "Update Project",
147
- "description": "Replace a project.",
147
+ "description": "Replace a project.\n\nArgs:\n project_id: Identifier from the URL path.\n body: Update request containing the replacement project.\n state: Shared repositories and run service.\n _principal: Resolved caller identity (auth stub).\n\nReturns:\n Redacted project detail for the updated project.\n\nRaises:\n ApiError: When the body project id does not match the URL.",
148
148
  "operationId": "update_project_v1_projects__project_id__put",
149
149
  "parameters": [
150
150
  {
@@ -195,7 +195,7 @@
195
195
  "projects"
196
196
  ],
197
197
  "summary": "Delete Project",
198
- "description": "Delete a project.",
198
+ "description": "Delete a project.\n\nArgs:\n project_id: Identifier of the project to delete.\n state: Shared repositories and run service.\n _principal: Resolved caller identity (auth stub).\n\nReturns:\n Empty response with HTTP 204 status.",
199
199
  "operationId": "delete_project_v1_projects__project_id__delete",
200
200
  "parameters": [
201
201
  {
@@ -225,13 +225,168 @@
225
225
  }
226
226
  }
227
227
  },
228
+ "/v1/projects/{project_id}/templates/{template_id}/content": {
229
+ "get": {
230
+ "tags": [
231
+ "projects"
232
+ ],
233
+ "summary": "Get Template Content",
234
+ "description": "Fetch one template file for a stored project.\n\nArgs:\n project_id: Identifier of the project to load.\n template_id: Template identifier from the project table.\n state: Shared repositories and run service.\n _principal: Resolved caller identity (auth stub).\n\nReturns:\n Template file bytes and optional UTF-8 text body.",
235
+ "operationId": "get_template_content_v1_projects__project_id__templates__template_id__content_get",
236
+ "parameters": [
237
+ {
238
+ "name": "project_id",
239
+ "in": "path",
240
+ "required": true,
241
+ "schema": {
242
+ "type": "string",
243
+ "title": "Project Id"
244
+ }
245
+ },
246
+ {
247
+ "name": "template_id",
248
+ "in": "path",
249
+ "required": true,
250
+ "schema": {
251
+ "type": "string",
252
+ "title": "Template Id"
253
+ }
254
+ }
255
+ ],
256
+ "responses": {
257
+ "200": {
258
+ "description": "Successful Response",
259
+ "content": {
260
+ "application/json": {
261
+ "schema": {
262
+ "$ref": "#/components/schemas/TemplateContentResponse"
263
+ }
264
+ }
265
+ }
266
+ },
267
+ "422": {
268
+ "description": "Validation Error",
269
+ "content": {
270
+ "application/json": {
271
+ "schema": {
272
+ "$ref": "#/components/schemas/HTTPValidationError"
273
+ }
274
+ }
275
+ }
276
+ }
277
+ }
278
+ },
279
+ "put": {
280
+ "tags": [
281
+ "projects"
282
+ ],
283
+ "summary": "Put Template Content",
284
+ "description": "Replace one template file for a stored project.\n\nArgs:\n project_id: Identifier of the project to update.\n template_id: Template identifier from the project table.\n body: Template bytes or UTF-8 text to persist.\n state: Shared repositories and run service.\n _principal: Resolved caller identity (auth stub).\n\nReturns:\n Stored template file metadata.",
285
+ "operationId": "put_template_content_v1_projects__project_id__templates__template_id__content_put",
286
+ "parameters": [
287
+ {
288
+ "name": "project_id",
289
+ "in": "path",
290
+ "required": true,
291
+ "schema": {
292
+ "type": "string",
293
+ "title": "Project Id"
294
+ }
295
+ },
296
+ {
297
+ "name": "template_id",
298
+ "in": "path",
299
+ "required": true,
300
+ "schema": {
301
+ "type": "string",
302
+ "title": "Template Id"
303
+ }
304
+ }
305
+ ],
306
+ "requestBody": {
307
+ "required": true,
308
+ "content": {
309
+ "application/json": {
310
+ "schema": {
311
+ "$ref": "#/components/schemas/TemplateContentUpdate"
312
+ }
313
+ }
314
+ }
315
+ },
316
+ "responses": {
317
+ "200": {
318
+ "description": "Successful Response",
319
+ "content": {
320
+ "application/json": {
321
+ "schema": {
322
+ "$ref": "#/components/schemas/TemplateContentResponse"
323
+ }
324
+ }
325
+ }
326
+ },
327
+ "422": {
328
+ "description": "Validation Error",
329
+ "content": {
330
+ "application/json": {
331
+ "schema": {
332
+ "$ref": "#/components/schemas/HTTPValidationError"
333
+ }
334
+ }
335
+ }
336
+ }
337
+ }
338
+ },
339
+ "delete": {
340
+ "tags": [
341
+ "projects"
342
+ ],
343
+ "summary": "Delete Template Content",
344
+ "description": "Delete one template file from project storage.\n\nArgs:\n project_id: Identifier of the project to update.\n template_id: Template identifier from the project table.\n state: Shared repositories and run service.\n _principal: Resolved caller identity (auth stub).\n\nReturns:\n Empty response with HTTP 204 status.",
345
+ "operationId": "delete_template_content_v1_projects__project_id__templates__template_id__content_delete",
346
+ "parameters": [
347
+ {
348
+ "name": "project_id",
349
+ "in": "path",
350
+ "required": true,
351
+ "schema": {
352
+ "type": "string",
353
+ "title": "Project Id"
354
+ }
355
+ },
356
+ {
357
+ "name": "template_id",
358
+ "in": "path",
359
+ "required": true,
360
+ "schema": {
361
+ "type": "string",
362
+ "title": "Template Id"
363
+ }
364
+ }
365
+ ],
366
+ "responses": {
367
+ "204": {
368
+ "description": "Successful Response"
369
+ },
370
+ "422": {
371
+ "description": "Validation Error",
372
+ "content": {
373
+ "application/json": {
374
+ "schema": {
375
+ "$ref": "#/components/schemas/HTTPValidationError"
376
+ }
377
+ }
378
+ }
379
+ }
380
+ }
381
+ }
382
+ },
228
383
  "/v1/projects/{project_id}/compile": {
229
384
  "post": {
230
385
  "tags": [
231
386
  "compile"
232
387
  ],
233
388
  "summary": "Compile Project",
234
- "description": "Compile a stored project.",
389
+ "description": "Compile a stored project.\n\nArgs:\n project_id: Identifier of the project to compile.\n body: Optional compile flags; defaults when omitted.\n state: Shared repositories and run service.\n registry: Bit type registry used by the compiler.\n _principal: Resolved caller identity (auth stub).\n\nReturns:\n Compiled project snapshot for the client.",
235
390
  "operationId": "compile_project_v1_projects__project_id__compile_post",
236
391
  "parameters": [
237
392
  {
@@ -291,7 +446,7 @@
291
446
  "runs"
292
447
  ],
293
448
  "summary": "Create Run",
294
- "description": "Execute a durable run.",
449
+ "description": "Execute a durable run.\n\nArgs:\n project_id: Project that owns the new run.\n body: Run create request with workspace overrides.\n state: Shared repositories and run service.\n _principal: Resolved caller identity (auth stub).\n idempotency_key: Required ``Idempotency-Key`` header value.\n\nReturns:\n Client-facing detail for the created or reused run.\n\nRaises:\n ApiError: When the idempotency header is missing.",
295
450
  "operationId": "create_run_v1_projects__project_id__runs_post",
296
451
  "parameters": [
297
452
  {
@@ -358,7 +513,7 @@
358
513
  "runs"
359
514
  ],
360
515
  "summary": "List Runs",
361
- "description": "List runs for a project.",
516
+ "description": "List runs for a project.\n\nArgs:\n project_id: Project whose runs should be listed.\n state: Shared repositories and run service.\n _principal: Resolved caller identity (auth stub).\n\nReturns:\n Summary rows for recent runs of the project.",
362
517
  "operationId": "list_runs_v1_projects__project_id__runs_get",
363
518
  "parameters": [
364
519
  {
@@ -405,7 +560,7 @@
405
560
  "runs"
406
561
  ],
407
562
  "summary": "Get Run",
408
- "description": "Fetch one run.",
563
+ "description": "Fetch one run.\n\nArgs:\n run_id: Identifier of the run to load.\n state: Shared repositories and run service.\n _principal: Resolved caller identity (auth stub).\n\nReturns:\n Client-facing run detail with redacted results.",
409
564
  "operationId": "get_run_v1_runs__run_id__get",
410
565
  "parameters": [
411
566
  {
@@ -448,7 +603,7 @@
448
603
  "artifacts"
449
604
  ],
450
605
  "summary": "Download Artifact",
451
- "description": "Stream one stored artifact (document id).",
606
+ "description": "Stream one stored artifact (document id).\n\nArgs:\n run_id: Durable run that owns the artifact.\n artifact_id: Document id used as the artifact key suffix.\n state: Shared repositories and run service.\n _principal: Resolved caller identity (auth stub).\n\nReturns:\n Raw artifact bytes with a best-effort media type.\n\nRaises:\n ApiError: When the artifact bytes are missing from storage.",
452
607
  "operationId": "download_artifact_v1_runs__run_id__artifacts__artifact_id__get",
453
608
  "parameters": [
454
609
  {
@@ -498,7 +653,7 @@
498
653
  "previews"
499
654
  ],
500
655
  "summary": "Preview Document",
501
- "description": "Return a browser-safe document preview.",
656
+ "description": "Return a browser-safe document preview.\n\nArgs:\n project_id: Identifier of the project to preview.\n body: Preview request with document id and overrides.\n state: Shared repositories and run service.\n _principal: Resolved caller identity (auth stub).\n\nReturns:\n Preview payload for the requested document.",
502
657
  "operationId": "preview_document_v1_projects__project_id__preview_post",
503
658
  "parameters": [
504
659
  {
@@ -544,45 +699,217 @@
544
699
  }
545
700
  }
546
701
  }
547
- }
548
- },
549
- "components": {
550
- "schemas": {
551
- "Bit": {
552
- "properties": {
553
- "id": {
554
- "type": "string",
555
- "title": "Id"
702
+ },
703
+ "/v1/template-library": {
704
+ "get": {
705
+ "tags": [
706
+ "template-library"
707
+ ],
708
+ "summary": "List Template Library",
709
+ "description": "List catalog entries with optional filters.\n\nArgs:\n kind: Optional entry kind filter.\n document_type: Optional document type filter.\n tag: Optional tag filter.\n _principal: Resolved caller identity (auth stub).\n\nReturns:\n Matching catalog summary rows.",
710
+ "operationId": "list_template_library_v1_template_library_get",
711
+ "parameters": [
712
+ {
713
+ "name": "kind",
714
+ "in": "query",
715
+ "required": false,
716
+ "schema": {
717
+ "anyOf": [
718
+ {
719
+ "type": "string"
720
+ },
721
+ {
722
+ "type": "null"
723
+ }
724
+ ],
725
+ "title": "Kind"
726
+ }
556
727
  },
557
- "type": {
558
- "type": "string",
559
- "title": "Type"
728
+ {
729
+ "name": "documentType",
730
+ "in": "query",
731
+ "required": false,
732
+ "schema": {
733
+ "anyOf": [
734
+ {
735
+ "type": "string"
736
+ },
737
+ {
738
+ "type": "null"
739
+ }
740
+ ],
741
+ "title": "Documenttype"
742
+ }
560
743
  },
561
- "label": {
562
- "anyOf": [
563
- {
564
- "type": "string"
565
- },
566
- {
567
- "type": "null"
744
+ {
745
+ "name": "tag",
746
+ "in": "query",
747
+ "required": false,
748
+ "schema": {
749
+ "anyOf": [
750
+ {
751
+ "type": "string"
752
+ },
753
+ {
754
+ "type": "null"
755
+ }
756
+ ],
757
+ "title": "Tag"
758
+ }
759
+ }
760
+ ],
761
+ "responses": {
762
+ "200": {
763
+ "description": "Successful Response",
764
+ "content": {
765
+ "application/json": {
766
+ "schema": {
767
+ "type": "array",
768
+ "items": {
769
+ "$ref": "#/components/schemas/TemplateLibraryEntry"
770
+ },
771
+ "title": "Response List Template Library V1 Template Library Get"
772
+ }
568
773
  }
569
- ],
570
- "title": "Label"
774
+ }
571
775
  },
572
- "when": {
573
- "anyOf": [
574
- {
575
- "type": "boolean",
576
- "const": true
577
- },
578
- {
579
- "$ref": "#/components/schemas/RuleAst"
776
+ "422": {
777
+ "description": "Validation Error",
778
+ "content": {
779
+ "application/json": {
780
+ "schema": {
781
+ "$ref": "#/components/schemas/HTTPValidationError"
782
+ }
580
783
  }
581
- ],
582
- "title": "When"
784
+ }
785
+ }
786
+ }
787
+ }
788
+ },
789
+ "/v1/template-library/{entry_id}": {
790
+ "get": {
791
+ "tags": [
792
+ "template-library"
793
+ ],
794
+ "summary": "Get Template Library Entry",
795
+ "description": "Fetch one catalog entry with its payload body.\n\nArgs:\n entry_id: Catalog entry identifier.\n _principal: Resolved caller identity (auth stub).\n\nReturns:\n Entry summary plus manifest, project, or recipe payload.\n\nRaises:\n ApiError: When the entry id is unknown.",
796
+ "operationId": "get_template_library_entry_v1_template_library__entry_id__get",
797
+ "parameters": [
798
+ {
799
+ "name": "entry_id",
800
+ "in": "path",
801
+ "required": true,
802
+ "schema": {
803
+ "type": "string",
804
+ "title": "Entry Id"
805
+ }
806
+ }
807
+ ],
808
+ "responses": {
809
+ "200": {
810
+ "description": "Successful Response",
811
+ "content": {
812
+ "application/json": {
813
+ "schema": {
814
+ "$ref": "#/components/schemas/TemplateLibraryDetail"
815
+ }
816
+ }
817
+ }
583
818
  },
584
- "config": {
585
- "additionalProperties": true,
819
+ "422": {
820
+ "description": "Validation Error",
821
+ "content": {
822
+ "application/json": {
823
+ "schema": {
824
+ "$ref": "#/components/schemas/HTTPValidationError"
825
+ }
826
+ }
827
+ }
828
+ }
829
+ }
830
+ }
831
+ },
832
+ "/v1/template-library/{entry_id}/content": {
833
+ "get": {
834
+ "tags": [
835
+ "template-library"
836
+ ],
837
+ "summary": "Get Template Library Content",
838
+ "description": "Return template bytes for a document catalog entry.\n\nArgs:\n entry_id: Document catalog entry identifier.\n _principal: Resolved caller identity (auth stub).\n\nReturns:\n Base64-encoded template bytes plus a UTF-8 hint when applicable.\n\nRaises:\n ApiError: When the entry is missing or not a document template.",
839
+ "operationId": "get_template_library_content_v1_template_library__entry_id__content_get",
840
+ "parameters": [
841
+ {
842
+ "name": "entry_id",
843
+ "in": "path",
844
+ "required": true,
845
+ "schema": {
846
+ "type": "string",
847
+ "title": "Entry Id"
848
+ }
849
+ }
850
+ ],
851
+ "responses": {
852
+ "200": {
853
+ "description": "Successful Response",
854
+ "content": {
855
+ "application/json": {
856
+ "schema": {
857
+ "$ref": "#/components/schemas/TemplateContentResponse"
858
+ }
859
+ }
860
+ }
861
+ },
862
+ "422": {
863
+ "description": "Validation Error",
864
+ "content": {
865
+ "application/json": {
866
+ "schema": {
867
+ "$ref": "#/components/schemas/HTTPValidationError"
868
+ }
869
+ }
870
+ }
871
+ }
872
+ }
873
+ }
874
+ }
875
+ },
876
+ "components": {
877
+ "schemas": {
878
+ "Bit": {
879
+ "properties": {
880
+ "id": {
881
+ "type": "string",
882
+ "title": "Id"
883
+ },
884
+ "type": {
885
+ "type": "string",
886
+ "title": "Type"
887
+ },
888
+ "label": {
889
+ "anyOf": [
890
+ {
891
+ "type": "string"
892
+ },
893
+ {
894
+ "type": "null"
895
+ }
896
+ ],
897
+ "title": "Label"
898
+ },
899
+ "when": {
900
+ "anyOf": [
901
+ {
902
+ "type": "boolean",
903
+ "const": true
904
+ },
905
+ {
906
+ "$ref": "#/components/schemas/RuleAst"
907
+ }
908
+ ],
909
+ "title": "When"
910
+ },
911
+ "config": {
912
+ "additionalProperties": true,
586
913
  "type": "object",
587
914
  "title": "Config"
588
915
  },
@@ -636,7 +963,7 @@
636
963
  "capabilities"
637
964
  ],
638
965
  "title": "Bit",
639
- "description": "An ordered conditional unit of project work."
966
+ "description": "An ordered conditional unit of project work.\n\nAttributes:\n id: Unique identifier of the bit within the project.\n type: The bit type implementation to execute.\n label: Optional human-readable label for the bit.\n when: Activation condition; either always-true or a rule\n expression evaluated against the workspace.\n config: Bit-specific configuration payload.\n reads: Workspace keys the bit declares it reads.\n writes: Workspace keys the bit declares it writes.\n emits: Document operation kinds the bit declares it emits.\n effect_class: Effect classification (``effectClass`` alias) used\n for retry and idempotency handling.\n on_error: Behavior to apply on failure (``onError`` alias).\n capabilities: Capability identifiers required to run the bit."
640
967
  },
641
968
  "Bucket": {
642
969
  "properties": {
@@ -678,7 +1005,7 @@
678
1005
  "bucket"
679
1006
  ],
680
1007
  "title": "Bucket",
681
- "description": "A bucketed value with optional numeric bounds."
1008
+ "description": "A bucketed value with optional numeric bounds.\n\nAttributes:\n kind: Discriminator identifying this value as a bucket.\n bucket: Identifier of the bucket the value falls into.\n bounds: Optional inclusive lower and upper numeric bounds for\n the bucket."
682
1009
  },
683
1010
  "CompileRequest": {
684
1011
  "properties": {
@@ -691,7 +1018,7 @@
691
1018
  "additionalProperties": false,
692
1019
  "type": "object",
693
1020
  "title": "CompileRequest",
694
- "description": "Optional compile flags."
1021
+ "description": "Optional compile flags.\n\nAttributes:\n strict_undeclared_access: When true, reject undeclared bit reads\n and writes (``strictUndeclaredAccess``)."
695
1022
  },
696
1023
  "CompileResponse": {
697
1024
  "properties": {
@@ -707,7 +1034,7 @@
707
1034
  "compiled"
708
1035
  ],
709
1036
  "title": "CompileResponse",
710
- "description": "Compiled project snapshot."
1037
+ "description": "Compiled project snapshot.\n\nAttributes:\n compiled: JSON-serializable compiled project document."
711
1038
  },
712
1039
  "DiagnosticDto": {
713
1040
  "properties": {
@@ -748,7 +1075,7 @@
748
1075
  "message"
749
1076
  ],
750
1077
  "title": "DiagnosticDto",
751
- "description": "One compile or validation diagnostic."
1078
+ "description": "One compile or validation diagnostic.\n\nAttributes:\n severity: Diagnostic level (``error``, ``warning``, or ``info``).\n code: Stable machine-readable diagnostic code.\n message: Human-readable diagnostic text.\n path: Optional JSON-pointer-like location within the project."
752
1079
  },
753
1080
  "DocumentDefinition": {
754
1081
  "properties": {
@@ -756,6 +1083,21 @@
756
1083
  "type": "string",
757
1084
  "title": "Id"
758
1085
  },
1086
+ "title": {
1087
+ "type": "string",
1088
+ "title": "Title"
1089
+ },
1090
+ "description": {
1091
+ "anyOf": [
1092
+ {
1093
+ "type": "string"
1094
+ },
1095
+ {
1096
+ "type": "null"
1097
+ }
1098
+ ],
1099
+ "title": "Description"
1100
+ },
759
1101
  "type": {
760
1102
  "type": "string",
761
1103
  "enum": [
@@ -772,6 +1114,17 @@
772
1114
  "type": "string",
773
1115
  "title": "Templateref"
774
1116
  },
1117
+ "baseTemplateRef": {
1118
+ "anyOf": [
1119
+ {
1120
+ "type": "string"
1121
+ },
1122
+ {
1123
+ "type": "null"
1124
+ }
1125
+ ],
1126
+ "title": "Basetemplateref"
1127
+ },
775
1128
  "templateManifestRef": {
776
1129
  "anyOf": [
777
1130
  {
@@ -836,12 +1189,13 @@
836
1189
  "type": "object",
837
1190
  "required": [
838
1191
  "id",
1192
+ "title",
839
1193
  "type",
840
1194
  "templateRef",
841
1195
  "driver"
842
1196
  ],
843
1197
  "title": "DocumentDefinition",
844
- "description": "A deferred document output definition."
1198
+ "description": "A deferred document output definition.\n\nAttributes:\n id: Unique identifier of the document within the project.\n title: Human-readable document title shown in the editor.\n description: Optional multiline document description.\n type: Document family, one of ``text``, ``markdown``, ``xlsx``,\n ``docx``, ``image``, or ``dxf``.\n template_ref: Reference to the template used to render the\n document (``templateRef`` alias).\n base_template_ref: When set, ``template_ref`` is a document-local\n fork of this shared template id (``baseTemplateRef`` alias).\n template_manifest_ref: Optional reference to the template's\n manifest (``templateManifestRef`` alias).\n driver: Identifier of the document driver used to render the\n document.\n output_target: Optional workspace key or path describing where\n the rendered artifact should be written (``outputTarget``\n alias).\n ir_family: Optional intermediate-representation family produced\n by the driver (``irFamily`` alias): one of ``flow``,\n ``sheet``, ``drawing``, ``raster``, or ``plain``.\n settings: Driver-specific rendering settings.\n preview: Optional preview configuration for the document."
845
1199
  },
846
1200
  "DocumentPreviewSettings": {
847
1201
  "properties": {
@@ -867,7 +1221,7 @@
867
1221
  "enabled"
868
1222
  ],
869
1223
  "title": "DocumentPreviewSettings",
870
- "description": "Preview configuration for a document definition."
1224
+ "description": "Preview configuration for a document definition.\n\nAttributes:\n mode: The preview rendering mode, one of ``none``, ``text``,\n ``html``, or ``drawing-json``.\n enabled: Whether preview generation is enabled."
871
1225
  },
872
1226
  "EffectClass": {
873
1227
  "type": "string",
@@ -881,7 +1235,7 @@
881
1235
  "transactional-external"
882
1236
  ],
883
1237
  "title": "EffectClass",
884
- "description": "Classifies a bit's execution effects."
1238
+ "description": "Classifies a bit's execution effects.\n\nAttributes:\n PURE: No observable side effects.\n WORKSPACE: Mutates the workspace only.\n DOCUMENT: Emits document operations.\n FILESYSTEM: Reads or writes the local filesystem.\n NETWORK: Performs network I/O.\n EXTERNAL_PROCESS: Invokes an external process.\n TRANSACTIONAL_EXTERNAL: Calls an external system that supports\n transactional semantics."
885
1239
  },
886
1240
  "EqToken": {
887
1241
  "properties": {
@@ -913,7 +1267,7 @@
913
1267
  "token"
914
1268
  ],
915
1269
  "title": "EqToken",
916
- "description": "An equality-preserving opaque token."
1270
+ "description": "An equality-preserving opaque token.\n\nAttributes:\n kind: Discriminator identifying this value as an equality token.\n token: The opaque token value used for equality comparisons.\n domain: Optional domain that scopes the token's equality\n semantics."
917
1271
  },
918
1272
  "Exposure": {
919
1273
  "type": "string",
@@ -923,7 +1277,7 @@
923
1277
  "clientVisible"
924
1278
  ],
925
1279
  "title": "Exposure",
926
- "description": "Controls whether a workspace value can reach clients."
1280
+ "description": "Controls whether a workspace value can reach clients.\n\nAttributes:\n BACKEND_ONLY: The value never leaves the backend.\n REDACTED_TO_CLIENT: The value reaches the client only after\n redaction.\n CLIENT_VISIBLE: The value may be sent to the client as-is."
927
1281
  },
928
1282
  "HTTPValidationError": {
929
1283
  "properties": {
@@ -946,7 +1300,7 @@
946
1300
  "continue"
947
1301
  ],
948
1302
  "title": "OnError",
949
- "description": "Controls a run after a failed bit."
1303
+ "description": "Controls a run after a failed bit.\n\nAttributes:\n ABORT: Stop the run immediately.\n SKIP: Skip the failed bit and continue.\n CONTINUE: Continue the run despite the failure."
950
1304
  },
951
1305
  "PreviewRequest": {
952
1306
  "properties": {
@@ -966,7 +1320,7 @@
966
1320
  "documentId"
967
1321
  ],
968
1322
  "title": "PreviewRequest",
969
- "description": "Preview one document definition."
1323
+ "description": "Preview one document definition.\n\nAttributes:\n document_id: Document definition id to preview (``documentId``).\n workspace_overrides: Optional workspace values for the dry run\n (``workspaceOverrides``)."
970
1324
  },
971
1325
  "PreviewResponse": {
972
1326
  "properties": {
@@ -1004,7 +1358,7 @@
1004
1358
  "body"
1005
1359
  ],
1006
1360
  "title": "PreviewResponse",
1007
- "description": "Browser-safe preview payload."
1361
+ "description": "Browser-safe preview payload.\n\nAttributes:\n document_id: Document definition id that was previewed\n (``documentId``).\n kind: Preview body format returned to the client.\n body: Preview content (string or structured JSON).\n warnings: Non-fatal diagnostics from preview generation."
1008
1362
  },
1009
1363
  "Project": {
1010
1364
  "properties": {
@@ -1099,7 +1453,7 @@
1099
1453
  "metadata"
1100
1454
  ],
1101
1455
  "title": "Project",
1102
- "description": "A portable, versioned Roborean project."
1456
+ "description": "A portable, versioned Roborean project.\n\nAttributes:\n schema_version: Schema version the project conforms to\n (``schemaVersion`` alias): one of ``1.0.0`` or ``1.1.0``.\n id: Unique identifier of the project.\n name: Human-readable project name.\n description: Optional human-readable project description.\n plugin_requirements: Plugin dependency declarations\n (``pluginRequirements`` alias).\n workspace: Declared workspace variables, keyed by group name.\n bits: Ordered list of bits that make up the project.\n documents: Document definitions produced by the project.\n templates: Template references used by the project's documents.\n metadata: Free-form project metadata.\n variables: Declared workspace variables, read from the\n ``variables`` group of `workspace`."
1103
1457
  },
1104
1458
  "ProjectCreate": {
1105
1459
  "properties": {
@@ -1113,7 +1467,7 @@
1113
1467
  "project"
1114
1468
  ],
1115
1469
  "title": "ProjectCreate",
1116
- "description": "Create one stored project."
1470
+ "description": "Create one stored project.\n\nAttributes:\n project: Full project document to validate and persist."
1117
1471
  },
1118
1472
  "ProjectDetail": {
1119
1473
  "properties": {
@@ -1129,7 +1483,7 @@
1129
1483
  "project"
1130
1484
  ],
1131
1485
  "title": "ProjectDetail",
1132
- "description": "Redacted project payload."
1486
+ "description": "Redacted project payload.\n\nAttributes:\n project: JSON-serializable project with secrets redacted."
1133
1487
  },
1134
1488
  "ProjectSummary": {
1135
1489
  "properties": {
@@ -1154,7 +1508,7 @@
1154
1508
  "schemaVersion"
1155
1509
  ],
1156
1510
  "title": "ProjectSummary",
1157
- "description": "List row for projects."
1511
+ "description": "List row for projects.\n\nAttributes:\n id: Stable project identifier.\n name: Human-readable project name.\n schema_version: Project schema version (``schemaVersion``)."
1158
1512
  },
1159
1513
  "ProjectUpdate": {
1160
1514
  "properties": {
@@ -1168,7 +1522,7 @@
1168
1522
  "project"
1169
1523
  ],
1170
1524
  "title": "ProjectUpdate",
1171
- "description": "Replace a stored project."
1525
+ "description": "Replace a stored project.\n\nAttributes:\n project: Replacement project document (id must match the URL)."
1172
1526
  },
1173
1527
  "PublicLiteral": {
1174
1528
  "properties": {
@@ -1199,7 +1553,7 @@
1199
1553
  "value"
1200
1554
  ],
1201
1555
  "title": "PublicLiteral",
1202
- "description": "A public literal workspace value."
1556
+ "description": "A public literal workspace value.\n\nAttributes:\n kind: Discriminator identifying this value as a public literal.\n data_type: The literal's declared type (``dataType`` alias): one\n of ``string``, ``number``, ``boolean``, or ``date``.\n value: The literal value itself."
1203
1557
  },
1204
1558
  "Redacted": {
1205
1559
  "properties": {
@@ -1226,7 +1580,27 @@
1226
1580
  "reason"
1227
1581
  ],
1228
1582
  "title": "Redacted",
1229
- "description": "A value withheld by secret or policy rules."
1583
+ "description": "A value withheld by secret or policy rules.\n\nAttributes:\n kind: Discriminator identifying this value as redacted.\n reason: Why the value was withheld, one of ``secret``,\n ``policy``, ``consent``, or ``unknown``."
1584
+ },
1585
+ "RequiredBitTypeSummary": {
1586
+ "properties": {
1587
+ "typeId": {
1588
+ "type": "string",
1589
+ "title": "Typeid"
1590
+ },
1591
+ "name": {
1592
+ "type": "string",
1593
+ "title": "Name"
1594
+ }
1595
+ },
1596
+ "additionalProperties": false,
1597
+ "type": "object",
1598
+ "required": [
1599
+ "typeId",
1600
+ "name"
1601
+ ],
1602
+ "title": "RequiredBitTypeSummary",
1603
+ "description": "Required bit type row for recipe catalog entries.\n\nAttributes:\n type_id: Bit type identifier (``typeId`` alias).\n name: Human-readable bit type name."
1230
1604
  },
1231
1605
  "RuleAst": {
1232
1606
  "properties": {
@@ -1261,7 +1635,7 @@
1261
1635
  "args"
1262
1636
  ],
1263
1637
  "title": "RuleAst",
1264
- "description": "A recursive CEL-profile rule expression."
1638
+ "description": "A recursive CEL-profile rule expression.\n\nAttributes:\n op: The operator for this expression node, one of ``and``,\n ``or``, ``not``, ``eq``, ``ne``, ``lt``, ``le``, ``gt``,\n ``ge``, ``has``, ``const``, or ``var``.\n args: Operands for the operator, which may themselves be nested\n rule expressions or literal values."
1265
1639
  },
1266
1640
  "RunCreate": {
1267
1641
  "properties": {
@@ -1289,7 +1663,7 @@
1289
1663
  "additionalProperties": false,
1290
1664
  "type": "object",
1291
1665
  "title": "RunCreate",
1292
- "description": "Body for POST /runs."
1666
+ "description": "Body for POST /runs.\n\nAttributes:\n dry_run: When true, execute without durable side effects\n (``dryRun``).\n stop_on_bit_error: Stop the run after the first bit failure\n (``stopOnBitError``).\n workspace_overrides: Optional workspace values for the run\n (``workspaceOverrides``).\n strict_workspace_access: Enforce declared workspace access\n (``strictWorkspaceAccess``)."
1293
1667
  },
1294
1668
  "RunDetail": {
1295
1669
  "properties": {
@@ -1350,7 +1724,7 @@
1350
1724
  "status"
1351
1725
  ],
1352
1726
  "title": "RunDetail",
1353
- "description": "Redacted durable run."
1727
+ "description": "Redacted durable run.\n\nAttributes:\n run_id: Durable run identifier (``runId``).\n project_id: Owning project identifier (``projectId``).\n status: Current run status string.\n results: Redacted run results payload, when present.\n diff: Serialized workspace/document diff, when present.\n error: Serialized run error payload, when present."
1354
1728
  },
1355
1729
  "RunSummary": {
1356
1730
  "properties": {
@@ -1391,7 +1765,7 @@
1391
1765
  "createdAt"
1392
1766
  ],
1393
1767
  "title": "RunSummary",
1394
- "description": "Run list item."
1768
+ "description": "Run list item.\n\nAttributes:\n run_id: Durable run identifier (``runId``).\n project_id: Owning project identifier (``projectId``).\n status: Current run status string.\n created_at: ISO-8601 creation timestamp (``createdAt``).\n finished_at: ISO-8601 finish timestamp when complete\n (``finishedAt``)."
1395
1769
  },
1396
1770
  "SecretRefValue": {
1397
1771
  "properties": {
@@ -1423,7 +1797,7 @@
1423
1797
  "ref"
1424
1798
  ],
1425
1799
  "title": "SecretRefValue",
1426
- "description": "A reference to a secret held outside the portable project."
1800
+ "description": "A reference to a secret held outside the portable project.\n\nAttributes:\n kind: Discriminator identifying this value as a secret\n reference.\n ref: Opaque identifier used to resolve the secret at run time.\n display_hint: Optional human-readable hint (``displayHint``\n alias) shown in place of the secret value."
1427
1801
  },
1428
1802
  "ShapeToken": {
1429
1803
  "properties": {
@@ -1462,7 +1836,445 @@
1462
1836
  "shape"
1463
1837
  ],
1464
1838
  "title": "ShapeToken",
1465
- "description": "A value represented by its structural shape."
1839
+ "description": "A value represented by its structural shape.\n\nAttributes:\n kind: Discriminator identifying this value as a shape token.\n shape: The structural shape category, one of ``email``,\n ``phone``, ``iban``, ``uuid``, or ``code``.\n length: Optional length constraint for the underlying value."
1840
+ },
1841
+ "TemplateContentResponse": {
1842
+ "properties": {
1843
+ "templateId": {
1844
+ "type": "string",
1845
+ "title": "Templateid"
1846
+ },
1847
+ "path": {
1848
+ "type": "string",
1849
+ "title": "Path"
1850
+ },
1851
+ "contentBase64": {
1852
+ "type": "string",
1853
+ "title": "Contentbase64"
1854
+ },
1855
+ "text": {
1856
+ "anyOf": [
1857
+ {
1858
+ "type": "string"
1859
+ },
1860
+ {
1861
+ "type": "null"
1862
+ }
1863
+ ],
1864
+ "title": "Text"
1865
+ }
1866
+ },
1867
+ "additionalProperties": false,
1868
+ "type": "object",
1869
+ "required": [
1870
+ "templateId",
1871
+ "path",
1872
+ "contentBase64"
1873
+ ],
1874
+ "title": "TemplateContentResponse",
1875
+ "description": "Template file payload returned by the API.\n\nAttributes:\n template_id: Template identifier from the project table\n (``templateId`` alias).\n path: Relative package path for the template file.\n content_base64: Base64-encoded template bytes\n (``contentBase64`` alias).\n text: UTF-8 decoded body when the file is textual."
1876
+ },
1877
+ "TemplateContentUpdate": {
1878
+ "properties": {
1879
+ "text": {
1880
+ "anyOf": [
1881
+ {
1882
+ "type": "string"
1883
+ },
1884
+ {
1885
+ "type": "null"
1886
+ }
1887
+ ],
1888
+ "title": "Text"
1889
+ },
1890
+ "contentBase64": {
1891
+ "anyOf": [
1892
+ {
1893
+ "type": "string"
1894
+ },
1895
+ {
1896
+ "type": "null"
1897
+ }
1898
+ ],
1899
+ "title": "Contentbase64"
1900
+ }
1901
+ },
1902
+ "additionalProperties": false,
1903
+ "type": "object",
1904
+ "title": "TemplateContentUpdate",
1905
+ "description": "Replace one template file.\n\nAttributes:\n text: UTF-8 template body for text-like templates.\n content_base64: Base64-encoded bytes for binary templates\n (``contentBase64`` alias)."
1906
+ },
1907
+ "TemplateLibraryDetail": {
1908
+ "properties": {
1909
+ "id": {
1910
+ "type": "string",
1911
+ "title": "Id"
1912
+ },
1913
+ "kind": {
1914
+ "type": "string",
1915
+ "enum": [
1916
+ "document",
1917
+ "starter",
1918
+ "recipe"
1919
+ ],
1920
+ "title": "Kind"
1921
+ },
1922
+ "title": {
1923
+ "type": "string",
1924
+ "title": "Title"
1925
+ },
1926
+ "description": {
1927
+ "anyOf": [
1928
+ {
1929
+ "type": "string"
1930
+ },
1931
+ {
1932
+ "type": "null"
1933
+ }
1934
+ ],
1935
+ "title": "Description"
1936
+ },
1937
+ "documentType": {
1938
+ "anyOf": [
1939
+ {
1940
+ "type": "string"
1941
+ },
1942
+ {
1943
+ "type": "null"
1944
+ }
1945
+ ],
1946
+ "title": "Documenttype"
1947
+ },
1948
+ "driver": {
1949
+ "anyOf": [
1950
+ {
1951
+ "type": "string"
1952
+ },
1953
+ {
1954
+ "type": "null"
1955
+ }
1956
+ ],
1957
+ "title": "Driver"
1958
+ },
1959
+ "irFamily": {
1960
+ "anyOf": [
1961
+ {
1962
+ "type": "string"
1963
+ },
1964
+ {
1965
+ "type": "null"
1966
+ }
1967
+ ],
1968
+ "title": "Irfamily"
1969
+ },
1970
+ "tags": {
1971
+ "items": {
1972
+ "type": "string"
1973
+ },
1974
+ "type": "array",
1975
+ "title": "Tags"
1976
+ },
1977
+ "templateVersion": {
1978
+ "anyOf": [
1979
+ {
1980
+ "type": "string"
1981
+ },
1982
+ {
1983
+ "type": "null"
1984
+ }
1985
+ ],
1986
+ "title": "Templateversion"
1987
+ },
1988
+ "requiredInputs": {
1989
+ "items": {
1990
+ "type": "string"
1991
+ },
1992
+ "type": "array",
1993
+ "title": "Requiredinputs"
1994
+ },
1995
+ "capabilities": {
1996
+ "items": {
1997
+ "type": "string"
1998
+ },
1999
+ "type": "array",
2000
+ "title": "Capabilities"
2001
+ },
2002
+ "path": {
2003
+ "anyOf": [
2004
+ {
2005
+ "type": "string"
2006
+ },
2007
+ {
2008
+ "type": "null"
2009
+ }
2010
+ ],
2011
+ "title": "Path"
2012
+ },
2013
+ "mediaType": {
2014
+ "anyOf": [
2015
+ {
2016
+ "type": "string"
2017
+ },
2018
+ {
2019
+ "type": "null"
2020
+ }
2021
+ ],
2022
+ "title": "Mediatype"
2023
+ },
2024
+ "variableCount": {
2025
+ "anyOf": [
2026
+ {
2027
+ "type": "integer"
2028
+ },
2029
+ {
2030
+ "type": "null"
2031
+ }
2032
+ ],
2033
+ "title": "Variablecount"
2034
+ },
2035
+ "bitCount": {
2036
+ "anyOf": [
2037
+ {
2038
+ "type": "integer"
2039
+ },
2040
+ {
2041
+ "type": "null"
2042
+ }
2043
+ ],
2044
+ "title": "Bitcount"
2045
+ },
2046
+ "documentCount": {
2047
+ "anyOf": [
2048
+ {
2049
+ "type": "integer"
2050
+ },
2051
+ {
2052
+ "type": "null"
2053
+ }
2054
+ ],
2055
+ "title": "Documentcount"
2056
+ },
2057
+ "requiredBitTypes": {
2058
+ "items": {
2059
+ "$ref": "#/components/schemas/RequiredBitTypeSummary"
2060
+ },
2061
+ "type": "array",
2062
+ "title": "Requiredbittypes"
2063
+ },
2064
+ "manifest": {
2065
+ "anyOf": [
2066
+ {
2067
+ "additionalProperties": true,
2068
+ "type": "object"
2069
+ },
2070
+ {
2071
+ "type": "null"
2072
+ }
2073
+ ],
2074
+ "title": "Manifest"
2075
+ },
2076
+ "project": {
2077
+ "anyOf": [
2078
+ {
2079
+ "additionalProperties": true,
2080
+ "type": "object"
2081
+ },
2082
+ {
2083
+ "type": "null"
2084
+ }
2085
+ ],
2086
+ "title": "Project"
2087
+ },
2088
+ "recipe": {
2089
+ "anyOf": [
2090
+ {
2091
+ "additionalProperties": true,
2092
+ "type": "object"
2093
+ },
2094
+ {
2095
+ "type": "null"
2096
+ }
2097
+ ],
2098
+ "title": "Recipe"
2099
+ }
2100
+ },
2101
+ "additionalProperties": false,
2102
+ "type": "object",
2103
+ "required": [
2104
+ "id",
2105
+ "kind",
2106
+ "title"
2107
+ ],
2108
+ "title": "TemplateLibraryDetail",
2109
+ "description": "Full catalog entry with optional payload bodies.\n\nAttributes:\n manifest: Parsed template manifest for document entries.\n project: Starter project document for starter entries.\n recipe: Recipe document for recipe entries."
2110
+ },
2111
+ "TemplateLibraryEntry": {
2112
+ "properties": {
2113
+ "id": {
2114
+ "type": "string",
2115
+ "title": "Id"
2116
+ },
2117
+ "kind": {
2118
+ "type": "string",
2119
+ "enum": [
2120
+ "document",
2121
+ "starter",
2122
+ "recipe"
2123
+ ],
2124
+ "title": "Kind"
2125
+ },
2126
+ "title": {
2127
+ "type": "string",
2128
+ "title": "Title"
2129
+ },
2130
+ "description": {
2131
+ "anyOf": [
2132
+ {
2133
+ "type": "string"
2134
+ },
2135
+ {
2136
+ "type": "null"
2137
+ }
2138
+ ],
2139
+ "title": "Description"
2140
+ },
2141
+ "documentType": {
2142
+ "anyOf": [
2143
+ {
2144
+ "type": "string"
2145
+ },
2146
+ {
2147
+ "type": "null"
2148
+ }
2149
+ ],
2150
+ "title": "Documenttype"
2151
+ },
2152
+ "driver": {
2153
+ "anyOf": [
2154
+ {
2155
+ "type": "string"
2156
+ },
2157
+ {
2158
+ "type": "null"
2159
+ }
2160
+ ],
2161
+ "title": "Driver"
2162
+ },
2163
+ "irFamily": {
2164
+ "anyOf": [
2165
+ {
2166
+ "type": "string"
2167
+ },
2168
+ {
2169
+ "type": "null"
2170
+ }
2171
+ ],
2172
+ "title": "Irfamily"
2173
+ },
2174
+ "tags": {
2175
+ "items": {
2176
+ "type": "string"
2177
+ },
2178
+ "type": "array",
2179
+ "title": "Tags"
2180
+ },
2181
+ "templateVersion": {
2182
+ "anyOf": [
2183
+ {
2184
+ "type": "string"
2185
+ },
2186
+ {
2187
+ "type": "null"
2188
+ }
2189
+ ],
2190
+ "title": "Templateversion"
2191
+ },
2192
+ "requiredInputs": {
2193
+ "items": {
2194
+ "type": "string"
2195
+ },
2196
+ "type": "array",
2197
+ "title": "Requiredinputs"
2198
+ },
2199
+ "capabilities": {
2200
+ "items": {
2201
+ "type": "string"
2202
+ },
2203
+ "type": "array",
2204
+ "title": "Capabilities"
2205
+ },
2206
+ "path": {
2207
+ "anyOf": [
2208
+ {
2209
+ "type": "string"
2210
+ },
2211
+ {
2212
+ "type": "null"
2213
+ }
2214
+ ],
2215
+ "title": "Path"
2216
+ },
2217
+ "mediaType": {
2218
+ "anyOf": [
2219
+ {
2220
+ "type": "string"
2221
+ },
2222
+ {
2223
+ "type": "null"
2224
+ }
2225
+ ],
2226
+ "title": "Mediatype"
2227
+ },
2228
+ "variableCount": {
2229
+ "anyOf": [
2230
+ {
2231
+ "type": "integer"
2232
+ },
2233
+ {
2234
+ "type": "null"
2235
+ }
2236
+ ],
2237
+ "title": "Variablecount"
2238
+ },
2239
+ "bitCount": {
2240
+ "anyOf": [
2241
+ {
2242
+ "type": "integer"
2243
+ },
2244
+ {
2245
+ "type": "null"
2246
+ }
2247
+ ],
2248
+ "title": "Bitcount"
2249
+ },
2250
+ "documentCount": {
2251
+ "anyOf": [
2252
+ {
2253
+ "type": "integer"
2254
+ },
2255
+ {
2256
+ "type": "null"
2257
+ }
2258
+ ],
2259
+ "title": "Documentcount"
2260
+ },
2261
+ "requiredBitTypes": {
2262
+ "items": {
2263
+ "$ref": "#/components/schemas/RequiredBitTypeSummary"
2264
+ },
2265
+ "type": "array",
2266
+ "title": "Requiredbittypes"
2267
+ }
2268
+ },
2269
+ "additionalProperties": false,
2270
+ "type": "object",
2271
+ "required": [
2272
+ "id",
2273
+ "kind",
2274
+ "title"
2275
+ ],
2276
+ "title": "TemplateLibraryEntry",
2277
+ "description": "Summary row for one catalog entry.\n\nAttributes:\n id: Stable catalog entry identifier.\n kind: Entry kind: document, starter, or recipe.\n title: Human-readable catalog title.\n description: Optional longer description.\n document_type: Document type for document entries\n (``documentType`` alias).\n driver: Document driver id for document entries.\n ir_family: Intermediate representation family for documents\n (``irFamily`` alias).\n tags: Optional discovery tags.\n template_version: Template semver for document entries\n (``templateVersion`` alias).\n required_inputs: Named template inputs for document entries\n (``requiredInputs`` alias).\n capabilities: Declared document capabilities for document entries.\n path: Relative template path for document entries.\n media_type: MIME type for document template bytes\n (``mediaType`` alias).\n variable_count: Variable count for starters and recipes\n (``variableCount`` alias).\n bit_count: Bit count for starters and recipes (``bitCount`` alias).\n document_count: Document count for starters and recipes\n (``documentCount`` alias).\n required_bit_types: Required bit types for recipe entries\n (``requiredBitTypes`` alias)."
1466
2278
  },
1467
2279
  "ValidationError": {
1468
2280
  "properties": {
@@ -1578,7 +2390,7 @@
1578
2390
  "exposure"
1579
2391
  ],
1580
2392
  "title": "Variable",
1581
- "description": "A declared workspace variable."
2393
+ "description": "A declared workspace variable.\n\nAttributes:\n key: The variable's unique workspace key.\n schema_: JSON Schema (``schema`` alias) describing valid values.\n default_value: Default workspace value (``defaultValue`` alias)\n used when no override is provided.\n const: Whether the variable's value is immutable once set.\n exposure: Client-visibility policy for the variable's value.\n description: Optional human-readable description of the\n variable."
1582
2394
  }
1583
2395
  }
1584
2396
  }