diff --git a/pages/deployments/operator/api.md b/pages/deployments/operator/api.md index 1a6dfbe5..877ca7a3 100644 --- a/pages/deployments/operator/api.md +++ b/pages/deployments/operator/api.md @@ -1758,6 +1758,23 @@ _Appears in:_ | `json` _boolean_ | Whether the string value is supposed to be json-encoded | | Optional: {}
| +#### PrAutomationConfirmation + + + +Additional details to verify all prerequisites are satisfied before generating this pr + + + +_Appears in:_ +- [PrAutomationSpec](#prautomationspec) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `text` _string_ | Markdown text to explain this pr | | Optional: {}
| +| `checklist` _[PrConfirmationChecklist](#prconfirmationchecklist) array_ | An itemized checklist to present to confirm each prerequisite is satisfied | | Optional: {}
| + + #### PrAutomationCreateConfiguration @@ -1822,6 +1839,7 @@ _Appears in:_ | `projectRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ProjectRef the project this automation belongs to. | | Optional: {}
| | `bindings` _[PrAutomationBindings](#prautomationbindings)_ | Bindings contain read and write policies of pr automation | | Optional: {}
| | `configuration` _[PrAutomationConfiguration](#prautomationconfiguration) array_ | Configuration self-service configuration for the UI wizard generating this PR | | Optional: {}
| +| `confirmation` _[PrAutomationConfirmation](#prautomationconfirmation)_ | Additional details to verify all prerequisites are satisfied before generating this pr | | Optional: {}
| | `creates` _[PrAutomationCreateConfiguration](#prautomationcreateconfiguration)_ | Specs for files to be templated and created | | Optional: {}
| | `updates` _[PrAutomationUpdateConfiguration](#prautomationupdateconfiguration)_ | Spec for files to be updated, using regex replacement | | Optional: {}
| | `deletes` _[PrAutomationDeleteConfiguration](#prautomationdeleteconfiguration)_ | Spec for files and folders to be deleted | | Optional: {}
| @@ -1902,6 +1920,22 @@ _Appears in:_ | `yq` _string_ | (Unused so far) | | Optional: {}
| +#### PrConfirmationChecklist + + + +A checkbox to render to confirm a PR prerequisite is satisfied + + + +_Appears in:_ +- [PrAutomationConfirmation](#prautomationconfirmation) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `label` _string_ | The label of this checkbox | | | + + #### Project