Skip to content

Commit b249d2a

Browse files
JoseSzychoJoseSzycho
committed
feat: implement ContactGroupEnrollmentPolicy documentation
1 parent 820a321 commit b249d2a

2 files changed

Lines changed: 409 additions & 0 deletions

File tree

‎docs/api/notification.md‎

Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Packages:
88

99
Resource Types:
1010

11+
- [ContactGroupEnrollmentPolicy](#contactgroupenrollmentpolicy)
12+
1113
- [ContactGroupMembershipRemoval](#contactgroupmembershipremoval)
1214

1315
- [ContactGroupMembership](#contactgroupmembership)
@@ -27,6 +29,189 @@ Resource Types:
2729

2830

2931

32+
## ContactGroupEnrollmentPolicy
33+
<sup><sup>[↩ Parent](#notificationmiloapiscomv1alpha1 )</sup></sup>
34+
35+
36+
37+
38+
39+
40+
ContactGroupEnrollmentPolicy defines which ContactGroup a new Contact is automatically
41+
enrolled in when a trigger condition is met.
42+
43+
<table>
44+
<thead>
45+
<tr>
46+
<th>Name</th>
47+
<th>Type</th>
48+
<th>Description</th>
49+
<th>Required</th>
50+
</tr>
51+
</thead>
52+
<tbody><tr>
53+
<td><b>apiVersion</b></td>
54+
<td>string</td>
55+
<td>notification.miloapis.com/v1alpha1</td>
56+
<td>true</td>
57+
</tr>
58+
<tr>
59+
<td><b>kind</b></td>
60+
<td>string</td>
61+
<td>ContactGroupEnrollmentPolicy</td>
62+
<td>true</td>
63+
</tr>
64+
<tr>
65+
<td><b><a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta">metadata</a></b></td>
66+
<td>object</td>
67+
<td>Refer to the Kubernetes API documentation for the fields of the `metadata` field.</td>
68+
<td>true</td>
69+
</tr><tr>
70+
<td><b><a href="#contactgroupenrollmentpolicyspec">spec</a></b></td>
71+
<td>object</td>
72+
<td>
73+
ContactGroupEnrollmentPolicySpec defines the desired enrollment behavior.<br/>
74+
</td>
75+
<td>false</td>
76+
</tr></tbody>
77+
</table>
78+
79+
80+
### ContactGroupEnrollmentPolicy.spec
81+
<sup><sup>[↩ Parent](#contactgroupenrollmentpolicy)</sup></sup>
82+
83+
84+
85+
ContactGroupEnrollmentPolicySpec defines the desired enrollment behavior.
86+
87+
<table>
88+
<thead>
89+
<tr>
90+
<th>Name</th>
91+
<th>Type</th>
92+
<th>Description</th>
93+
<th>Required</th>
94+
</tr>
95+
</thead>
96+
<tbody><tr>
97+
<td><b><a href="#contactgroupenrollmentpolicyspeccontactgroupref">contactGroupRef</a></b></td>
98+
<td>object</td>
99+
<td>
100+
ContactGroupRef references the ContactGroup that matching Contacts are enrolled in.<br/>
101+
</td>
102+
<td>true</td>
103+
</tr><tr>
104+
<td><b><a href="#contactgroupenrollmentpolicyspectrigger">trigger</a></b></td>
105+
<td>object</td>
106+
<td>
107+
Trigger defines when enrollment happens.<br/>
108+
</td>
109+
<td>true</td>
110+
</tr><tr>
111+
<td><b><a href="#contactgroupenrollmentpolicyspeccontactselector">contactSelector</a></b></td>
112+
<td>object</td>
113+
<td>
114+
ContactSelector filters which Contacts this policy applies to.
115+
If omitted, the policy applies to all Contacts.<br/>
116+
</td>
117+
<td>false</td>
118+
</tr></tbody>
119+
</table>
120+
121+
122+
### ContactGroupEnrollmentPolicy.spec.contactGroupRef
123+
<sup><sup>[↩ Parent](#contactgroupenrollmentpolicyspec)</sup></sup>
124+
125+
126+
127+
ContactGroupRef references the ContactGroup that matching Contacts are enrolled in.
128+
129+
<table>
130+
<thead>
131+
<tr>
132+
<th>Name</th>
133+
<th>Type</th>
134+
<th>Description</th>
135+
<th>Required</th>
136+
</tr>
137+
</thead>
138+
<tbody><tr>
139+
<td><b>name</b></td>
140+
<td>string</td>
141+
<td>
142+
Name is the name of the ContactGroup.<br/>
143+
</td>
144+
<td>true</td>
145+
</tr><tr>
146+
<td><b>namespace</b></td>
147+
<td>string</td>
148+
<td>
149+
Namespace is the namespace of the ContactGroup.<br/>
150+
</td>
151+
<td>true</td>
152+
</tr></tbody>
153+
</table>
154+
155+
156+
### ContactGroupEnrollmentPolicy.spec.trigger
157+
<sup><sup>[↩ Parent](#contactgroupenrollmentpolicyspec)</sup></sup>
158+
159+
160+
161+
Trigger defines when enrollment happens.
162+
163+
<table>
164+
<thead>
165+
<tr>
166+
<th>Name</th>
167+
<th>Type</th>
168+
<th>Description</th>
169+
<th>Required</th>
170+
</tr>
171+
</thead>
172+
<tbody><tr>
173+
<td><b>type</b></td>
174+
<td>enum</td>
175+
<td>
176+
Type is the event that triggers enrollment.
177+
ContactCreated fires when a new Contact resource is created.<br/>
178+
<br/>
179+
<i>Enum</i>: ContactCreated<br/>
180+
</td>
181+
<td>true</td>
182+
</tr></tbody>
183+
</table>
184+
185+
186+
### ContactGroupEnrollmentPolicy.spec.contactSelector
187+
<sup><sup>[↩ Parent](#contactgroupenrollmentpolicyspec)</sup></sup>
188+
189+
190+
191+
ContactSelector filters which Contacts this policy applies to.
192+
If omitted, the policy applies to all Contacts.
193+
194+
<table>
195+
<thead>
196+
<tr>
197+
<th>Name</th>
198+
<th>Type</th>
199+
<th>Description</th>
200+
<th>Required</th>
201+
</tr>
202+
</thead>
203+
<tbody><tr>
204+
<td><b>subjectKind</b></td>
205+
<td>enum</td>
206+
<td>
207+
SubjectKind restricts enrollment to Contacts whose SubjectRef.Kind matches this value.<br/>
208+
<br/>
209+
<i>Enum</i>: User<br/>
210+
</td>
211+
<td>false</td>
212+
</tr></tbody>
213+
</table>
214+
30215
## ContactGroupMembershipRemoval
31216
<sup><sup>[↩ Parent](#notificationmiloapiscomv1alpha1 )</sup></sup>
32217

0 commit comments

Comments
 (0)