@celigo/api-specs 0.2.76 → 0.2.77

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.
package/dist/ai-agent.yml CHANGED
@@ -128,7 +128,8 @@ paths:
128
128
  Hugging Face, DeepSeek, Cohere, and Groq — a block that does not match the
129
129
  provider is rejected. For a built-in provider, omit `_connectionId` to
130
130
  use platform-managed credentials or include it for BYOK; a catalog
131
- provider saves without one but needs a BYOK connection to run.
131
+ provider needs a BYOK connection to save — without one the request
132
+ fails with 422 `connection_required` on `_connectionId`.
132
133
  operationId: createAiAgent
133
134
  tags:
134
135
  - AI Agents
@@ -679,8 +680,9 @@ components:
679
680
 
680
681
  A `_connectionId` on the parent import selects bring-your-own-key (BYOK)
681
682
  credentials. Without one, built-in providers run on platform-managed
682
- credentials; catalog providers have no platform-managed credentials, so they
683
- save without a connection but cannot run until one is attached.
683
+ credentials; catalog providers have no platform-managed credentials, so the
684
+ save requires one — without it the agent fails to save with 422
685
+ `connection_required` on `_connectionId`.
684
686
  required:
685
687
  - provider
686
688
  properties:
@@ -717,10 +719,11 @@ components:
717
719
  generic flat format — `model` and `modelOptions` directly on this object,
718
720
  never an `openai` or `litellm` block.
719
721
  - |-
