Skip to main content
POST
Adopt a CodeGen script edited in the code repository

Authorizations

x-api-key
string
header
required

Optional API key for authentication (enabled via application.yaml)

Path Parameters

name
string
required
kind
enum<string>
required
Available options:
dataQuality,
transformation

Response

The script entry, now pinned to the head commit

A stored CodeGen script (AI data-quality rule or AI transformation).

kind
enum<string>
Available options:
dataQuality,
transformation
instruction
string
script
string | null
generatedAt
string<date-time> | null
model
string | null

The CodeGen model that wrote the script.

modelIsCurrent
boolean

False when the CodeGen model setting has changed since.

status
enum<string>
Available options:
ready,
pending
pendingReason
string | null
origin
enum<string> | null

How the current script was recorded. repository means an edit made in the code repository was adopted with the pull endpoint.

Available options:
save,
run,
regenerate,
repository
storage
string | null

Script store: minio for the built-in object store, github for the configured code repository.

repoPath
string | null

Code repository only. Path of the script file on the configured branch: <pathPrefix>pipelines/<pipeline>/data-quality.py or .../transformation.py.

commitSha
string | null

Code repository only. The commit every run executes.

drift
boolean

True when the file at the head of the configured branch differs from the recorded commit (it was edited in the repository). Runs keep using the recorded commit until the edit is pulled. Always false for built-in storage.

headSha
string

Present when drift is true. The branch-head commit the pull endpoint would record.

conflict
boolean

True while a new script was not committed because the file was edited in the code repository since the recorded commit. Runs keep executing the recorded commit, without the new instruction or schema and with no model call, until the edit is pulled or the script is regenerated with overwrite=true. Present when the script has a record.

conflictReason
string

Present when conflict is true. The warning the save or regenerate returned.