Skip to content

Commit 42fccb2

Browse files
Update docs for operator (#315)
Co-authored-by: michaeljguarino <[email protected]>
1 parent 114427d commit 42fccb2

File tree

1 file changed

+34
-0
lines changed
  • pages/deployments/operator

1 file changed

+34
-0
lines changed

pages/deployments/operator/api.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1758,6 +1758,23 @@ _Appears in:_
17581758
| `json` _boolean_ | Whether the string value is supposed to be json-encoded | | Optional: {} <br /> |
17591759

17601760

1761+
#### PrAutomationConfirmation
1762+
1763+
1764+
1765+
Additional details to verify all prerequisites are satisfied before generating this pr
1766+
1767+
1768+
1769+
_Appears in:_
1770+
- [PrAutomationSpec](#prautomationspec)
1771+
1772+
| Field | Description | Default | Validation |
1773+
| --- | --- | --- | --- |
1774+
| `text` _string_ | Markdown text to explain this pr | | Optional: {} <br /> |
1775+
| `checklist` _[PrConfirmationChecklist](#prconfirmationchecklist) array_ | An itemized checklist to present to confirm each prerequisite is satisfied | | Optional: {} <br /> |
1776+
1777+
17611778
#### PrAutomationCreateConfiguration
17621779

17631780

@@ -1822,6 +1839,7 @@ _Appears in:_
18221839
| `projectRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ProjectRef the project this automation belongs to. | | Optional: {} <br /> |
18231840
| `bindings` _[PrAutomationBindings](#prautomationbindings)_ | Bindings contain read and write policies of pr automation | | Optional: {} <br /> |
18241841
| `configuration` _[PrAutomationConfiguration](#prautomationconfiguration) array_ | Configuration self-service configuration for the UI wizard generating this PR | | Optional: {} <br /> |
1842+
| `confirmation` _[PrAutomationConfirmation](#prautomationconfirmation)_ | Additional details to verify all prerequisites are satisfied before generating this pr | | Optional: {} <br /> |
18251843
| `creates` _[PrAutomationCreateConfiguration](#prautomationcreateconfiguration)_ | Specs for files to be templated and created | | Optional: {} <br /> |
18261844
| `updates` _[PrAutomationUpdateConfiguration](#prautomationupdateconfiguration)_ | Spec for files to be updated, using regex replacement | | Optional: {} <br /> |
18271845
| `deletes` _[PrAutomationDeleteConfiguration](#prautomationdeleteconfiguration)_ | Spec for files and folders to be deleted | | Optional: {} <br /> |
@@ -1902,6 +1920,22 @@ _Appears in:_
19021920
| `yq` _string_ | (Unused so far) | | Optional: {} <br /> |
19031921

19041922

1923+
#### PrConfirmationChecklist
1924+
1925+
1926+
1927+
A checkbox to render to confirm a PR prerequisite is satisfied
1928+
1929+
1930+
1931+
_Appears in:_
1932+
- [PrAutomationConfirmation](#prautomationconfirmation)
1933+
1934+
| Field | Description | Default | Validation |
1935+
| --- | --- | --- | --- |
1936+
| `label` _string_ | The label of this checkbox | | |
1937+
1938+
19051939
#### Project
19061940

19071941

0 commit comments

Comments
 (0)