@celigo/api-specs 0.2.150 → 0.2.151

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.
@@ -914,12 +914,17 @@ components:
914
914
  run at `default` regardless of what's set here.
915
915
  output:
916
916
  type: object
917
- description: Output format configuration
917
+ description: |-
918
+ Output format configuration. A guardrail stores `format` but doesn't use it: the
919
+ request to the model always carries the guardrail's own `validation_result` JSON
920
+ schema (`flagged`, `reasoning`, `confidence`), and the result returns `flagged` and
921
+ `reasoning` whatever `format` holds.
918
922
  properties:
919
923
  format:
920
924
  type: object
921
925
  description: |
922
- Controls the structure of the model's output.
926
+ Stored output structure. The request to the model uses the guardrail's own
927
+ verdict schema instead (see `output`).
923
928
  properties:
924
929
  type:
925
930
  type: string
@@ -928,10 +933,10 @@ components:
928
933
  - json_schema
929
934
  - blob
930
935
  x-enumDescriptions:
931
- text: Free-form text response from the model.
932
- json_schema: Structured JSON output conforming to a defined schema.
933
- blob: Binary data output for non-text content.
934
- description: Output format type.
936
+ text: Stored format type; the model request still uses the guardrail's verdict schema.
937
+ json_schema: A stored JSON schema (`jsonSchema`); the model request still uses the guardrail's verdict schema.
938
+ blob: Stored format type; the model request still uses the guardrail's verdict schema.
939
+ description: Output format type, as stored.
935
940
  schemaMode:
936
941
  type: string
937
942
  enum:
@@ -941,9 +946,9 @@ components:
941
946
  manual: The schema editor opens `jsonSchema` in the visual field-by-field view
942
947
  json: The schema editor opens `jsonSchema` in the raw JSON view
943
948
  description: |-
944
- Which view a schema editor opens `jsonSchema` in; the schema sent to the
945
- provider is the same either way. Stored and echoed on guardrails for parity
946
- with the AI-agent format block — the guardrail form does not set it today.
949
+ Which view a schema editor opens `jsonSchema` in. Stored and echoed on
950
+ guardrails for parity with the AI-agent format block — the guardrail form
951
+ does not set it today, and neither view changes the model request.
947
952
  x-celigo-ai-guidance:
948
953
  - |-
949
954
  Resend the stored value on every update — a full PUT that omits the field
@@ -955,18 +960,20 @@ components:
955
960
  x-celigo-ui-override: Required by the AI agent form when output format type is json_schema. Encoded here to mirror the form so builders produce connectable configurations.
956
961
  strict:
957
962
  type: boolean
958
- description: When true, enforces strict schema validation on output.
963
+ description: Stored strict-validation flag for `jsonSchema`. A guardrail's model request uses its own verdict schema, so this doesn't apply there.
959
964
  x-celigo-ai-guidance:
960
- - Whether to enforce strict schema validation on output
965
+ - Stored only on a guardrail; it doesn't change the guardrail's verdict.
961
966
  jsonSchema:
962
967
  type: object
963
968
  description: |
964
- JSON Schema for structured output. Required when `format.type` is "json_schema".
969
+ Stored JSON Schema. Required when `format.type` is "json_schema". A guardrail
970
+ doesn't send it to the model; the request carries the `validation_result`
971
+ verdict schema instead.
965
972
  x-celigo-ui-override: Required by the AI agent form when output format type is json_schema. Encoded here to mirror the form so builders produce connectable configurations.
966
973
  properties:
967
974
  type:
968
975
  type: string
969
- description: Root JSON Schema type of the structured output; use "object" for record-shaped results.
976
+ description: Root type of the stored JSON Schema.
970
977
  enum:
971
978
  - object
972
979
  - array
@@ -984,15 +991,15 @@ components:
984
991
  properties:
985
992
  type: object
986
993
  additionalProperties: true
987
- description: JSON Schema definitions for each field the structured output may contain.
994
+ description: Field definitions in the stored JSON Schema.
988
995
  required:
989
996
  type: array