720
- Catalog providers are BYOK-only at run time: the agent saves without a
721
- `_connectionId`, but its first run fails with 422 `invalid_request` ("No API
722
- key configured for provider …"). Always attach an HTTP connection to the
723
- vendor's API (token auth) when the provider is a catalog provider.
722
+ Catalog providers are BYOK-only, and the save enforces it: without a `_connectionId`
723
+ the agent fails to save with 422 `connection_required` on `_connectionId` ("No API
724
+ key is available for provider 'xai'. Add a connection for this provider with your
725
+ API key and select it on this agent."). Attach an HTTP connection to the vendor's
726
+ API (token auth) before saving a catalog-provider agent.
724
727
  model:
725
728
  type: string
726
729
  description: |-
@@ -732,11 +735,11 @@ components:
732
735
  Required for every catalog provider — omitting it or sending an empty string
733
736
  fails the save with 422 `missing_required_field`.
734
737
  - |-
735
- Without a `_connectionId` on the parent import the model must be one the
736
- catalog lists for the provider: an unknown id fails the save with 422
737
- `model_not_found`, a listed-but-disabled id with 422 `model_disabled`. With a
738
- `_connectionId` (BYOK) any model string saves — the server does not check it
739
- against the catalog or the vendor.
738
+ The connection is checked before the model: without a `_connectionId` on the
739
+ parent import a catalog-provider agent fails to save with 422
740
+ `connection_required` whatever the model string (an unknown id included).
741
+ With a `_connectionId` (BYOK) any model string saves — the server does not
742
+ check it against the catalog or the vendor.
740
743
  modelOptions:
741
744
  type: object
742
745
  description: |-
@@ -1060,12 +1063,22 @@ components:
1060
1063
  - manual
1061
1064
  - json
1062
1065
  x-enumDescriptions:
1063
- manual: The schema was built field-by-field in the visual editor.
1064
- json: The schema was pasted or edited as raw JSON.
1066
+ manual: The UI opens `jsonSchema` in the visual field-by-field editor
1067
+ json: The UI opens `jsonSchema` in the raw JSON editor
1065
1068
  description: |-
1066
- How the structured-output schema was authored in the UI.
1067
- Editor state only — it does not change how `jsonSchema` is
1068
- sent to the provider.
1069
+ Which editor the UI opens `jsonSchema` in; the schema sent to the provider
1070
+ is the same either way, and the field is only meaningful when `type` is
1071
+ "json_schema". Unset opens the visual editor, and an edit there rebuilds
1072
+ `jsonSchema` from the field list, keeping only `type`, `properties`,
1073
+ `required`, `items`, `description`, `enum`, `pattern`, length and numeric
1074
+ bounds, `multipleOf`, `minItems`/`maxItems` and a `"null"` type — other
1075
+ keywords are dropped without a prompt, and `integer` becomes `number`.
1076
+ x-celigo-ai-guidance:
1077
+ - |-
1078
+ Set `json` on a schema written as raw JSON; keep a user's `manual` and stay
1079
+ inside the keywords the visual editor keeps. A full PUT that omits the field
1080
+ clears it, and a value outside the enum fails the save with 422 `enum` on
1081
+ `aiAgent.openai.output.format.schemaMode`.
1069
1082
  name:
1070
1083
  type: string
1071
1084
  description: Name for the output format (used with json_schema)
@@ -1418,12 +1431,22 @@ components:
1418
1431
  - manual
1419
1432
  - json
1420
1433
  x-enumDescriptions:
1421
- manual: The schema was built field-by-field in the visual editor.
1422
- json: The schema was pasted or edited as raw JSON.
1434
+ manual: The UI opens `jsonSchema` in the visual field-by-field editor
1435
+ json: The UI opens `jsonSchema` in the raw JSON editor
1423
1436
  description: |-
1424
- How the structured-output schema was authored in the UI. Editor
1425
- state only — it does not change how `jsonSchema` is sent to the
1426
- provider.
1437
+ Which editor the UI opens `jsonSchema` in; the schema sent to the provider is
1438
+ the same either way, and the field is only meaningful when `type` is
1439
+ "json_schema". Unset opens the visual editor, and an edit there rebuilds
1440
+ `jsonSchema` from the field list, keeping only `type`, `properties`, `required`,
1441
+ `items`, `description`, `enum`, `pattern`, length and numeric bounds,
1442
+ `multipleOf`, `minItems`/`maxItems` and a `"null"` type — other keywords are
1443
+ dropped without a prompt, and `integer` becomes `number`.
1444
+ x-celigo-ai-guidance:
1445
+ - |-
1446
+ Set `json` on a schema written as raw JSON; keep a user's `manual` and stay inside
1447
+ the keywords the visual editor keeps. A full PUT that omits the field clears it,
1448
+ and a value outside the enum fails the save with 422 `enum` on
1449
+ `aiAgent.litellm.responseFormat.schemaMode`.
1427
1450
  name:
1428
1451
  type: string
1429
1452
  description: Name for the output format (used with json_schema).
@@ -5225,8 +5248,9 @@ components:
5225
5248
  Connection for BYOK (bring your own key) — an HTTP connection to the vendor's API.
5226
5249
  Optional for the built-in providers (`openai`, `gemini`, `anthropic`), which run on
5227
5250
  platform-managed credentials when it is omitted. Catalog providers (`mistral`, `xai`,
5228
- `huggingface`, `deepseek`, `cohere`, `groq`) have no platform-managed credentials: the agent
5229
- saves without one but cannot run until it is set.
5251
+ `huggingface`, `deepseek`, `cohere`, `groq`) have no platform-managed credentials: the save
5252
+ requires it — without one the agent fails to save with 422 `connection_required` on
5253
+ `_connectionId`.
5230
5254
  examples:
5231
5255
  - 662aaa6576bf4040548dbbe4
5232
5256
  _integrationId:
@@ -602,8 +602,9 @@ components:
602
602
 
603
603
  A `_connectionId` on the parent import selects bring-your-own-key (BYOK)
604
604
  credentials. Without one, built-in providers run on platform-managed
605
- credentials; catalog providers have no platform-managed credentials, so they
606
- save without a connection but cannot run until one is attached.
605
+ credentials; catalog providers have no platform-managed credentials, so the
606
+ save requires one — without it the guardrail fails to save with 422
607
+ `connection_required` on `_connectionId`.
607
608
  x-celigo-ai-guidance:
608
609
  - |-
609
610
  Do not send `tools` on any block. A non-empty array at `tools`, `openai.tools`,
@@ -646,10 +647,11 @@ components:
646
647
  generic flat format — `model` and `modelOptions` directly on this object,
647
648
  never an `openai` or `litellm` block.
648
649
  - |-
649
- Catalog providers are BYOK-only at run time: the guardrail saves without a
650
- `_connectionId`, but its first run fails with 422 `invalid_request` ("No API
651
- key configured for provider …"). Always attach an HTTP connection to the
652
- vendor's API (token auth) when the provider is a catalog provider.
650
+ Catalog providers are BYOK-only, and the save enforces it: without a `_connectionId`
651
+ the guardrail fails to save with 422 `connection_required` on `_connectionId` ("No
652
+ API key is available for provider 'xai'. Add a connection for this provider with
653
+ your API key and select it on this agent."). Attach an HTTP connection to the
654
+ vendor's API (token auth) before saving a catalog-provider guardrail.
653
655
  model:
654
656
  type: string
655
657
  description: |-
@@ -661,11 +663,11 @@ components:
661
663
  Required for every catalog provider — omitting it or sending an empty string
662
664
  fails the save with 422 `missing_required_field`.
663
665
  - |-
664
- Without a `_connectionId` on the parent import the model must be one the
665
- catalog lists for the provider: an unknown id fails the save with 422
666
- `model_not_found`, a listed-but-disabled id with 422 `model_disabled`. With a
667
- `_connectionId` (BYOK) any model string saves — the server does not check it
668
- against the catalog or the vendor.
666
+ The connection is checked before the model: without a `_connectionId` on the
667
+ parent import a catalog-provider guardrail fails to save with 422
668
+ `connection_required` whatever the model string (an unknown id included).
669
+ With a `_connectionId` (BYOK) any model string saves — the server does not
670
+ check it against the catalog or the vendor.
669
671
  modelOptions:
670
672
  type: object
671
673
  description: |-
@@ -930,12 +932,17 @@ components:
930
932
  - manual
931
933
  - json
932
934
  x-enumDescriptions:
933
- manual: The schema was built field-by-field in the visual editor.
934
- json: The schema was pasted or edited as raw JSON.
935
+ manual: The schema editor opens `jsonSchema` in the visual field-by-field view
936
+ json: The schema editor opens `jsonSchema` in the raw JSON view
935
937
  description: |-
936
- How the structured-output schema was authored in the UI.
937
- Editor state only — it does not change how `jsonSchema` is
938
- sent to the provider.
938
+ Which view a schema editor opens `jsonSchema` in; the schema sent to the
939
+ provider is the same either way. Stored and echoed on guardrails for parity
940
+ with the AI-agent format block — the guardrail form does not set it today.
941
+ x-celigo-ai-guidance:
942
+ - |-
943
+ Resend the stored value on every update — a full PUT that omits the field
944
+ clears it — and never invent one: a value outside the enum fails the save with
945
+ 422 `enum` on `guardrail.aiAgent.openai.output.format.schemaMode`.
939
946
  name:
940
947
  type: string
941
948
  description: Name for the output format (used with json_schema)
@@ -1124,12 +1131,17 @@ components:
1124
1131
  - manual
1125
1132
  - json
1126
1133
  x-enumDescriptions:
1127
- manual: The schema was built field-by-field in the visual editor.
1128
- json: The schema was pasted or edited as raw JSON.
1134
+ manual: The schema editor opens `jsonSchema` in the visual field-by-field view
1135
+ json: The schema editor opens `jsonSchema` in the raw JSON view
1129
1136
  description: |-
1130
- How the structured-output schema was authored in the UI. Editor
1131
- state only — it does not change how `jsonSchema` is sent to the
1132
- provider.
1137
+ Which view a schema editor opens `jsonSchema` in; the schema sent to the provider
1138
+ is the same either way. Stored and echoed on guardrails for parity with the
1139
+ AI-agent format block — the guardrail form does not set it today.
1140
+ x-celigo-ai-guidance:
1141
+ - |-
1142
+ Resend the stored value on every update — a full PUT that omits the field clears
1143
+ it — and never invent one: a value outside the enum fails the save with 422 `enum`
1144
+ on `guardrail.aiAgent.litellm.responseFormat.schemaMode`.
1133
1145
  name:
1134
1146
  type: string
1135
1147
  description: Name for the output format (used with json_schema).
package/dist/import.yml CHANGED
@@ -9046,8 +9046,9 @@ components:
9046
9046
 
9047
9047
  A `_connectionId` on the parent import selects bring-your-own-key (BYOK)
9048
9048
  credentials. Without one, built-in providers run on platform-managed
9049
- credentials; catalog providers have no platform-managed credentials, so they
9050
- save without a connection but cannot run until one is attached.
9049
+ credentials; catalog providers have no platform-managed credentials, so the
9050
+ save requires one — without it the agent fails to save with 422
9051
+ `connection_required` on `_connectionId`.
9051
9052
  required:
9052
9053
  - provider
9053
9054
  properties:
@@ -9084,10 +9085,11 @@ components:
9084
9085
  generic flat format — `model` and `modelOptions` directly on this object,
9085
9086
  never an `openai` or `litellm` block.
9086
9087
  - |-
9087
- Catalog providers are BYOK-only at run time: the agent saves without a
9088
- `_connectionId`, but its first run fails with 422 `invalid_request` ("No API
9089
- key configured for provider …"). Always attach an HTTP connection to the
9090
- vendor's API (token auth) when the provider is a catalog provider.
9088
+ Catalog providers are BYOK-only, and the save enforces it: without a `_connectionId`
9089
+ the agent fails to save with 422 `connection_required` on `_connectionId` ("No API
9090
+ key is available for provider 'xai'. Add a connection for this provider with your
9091
+ API key and select it on this agent."). Attach an HTTP connection to the vendor's
9092
+ API (token auth) before saving a catalog-provider agent.
9091
9093
  model:
9092
9094
  type: string
9093
9095
  description: |-
@@ -9099,11 +9101,11 @@ components:
9099
9101
  Required for every catalog provider — omitting it or sending an empty string
9100
9102
  fails the save with 422 `missing_required_field`.
9101
9103
  - |-
9102
- Without a `_connectionId` on the parent import the model must be one the
9103
- catalog lists for the provider: an unknown id fails the save with 422
9104
- `model_not_found`, a listed-but-disabled id with 422 `model_disabled`. With a
9105
- `_connectionId` (BYOK) any model string saves — the server does not check it
9106
- against the catalog or the vendor.
9104
+ The connection is checked before the model: without a `_connectionId` on the
9105
+ parent import a catalog-provider agent fails to save with 422
9106
+ `connection_required` whatever the model string (an unknown id included).
9107
+ With a `_connectionId` (BYOK) any model string saves — the server does not
9108
+ check it against the catalog or the vendor.
9107
9109
  modelOptions:
9108
9110
  type: object
9109
9111
  description: |-
@@ -9427,12 +9429,22 @@ components:
9427
9429
  - manual
9428
9430
  - json
9429
9431
  x-enumDescriptions:
9430
- manual: The schema was built field-by-field in the visual editor.
9431
- json: The schema was pasted or edited as raw JSON.
9432
+ manual: The UI opens `jsonSchema` in the visual field-by-field editor
9433
+ json: The UI opens `jsonSchema` in the raw JSON editor
9432
9434
  description: |-
9433
- How the structured-output schema was authored in the UI.
9434
- Editor state only — it does not change how `jsonSchema` is
9435
- sent to the provider.
9435
+ Which editor the UI opens `jsonSchema` in; the schema sent to the provider
9436
+ is the same either way, and the field is only meaningful when `type` is
9437
+ "json_schema". Unset opens the visual editor, and an edit there rebuilds
9438
+ `jsonSchema` from the field list, keeping only `type`, `properties`,
9439
+ `required`, `items`, `description`, `enum`, `pattern`, length and numeric
9440
+ bounds, `multipleOf`, `minItems`/`maxItems` and a `"null"` type — other
9441
+ keywords are dropped without a prompt, and `integer` becomes `number`.
9442
+ x-celigo-ai-guidance:
9443
+ - |-
9444
+ Set `json` on a schema written as raw JSON; keep a user's `manual` and stay
9445
+ inside the keywords the visual editor keeps. A full PUT that omits the field
9446
+ clears it, and a value outside the enum fails the save with 422 `enum` on
9447
+ `aiAgent.openai.output.format.schemaMode`.
9436
9448
  name:
9437
9449
  type: string
9438
9450
  description: Name for the output format (used with json_schema)
@@ -9785,12 +9797,22 @@ components:
9785
9797
  - manual
9786
9798
  - json
9787
9799
  x-enumDescriptions:
9788
- manual: The schema was built field-by-field in the visual editor.
9789
- json: The schema was pasted or edited as raw JSON.
9800
+ manual: The UI opens `jsonSchema` in the visual field-by-field editor
9801
+ json: The UI opens `jsonSchema` in the raw JSON editor
9790
9802
  description: |-
9791
- How the structured-output schema was authored in the UI. Editor
9792
- state only — it does not change how `jsonSchema` is sent to the
9793
- provider.
9803
+ Which editor the UI opens `jsonSchema` in; the schema sent to the provider is
9804
+ the same either way, and the field is only meaningful when `type` is
9805
+ "json_schema". Unset opens the visual editor, and an edit there rebuilds
9806
+ `jsonSchema` from the field list, keeping only `type`, `properties`, `required`,
9807
+ `items`, `description`, `enum`, `pattern`, length and numeric bounds,
9808
+ `multipleOf`, `minItems`/`maxItems` and a `"null"` type — other keywords are
9809
+ dropped without a prompt, and `integer` becomes `number`.
9810
+ x-celigo-ai-guidance:
9811
+ - |-
9812
+ Set `json` on a schema written as raw JSON; keep a user's `manual` and stay inside
9813
+ the keywords the visual editor keeps. A full PUT that omits the field clears it,
9814
+ and a value outside the enum fails the save with 422 `enum` on
9815
+ `aiAgent.litellm.responseFormat.schemaMode`.
9794
9816
  name:
9795
9817
  type: string
9796
9818
  description: Name for the output format (used with json_schema).
@@ -10467,8 +10489,9 @@ components:
10467
10489
 
10468
10490
  A `_connectionId` on the parent import selects bring-your-own-key (BYOK)
10469
10491
  credentials. Without one, built-in providers run on platform-managed
10470
- credentials; catalog providers have no platform-managed credentials, so they
10471
- save without a connection but cannot run until one is attached.
10492
+ credentials; catalog providers have no platform-managed credentials, so the
10493
+ save requires one — without it the guardrail fails to save with 422
10494
+ `connection_required` on `_connectionId`.
10472
10495
  x-celigo-ai-guidance:
10473
10496
  - |-
10474
10497
  Do not send `tools` on any block. A non-empty array at `tools`, `openai.tools`,
@@ -10511,10 +10534,11 @@ components:
10511
10534
  generic flat format — `model` and `modelOptions` directly on this object,
10512
10535
  never an `openai` or `litellm` block.
10513
10536
  - |-
10514
- Catalog providers are BYOK-only at run time: the guardrail saves without a
10515
- `_connectionId`, but its first run fails with 422 `invalid_request` ("No API
10516
- key configured for provider …"). Always attach an HTTP connection to the
10517
- vendor's API (token auth) when the provider is a catalog provider.
10537
+ Catalog providers are BYOK-only, and the save enforces it: without a `_connectionId`
10538
+ the guardrail fails to save with 422 `connection_required` on `_connectionId` ("No
10539
+ API key is available for provider 'xai'. Add a connection for this provider with
10540
+ your API key and select it on this agent."). Attach an HTTP connection to the
10541
+ vendor's API (token auth) before saving a catalog-provider guardrail.
10518
10542
  model:
10519
10543
  type: string
10520
10544
  description: |-
@@ -10526,11 +10550,11 @@ components:
10526
10550
  Required for every catalog provider — omitting it or sending an empty string
10527
10551
  fails the save with 422 `missing_required_field`.
10528
10552
  - |-
10529
- Without a `_connectionId` on the parent import the model must be one the
10530
- catalog lists for the provider: an unknown id fails the save with 422
10531
- `model_not_found`, a listed-but-disabled id with 422 `model_disabled`. With a
10532
- `_connectionId` (BYOK) any model string saves — the server does not check it
10533
- against the catalog or the vendor.
10553
+ The connection is checked before the model: without a `_connectionId` on the
10554
+ parent import a catalog-provider guardrail fails to save with 422
10555
+ `connection_required` whatever the model string (an unknown id included).
10556
+ With a `_connectionId` (BYOK) any model string saves — the server does not
10557
+ check it against the catalog or the vendor.
10534
10558
  modelOptions:
10535
10559
  type: object
10536
10560
  description: |-
@@ -10795,12 +10819,17 @@ components:
10795
10819
  - manual
10796
10820
  - json
10797
10821
  x-enumDescriptions:
10798
- manual: The schema was built field-by-field in the visual editor.
10799
- json: The schema was pasted or edited as raw JSON.
10822
+ manual: The schema editor opens `jsonSchema` in the visual field-by-field view
10823
+ json: The schema editor opens `jsonSchema` in the raw JSON view
10800
10824
  description: |-
10801
- How the structured-output schema was authored in the UI.
10802
- Editor state only — it does not change how `jsonSchema` is
10803
- sent to the provider.
10825
+ Which view a schema editor opens `jsonSchema` in; the schema sent to the
10826
+ provider is the same either way. Stored and echoed on guardrails for parity
10827
+ with the AI-agent format block — the guardrail form does not set it today.
10828
+ x-celigo-ai-guidance:
10829
+ - |-
10830
+ Resend the stored value on every update — a full PUT that omits the field
10831
+ clears it — and never invent one: a value outside the enum fails the save with
10832
+ 422 `enum` on `guardrail.aiAgent.openai.output.format.schemaMode`.
10804
10833
  name:
10805
10834
  type: string
10806
10835
  description: Name for the output format (used with json_schema)
@@ -10989,12 +11018,17 @@ components:
10989
11018
  - manual
10990
11019
  - json
10991
11020
  x-enumDescriptions:
10992
- manual: The schema was built field-by-field in the visual editor.
10993
- json: The schema was pasted or edited as raw JSON.
11021
+ manual: The schema editor opens `jsonSchema` in the visual field-by-field view
11022
+ json: The schema editor opens `jsonSchema` in the raw JSON view
10994
11023
  description: |-
10995
- How the structured-output schema was authored in the UI. Editor
10996
- state only — it does not change how `jsonSchema` is sent to the
10997
- provider.
11024
+ Which view a schema editor opens `jsonSchema` in; the schema sent to the provider
11025
+ is the same either way. Stored and echoed on guardrails for parity with the
11026
+ AI-agent format block — the guardrail form does not set it today.
11027
+ x-celigo-ai-guidance:
11028
+ - |-
11029
+ Resend the stored value on every update — a full PUT that omits the field clears
11030
+ it — and never invent one: a value outside the enum fails the save with 422 `enum`
11031
+ on `guardrail.aiAgent.litellm.responseFormat.schemaMode`.
10998
11032
  name:
10999
11033
  type: string
11000
11034
  description: Name for the output format (used with json_schema).
package/dist/tool.yml CHANGED
@@ -5577,11 +5577,25 @@ components:
5577
5577
  - manual
5578
5578
  - json
5579
5579
  x-enumDescriptions:
5580
- manual: The input schema was built field-by-field in the visual editor
5581
- json: The input schema was pasted or edited as raw JSON
5580
+ manual: The UI opens `schema` in the visual field-by-field editor
5581
+ json: The UI opens `schema` in the raw JSON editor
5582
5582
  description: |-
5583
- How `schema` was authored in the UI. Editor state only — it does not change how
5584
- the schema validates invocation input. Present when set.
5583
+ Which editor the UI opens `schema` in; invocation input validates the same either way.
5584
+ Unset opens the visual editor, and an edit there rebuilds `schema` from the field list,
5585
+ keeping only `type`, `properties`, `required`, `items`, `description`, `enum`, `pattern`,
5586
+ `minLength`/`maxLength`, `minimum`/`maximum`, `exclusiveMinimum`/`exclusiveMaximum`,
5587
+ `multipleOf`, `minItems`/`maxItems` and a `"null"` type — `format`, `const`, `default`,
5588
+ `additionalProperties`, `$ref` and `allOf`/`anyOf`/`oneOf`/`if` are dropped without a
5589
+ prompt, and `integer` becomes `number`.
5590
+ x-celigo-ai-guidance:
5591
+ - |-
5592
+ Set `json` on any schema written as raw JSON so the UI opens the JSON editor and warns
5593
+ before a switch to the visual editor can drop keywords; keep `manual` on a schema a
5594
+ user built in the visual editor and stay inside the keywords it keeps.
5595
+ - |-
5596
+ A full PUT that omits this field clears it — resend the stored value on every update.
5597
+ PATCH rejects the path ("/input/schemaMode is not a whitelisted property"), and a value
5598
+ outside the enum fails the save with 422 `enum` on `input.schemaMode`.
5585
5599
  examples:
5586
5600
  - json
5587
5601
  transform:
@@ -5662,11 +5676,25 @@ components:
5662
5676
  - manual
5663
5677
  - json
5664
5678
  x-enumDescriptions:
5665
- manual: The output schema was built field-by-field in the visual editor
5666
- json: The output schema was pasted or edited as raw JSON
5679
+ manual: The UI opens `schema` in the visual field-by-field editor
5680
+ json: The UI opens `schema` in the raw JSON editor
5667
5681
  description: |-
5668
- How `schema` was authored in the UI. Editor state only — it does not change how
5669
- the output is produced. Present when set.
5682
+ Which editor the UI opens `schema` in; the output validates the same either way. Unset
5683
+ opens the visual editor, and an edit there rebuilds `schema` from the field list, keeping
5684
+ only `type`, `properties`, `required`, `items`, `description`, `enum`, `pattern`,
5685
+ `minLength`/`maxLength`, `minimum`/`maximum`, `exclusiveMinimum`/`exclusiveMaximum`,
5686
+ `multipleOf`, `minItems`/`maxItems` and a `"null"` type — `format`, `const`, `default`,
5687
+ `additionalProperties`, `$ref` and `allOf`/`anyOf`/`oneOf`/`if` are dropped without a
5688
+ prompt, and `integer` becomes `number`.
5689
+ x-celigo-ai-guidance:
5690
+ - |-
5691
+ Set `json` on any schema written as raw JSON so the UI opens the JSON editor and warns
5692
+ before a switch to the visual editor can drop keywords; keep `manual` on a schema a
5693
+ user built in the visual editor and stay inside the keywords it keeps.
5694
+ - |-
5695
+ A full PUT that omits this field clears it — resend the stored value on every update.
5696
+ PATCH rejects the path ("/output/schemaMode is not a whitelisted property"), and a
5697
+ value outside the enum fails the save with 422 `enum` on `output.schemaMode`.
5670
5698
  examples:
5671
5699
  - manual
5672
5700
  mappings:
@@ -19416,8 +19444,9 @@ components:
19416
19444
 
19417
19445
  A `_connectionId` on the parent import selects bring-your-own-key (BYOK)
19418
19446
  credentials. Without one, built-in providers run on platform-managed
19419
- credentials; catalog providers have no platform-managed credentials, so they
19420
- save without a connection but cannot run until one is attached.
19447
+ credentials; catalog providers have no platform-managed credentials, so the
19448
+ save requires one — without it the agent fails to save with 422
19449
+ `connection_required` on `_connectionId`.
19421
19450
  required:
19422
19451
  - provider
19423
19452
  properties:
@@ -19454,10 +19483,11 @@ components:
19454
19483
  generic flat format — `model` and `modelOptions` directly on this object,
19455
19484
  never an `openai` or `litellm` block.
19456
19485
  - |-
19457
- Catalog providers are BYOK-only at run time: the agent saves without a
19458
- `_connectionId`, but its first run fails with 422 `invalid_request` ("No API
19459
- key configured for provider …"). Always attach an HTTP connection to the
19460
- vendor's API (token auth) when the provider is a catalog provider.
19486
+ Catalog providers are BYOK-only, and the save enforces it: without a `_connectionId`
19487
+ the agent fails to save with 422 `connection_required` on `_connectionId` ("No API
19488
+ key is available for provider 'xai'. Add a connection for this provider with your
19489
+ API key and select it on this agent."). Attach an HTTP connection to the vendor's
19490
+ API (token auth) before saving a catalog-provider agent.
19461
19491
  model:
19462
19492
  type: string
19463
19493
  description: |-
@@ -19469,11 +19499,11 @@ components:
19469
19499
  Required for every catalog provider — omitting it or sending an empty string
19470
19500
  fails the save with 422 `missing_required_field`.
19471
19501
  - |-
19472
- Without a `_connectionId` on the parent import the model must be one the
19473
- catalog lists for the provider: an unknown id fails the save with 422
19474
- `model_not_found`, a listed-but-disabled id with 422 `model_disabled`. With a
19475
- `_connectionId` (BYOK) any model string saves — the server does not check it
19476
- against the catalog or the vendor.
19502
+ The connection is checked before the model: without a `_connectionId` on the
19503
+ parent import a catalog-provider agent fails to save with 422
19504
+ `connection_required` whatever the model string (an unknown id included).
19505
+ With a `_connectionId` (BYOK) any model string saves — the server does not
19506
+ check it against the catalog or the vendor.
19477
19507
  modelOptions:
19478
19508
  type: object
19479
19509
  description: |-
@@ -19797,12 +19827,22 @@ components:
19797
19827
  - manual
19798
19828
  - json
19799
19829
  x-enumDescriptions:
19800
- manual: The schema was built field-by-field in the visual editor.
19801
- json: The schema was pasted or edited as raw JSON.
19830
+ manual: The UI opens `jsonSchema` in the visual field-by-field editor
19831
+ json: The UI opens `jsonSchema` in the raw JSON editor
19802
19832
  description: |-
19803
- How the structured-output schema was authored in the UI.
19804
- Editor state only — it does not change how `jsonSchema` is
19805
- sent to the provider.
19833
+ Which editor the UI opens `jsonSchema` in; the schema sent to the provider
19834
+ is the same either way, and the field is only meaningful when `type` is
19835
+ "json_schema". Unset opens the visual editor, and an edit there rebuilds
19836
+ `jsonSchema` from the field list, keeping only `type`, `properties`,
19837
+ `required`, `items`, `description`, `enum`, `pattern`, length and numeric
19838
+ bounds, `multipleOf`, `minItems`/`maxItems` and a `"null"` type — other
19839
+ keywords are dropped without a prompt, and `integer` becomes `number`.
19840
+ x-celigo-ai-guidance:
19841
+ - |-
19842
+ Set `json` on a schema written as raw JSON; keep a user's `manual` and stay
19843
+ inside the keywords the visual editor keeps. A full PUT that omits the field
19844
+ clears it, and a value outside the enum fails the save with 422 `enum` on
19845
+ `aiAgent.openai.output.format.schemaMode`.
19806
19846
  name:
19807
19847
  type: string
19808
19848
  description: Name for the output format (used with json_schema)
@@ -20155,12 +20195,22 @@ components:
20155
20195
  - manual
20156
20196
  - json
20157
20197
  x-enumDescriptions:
20158
- manual: The schema was built field-by-field in the visual editor.
20159
- json: The schema was pasted or edited as raw JSON.
20198
+ manual: The UI opens `jsonSchema` in the visual field-by-field editor
20199
+ json: The UI opens `jsonSchema` in the raw JSON editor
20160
20200
  description: |-
20161
- How the structured-output schema was authored in the UI. Editor
20162
- state only — it does not change how `jsonSchema` is sent to the
20163
- provider.
20201
+ Which editor the UI opens `jsonSchema` in; the schema sent to the provider is
20202
+ the same either way, and the field is only meaningful when `type` is
20203
+ "json_schema". Unset opens the visual editor, and an edit there rebuilds
20204
+ `jsonSchema` from the field list, keeping only `type`, `properties`, `required`,
20205
+ `items`, `description`, `enum`, `pattern`, length and numeric bounds,
20206
+ `multipleOf`, `minItems`/`maxItems` and a `"null"` type — other keywords are
20207
+ dropped without a prompt, and `integer` becomes `number`.
20208
+ x-celigo-ai-guidance:
20209
+ - |-
20210
+ Set `json` on a schema written as raw JSON; keep a user's `manual` and stay inside
20211
+ the keywords the visual editor keeps. A full PUT that omits the field clears it,
20212
+ and a value outside the enum fails the save with 422 `enum` on
20213
+ `aiAgent.litellm.responseFormat.schemaMode`.
20164
20214
  name:
20165
20215
  type: string
20166
20216
  description: Name for the output format (used with json_schema).
@@ -20837,8 +20887,9 @@ components:
20837
20887
 
20838
20888
  A `_connectionId` on the parent import selects bring-your-own-key (BYOK)
20839
20889
  credentials. Without one, built-in providers run on platform-managed
20840
- credentials; catalog providers have no platform-managed credentials, so they
20841
- save without a connection but cannot run until one is attached.
20890
+ credentials; catalog providers have no platform-managed credentials, so the
20891
+ save requires one — without it the guardrail fails to save with 422
20892
+ `connection_required` on `_connectionId`.
20842
20893
  x-celigo-ai-guidance:
20843
20894
  - |-
20844
20895
  Do not send `tools` on any block. A non-empty array at `tools`, `openai.tools`,
@@ -20881,10 +20932,11 @@ components:
20881
20932
  generic flat format — `model` and `modelOptions` directly on this object,
20882
20933
  never an `openai` or `litellm` block.
20883
20934
  - |-
20884
- Catalog providers are BYOK-only at run time: the guardrail saves without a
20885
- `_connectionId`, but its first run fails with 422 `invalid_request` ("No API
20886
- key configured for provider …"). Always attach an HTTP connection to the
20887
- vendor's API (token auth) when the provider is a catalog provider.
20935
+ Catalog providers are BYOK-only, and the save enforces it: without a `_connectionId`
20936
+ the guardrail fails to save with 422 `connection_required` on `_connectionId` ("No
20937
+ API key is available for provider 'xai'. Add a connection for this provider with
20938
+ your API key and select it on this agent."). Attach an HTTP connection to the
20939
+ vendor's API (token auth) before saving a catalog-provider guardrail.
20888
20940
  model:
20889
20941
  type: string
20890
20942
  description: |-
@@ -20896,11 +20948,11 @@ components:
20896
20948
  Required for every catalog provider — omitting it or sending an empty string
20897
20949
  fails the save with 422 `missing_required_field`.
20898
20950
  - |-
20899
- Without a `_connectionId` on the parent import the model must be one the
20900
- catalog lists for the provider: an unknown id fails the save with 422
20901
- `model_not_found`, a listed-but-disabled id with 422 `model_disabled`. With a
20902
- `_connectionId` (BYOK) any model string saves — the server does not check it
20903
- against the catalog or the vendor.
20951
+ The connection is checked before the model: without a `_connectionId` on the
20952
+ parent import a catalog-provider guardrail fails to save with 422
20953
+ `connection_required` whatever the model string (an unknown id included).
20954
+ With a `_connectionId` (BYOK) any model string saves — the server does not
20955
+ check it against the catalog or the vendor.
20904
20956
  modelOptions:
20905
20957
  type: object
20906
20958
  description: |-
@@ -21165,12 +21217,17 @@ components:
21165
21217
  - manual
21166
21218
  - json
21167
21219
  x-enumDescriptions:
21168
- manual: The schema was built field-by-field in the visual editor.
21169
- json: The schema was pasted or edited as raw JSON.
21220
+ manual: The schema editor opens `jsonSchema` in the visual field-by-field view
21221
+ json: The schema editor opens `jsonSchema` in the raw JSON view
21170
21222
  description: |-
21171
- How the structured-output schema was authored in the UI.
21172
- Editor state only — it does not change how `jsonSchema` is
21173
- sent to the provider.
21223
+ Which view a schema editor opens `jsonSchema` in; the schema sent to the
21224
+ provider is the same either way. Stored and echoed on guardrails for parity
21225
+ with the AI-agent format block — the guardrail form does not set it today.
21226
+ x-celigo-ai-guidance:
21227
+ - |-
21228
+ Resend the stored value on every update — a full PUT that omits the field
21229
+ clears it — and never invent one: a value outside the enum fails the save with
21230
+ 422 `enum` on `guardrail.aiAgent.openai.output.format.schemaMode`.
21174
21231
  name:
21175
21232
  type: string
21176
21233
  description: Name for the output format (used with json_schema)
@@ -21359,12 +21416,17 @@ components:
21359
21416
  - manual
21360
21417
  - json
21361
21418
  x-enumDescriptions:
21362
- manual: The schema was built field-by-field in the visual editor.
21363
- json: The schema was pasted or edited as raw JSON.
21419
+ manual: The schema editor opens `jsonSchema` in the visual field-by-field view
21420
+ json: The schema editor opens `jsonSchema` in the raw JSON view
21364
21421
  description: |-
21365
- How the structured-output schema was authored in the UI. Editor
21366
- state only — it does not change how `jsonSchema` is sent to the
21367
- provider.
21422
+ Which view a schema editor opens `jsonSchema` in; the schema sent to the provider
21423
+ is the same either way. Stored and echoed on guardrails for parity with the
21424
+ AI-agent format block — the guardrail form does not set it today.
21425
+ x-celigo-ai-guidance:
21426
+ - |-
21427
+ Resend the stored value on every update — a full PUT that omits the field clears
21428
+ it — and never invent one: a value outside the enum fails the save with 422 `enum`
21429
+ on `guardrail.aiAgent.litellm.responseFormat.schemaMode`.
21368
21430
  name:
21369
21431
  type: string
21370
21432
  description: Name for the output format (used with json_schema).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celigo/api-specs",
3
- "version": "0.2.76",
3
+ "version": "0.2.77",
4
4
  "private": false,
5
5
  "description": "Public OpenAPI bundles (dist/) and the celigo-cli lint schema pack (schemas.json).",
6
6
  "keywords": [
package/schemas.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "provenance": {
3
3
  "repo": "celigo/integrator-api-specs",
4
- "iasCommit": "1d2dcf0",
4
+ "iasCommit": "2fa4fd0",
5
5
  "generatedAt": "2026-10-06"
6
6
  },
7
7
  "roots": {