990
- description: Property names the model must include in the structured output.
997
+ description: Property names the stored JSON Schema marks as required.
991
998
  items:
992
999
  type: string
993
1000
  additionalproperties:
994
1001
  type: boolean
995
- description: When true, the structured output may include properties beyond those defined in `properties`.
1002
+ description: Whether the stored JSON Schema allows properties beyond those in `properties`.
996
1003
  schema:
997
1004
  type: object
998
1005
  readOnly: true
package/dist/import.yml CHANGED
@@ -10968,12 +10968,17 @@ components:
10968
10968
  run at `default` regardless of what's set here.
10969
10969
  output:
10970
10970
  type: object
10971
- description: Output format configuration
10971
+ description: |-
10972
+ Output format configuration. A guardrail stores `format` but doesn't use it: the
10973
+ request to the model always carries the guardrail's own `validation_result` JSON
10974
+ schema (`flagged`, `reasoning`, `confidence`), and the result returns `flagged` and
10975
+ `reasoning` whatever `format` holds.
10972
10976
  properties:
10973
10977
  format:
10974
10978
  type: object
10975
10979
  description: |
10976
- Controls the structure of the model's output.
10980
+ Stored output structure. The request to the model uses the guardrail's own
10981
+ verdict schema instead (see `output`).
10977
10982
  properties:
10978
10983
  type:
10979
10984
  type: string
@@ -10982,10 +10987,10 @@ components:
10982
10987
  - json_schema
10983
10988
  - blob
10984
10989
  x-enumDescriptions:
10985
- text: Free-form text response from the model.
10986
- json_schema: Structured JSON output conforming to a defined schema.
10987
- blob: Binary data output for non-text content.
10988
- description: Output format type.
10990
+ text: Stored format type; the model request still uses the guardrail's verdict schema.
10991
+ json_schema: A stored JSON schema (`jsonSchema`); the model request still uses the guardrail's verdict schema.
10992
+ blob: Stored format type; the model request still uses the guardrail's verdict schema.
10993
+ description: Output format type, as stored.
10989
10994
  schemaMode:
10990
10995
  type: string
10991
10996
  enum:
@@ -10995,9 +11000,9 @@ components:
10995
11000
  manual: The schema editor opens `jsonSchema` in the visual field-by-field view
10996
11001
  json: The schema editor opens `jsonSchema` in the raw JSON view
10997
11002
  description: |-
10998
- Which view a schema editor opens `jsonSchema` in; the schema sent to the
10999
- provider is the same either way. Stored and echoed on guardrails for parity
11000
- with the AI-agent format block — the guardrail form does not set it today.
11003
+ Which view a schema editor opens `jsonSchema` in. Stored and echoed on
11004
+ guardrails for parity with the AI-agent format block — the guardrail form
11005
+ does not set it today, and neither view changes the model request.
11001
11006
  x-celigo-ai-guidance:
11002
11007
  - |-
11003
11008
  Resend the stored value on every update — a full PUT that omits the field
@@ -11009,18 +11014,20 @@ components:
11009
11014
  x-celigo-ui-override: Required by the AI agent form when output format type is json_schema. Encoded here to mirror the form so builders produce connectable configurations.
11010
11015
  strict:
11011
11016
  type: boolean
11012
- description: When true, enforces strict schema validation on output.
11017
+ description: Stored strict-validation flag for `jsonSchema`. A guardrail's model request uses its own verdict schema, so this doesn't apply there.
11013
11018
  x-celigo-ai-guidance:
11014
- - Whether to enforce strict schema validation on output
11019
+ - Stored only on a guardrail; it doesn't change the guardrail's verdict.
11015
11020
  jsonSchema:
11016
11021
  type: object
11017
11022
  description: |
11018
- JSON Schema for structured output. Required when `format.type` is "json_schema".
11023
+ Stored JSON Schema. Required when `format.type` is "json_schema". A guardrail
11024
+ doesn't send it to the model; the request carries the `validation_result`
11025
+ verdict schema instead.
11019
11026
  x-celigo-ui-override: Required by the AI agent form when output format type is json_schema. Encoded here to mirror the form so builders produce connectable configurations.
11020
11027
  properties:
11021
11028
  type:
11022
11029
  type: string
11023
- description: Root JSON Schema type of the structured output; use "object" for record-shaped results.
11030
+ description: Root type of the stored JSON Schema.
11024
11031
  enum:
11025
11032
  - object
11026
11033
  - array
@@ -11038,15 +11045,15 @@ components:
11038
11045
  properties:
11039
11046
  type: object
11040
11047
  additionalProperties: true
11041
- description: JSON Schema definitions for each field the structured output may contain.
11048
+ description: Field definitions in the stored JSON Schema.
11042
11049
  required:
11043
11050
  type: array
11044
- description: Property names the model must include in the structured output.
11051
+ description: Property names the stored JSON Schema marks as required.
11045
11052
  items:
11046
11053
  type: string
11047
11054
  additionalproperties:
11048
11055
  type: boolean
11049
- description: When true, the structured output may include properties beyond those defined in `properties`.
11056
+ description: Whether the stored JSON Schema allows properties beyond those in `properties`.
11050
11057
  schema:
11051
11058
  type: object
11052
11059
  readOnly: true
@@ -5139,7 +5139,12 @@ components:
5139
5139
  type: boolean
5140
5140
  description: |
5141
5141
  When true, uses iClient-managed OAuth credentials (clientId/clientSecret)
5142
- instead of the values in this configuration.
5142
+ instead of the values in this configuration. The iClient is the connection's
5143
+ `_iClientId` — on an HTTP connection `http._iClientId`, beside `auth`, not inside it —
5144
+ and it also supplies the grant type and the authorization and token endpoints, so a
5145
+ create needs only `auth.type: "oauth"`, `auth.oauth.useIClientFields: true` and the
5146
+ iClient id. The connection holds no tokens until a person completes the authorization
5147
+ in a browser.
5143
5148
  oauth1:
5144
5149
  type: object
5145
5150
  description: |-
@@ -5268,7 +5273,7 @@ components:
5268
5273
  x-celigo-ai-guidance:
5269
5274
  - |-
5270
5275
  ## OAUTH 2.0 GRANT TYPES
5271
- - "authorizationcode" — Authorization Code flow (browser-based user consent).
5276
+ - "authorizecode" — Authorization Code flow (browser-based user consent).
5272
5277
  Requires authURI, tokenURI, and user authorization via browser.
5273
5278
  - "clientcredentials" — Client Credentials flow (server-to-server, no user).
5274
5279
  Requires tokenURI, clientId, clientSecret.
@@ -5859,7 +5864,11 @@ components:
5859
5864
  description: |
5860
5865
  The API key or bearer token value (encrypted at rest); returned masked as `"******"`.
5861
5866
  On update, the mask sent back keeps the stored token; a new value replaces it.
5862
- Required unless automatic token refresh is configured.
5867
+ Required unless automatic token refresh is configured: a token block without a
5868
+ token must carry a `refreshMethod`, so a create or update that sends neither fails
5869
+ with 422 `Expected field: refreshMethod to be present.` To create a static-token
5870
+ connection before the real token is available, send a placeholder value and
5871
+ replace it later.
5863
5872
  examples:
5864
5873
  - my-api-token-EXAMPLE
5865
5874
  location:
@@ -8065,7 +8074,11 @@ components:
8065
8074
  description: |
8066
8075
  The API key or bearer token value (encrypted at rest); returned masked as `"******"`.
8067
8076
  On update, the mask sent back keeps the stored token; a new value replaces it.
8068
- Required unless automatic token refresh is configured.
8077
+ Required unless automatic token refresh is configured: a token block without a
8078
+ token must carry a `refreshMethod`, so a create or update that sends neither fails
8079
+ with 422 `Expected field: refreshMethod to be present.` To create a static-token
8080
+ connection before the real token is available, send a placeholder value and
8081
+ replace it later.
8069
8082
  examples:
8070
8083
  - my-api-token-EXAMPLE
8071
8084
  location: