Skip to content

docs: for pull #420, fixed 1 outdated doc(s) #421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joggrbot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: for pull #420, fixed 1 outdated doc(s) #421

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 1 addition & 41 deletions docs/api/notification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ Resource Types:




ContactGroupMembershipRemoval is the Schema for the contactgroupmembershipremovals API.
It represents a removal of a Contact from a ContactGroup, it also prevents the Contact from being added to the ContactGroup.

Expand Down Expand Up @@ -88,7 +87,6 @@ It represents a removal of a Contact from a ContactGroup, it also prevents the C




<table>
<thead>
<tr>
Expand Down Expand Up @@ -120,7 +118,6 @@ It represents a removal of a Contact from a ContactGroup, it also prevents the C
<sup><sup>[↩ Parent](#contactgroupmembershipremovalspec)</sup></sup>



ContactGroupRef is a reference to the ContactGroup that the Contact does not want to be a member of.

<table>
Expand Down Expand Up @@ -154,7 +151,6 @@ ContactGroupRef is a reference to the ContactGroup that the Contact does not wan
<sup><sup>[↩ Parent](#contactgroupmembershipremovalspec)</sup></sup>



ContactRef is a reference to the Contact that prevents the Contact from being part of the ContactGroup.

<table>
Expand Down Expand Up @@ -189,8 +185,6 @@ ContactRef is a reference to the Contact that prevents the Contact from being pa





<table>
<thead>
<tr>
Expand Down Expand Up @@ -218,7 +212,6 @@ Standard condition is "Ready" which tracks contact group membership removal crea
<sup><sup>[↩ Parent](#contactgroupmembershipremovalstatus)</sup></sup>



Condition contains details for one aspect of the current state of this API Resource.

<table>
Expand Down Expand Up @@ -297,7 +290,6 @@ with respect to the current state of the instance.<br/>




ContactGroupMembership is the Schema for the contactgroupmemberships API.
It represents a membership of a Contact in a ContactGroup.

Expand Down Expand Up @@ -351,7 +343,6 @@ It represents a membership of a Contact in a ContactGroup.
<sup><sup>[↩ Parent](#contactgroupmembership)</sup></sup>



ContactGroupMembershipSpec defines the desired state of ContactGroupMembership.

<table>
Expand Down Expand Up @@ -385,7 +376,6 @@ ContactGroupMembershipSpec defines the desired state of ContactGroupMembership.
<sup><sup>[↩ Parent](#contactgroupmembershipspec)</sup></sup>



ContactGroupRef is a reference to the ContactGroup that the Contact is a member of.

<table>
Expand Down Expand Up @@ -419,7 +409,6 @@ ContactGroupRef is a reference to the ContactGroup that the Contact is a member
<sup><sup>[↩ Parent](#contactgroupmembershipspec)</sup></sup>



ContactRef is a reference to the Contact that is a member of the ContactGroup.

<table>
Expand Down Expand Up @@ -455,7 +444,6 @@ ContactRef is a reference to the Contact that is a member of the ContactGroup.




<table>
<thead>
<tr>
Expand Down Expand Up @@ -492,7 +480,6 @@ used to track the contact-group membership creation status (e.g. provider webhoo
<sup><sup>[↩ Parent](#contactgroupmembershipstatus)</sup></sup>



Condition contains details for one aspect of the current state of this API Resource.

<table>
Expand Down Expand Up @@ -571,7 +558,6 @@ with respect to the current state of the instance.<br/>




ContactGroup is the Schema for the contactgroups API.
It represents a logical grouping of Contacts.

Expand Down Expand Up @@ -623,7 +609,6 @@ It represents a logical grouping of Contacts.
<sup><sup>[↩ Parent](#contactgroup)</sup></sup>



ContactGroupSpec defines the desired state of ContactGroup.

<table>
Expand Down Expand Up @@ -663,8 +648,6 @@ ContactGroupSpec defines the desired state of ContactGroup.





<table>
<thead>
<tr>
Expand Down Expand Up @@ -701,7 +684,6 @@ used to track the contact creation status (e.g. provider webhooks).<br/>
<sup><sup>[↩ Parent](#contactgroupstatus)</sup></sup>



Condition contains details for one aspect of the current state of this API Resource.

<table>
Expand Down Expand Up @@ -780,7 +762,6 @@ with respect to the current state of the instance.<br/>




Contact is the Schema for the contacts API.
It represents a contact for a user.

Expand Down Expand Up @@ -832,7 +813,6 @@ It represents a contact for a user.
<sup><sup>[↩ Parent](#contact)</sup></sup>



ContactSpec defines the desired state of Contact.

<table>
Expand Down Expand Up @@ -880,7 +860,6 @@ ContactSpec defines the desired state of Contact.
<sup><sup>[↩ Parent](#contactspec)</sup></sup>



Subject is a reference to the subject of the contact.

<table>
Expand Down Expand Up @@ -935,7 +914,6 @@ Required for namespace-scoped resources. Omitted for cluster-scoped resources.<b




<table>
<thead>
<tr>
Expand Down Expand Up @@ -972,7 +950,6 @@ used to track the contact creation status (e.g. provider webhooks).<br/>
<sup><sup>[↩ Parent](#contactstatus)</sup></sup>



Condition contains details for one aspect of the current state of this API Resource.

<table>
Expand Down Expand Up @@ -1051,7 +1028,6 @@ with respect to the current state of the instance.<br/>




EmailBroadcast is the Schema for the emailbroadcasts API.
It represents a broadcast of an email to a set of contacts (ContactGroup).
If the broadcast needs to be updated, delete and recreate the resource.
Expand Down Expand Up @@ -1106,7 +1082,6 @@ If the broadcast needs to be updated, delete and recreate the resource.
<sup><sup>[↩ Parent](#emailbroadcast)</sup></sup>



EmailBroadcastSpec defines the desired state of EmailBroadcast.

<table>
Expand Down Expand Up @@ -1161,7 +1136,6 @@ Example: "2024-08-05T11:52:01.858Z"<br/>
<sup><sup>[↩ Parent](#emailbroadcastspec)</sup></sup>



ContactGroupRef is a reference to the ContactGroup that the email broadcast is for.

<table>
Expand Down Expand Up @@ -1195,7 +1169,6 @@ ContactGroupRef is a reference to the ContactGroup that the email broadcast is f
<sup><sup>[↩ Parent](#emailbroadcastspec)</sup></sup>



TemplateRef references the EmailTemplate to render the broadcast message.
When using the Resend provider you can include the following placeholders
in HTMLBody or TextBody; they will be substituted by the provider at send time:
Expand Down Expand Up @@ -1226,8 +1199,6 @@ in HTMLBody or TextBody; they will be substituted by the provider at send time:





<table>
<thead>
<tr>
Expand Down Expand Up @@ -1264,7 +1235,6 @@ used to track the email broadcast creation status (e.g. provider webhooks).<br/>
<sup><sup>[↩ Parent](#emailbroadcaststatus)</sup></sup>



Condition contains details for one aspect of the current state of this API Resource.

<table>
Expand Down Expand Up @@ -1343,7 +1313,6 @@ with respect to the current state of the instance.<br/>




Email is the Schema for the emails API.
It represents a concrete e-mail that should be sent to the referenced users.
For idempotency purposes, controllers can use metadata.uid as a unique identifier
Expand Down Expand Up @@ -1399,7 +1368,6 @@ Uses standard Kubernetes conditions to track both processing and delivery state.
<sup><sup>[↩ Parent](#email)</sup></sup>



EmailSpec defines the desired state of Email.
It references a template, recipients, and any variables required to render the final message.

Expand Down Expand Up @@ -1467,7 +1435,6 @@ Maximum 10 addresses.<br/>
<sup><sup>[↩ Parent](#emailspec)</sup></sup>



Recipient contain the recipient of the email.

<table>
Expand Down Expand Up @@ -1503,7 +1470,6 @@ It is mutually exclusive with EmailAddress: exactly one of them must be specifie
<sup><sup>[↩ Parent](#emailspecrecipient)</sup></sup>



UserRef references the User resource that will receive the message.
It is mutually exclusive with EmailAddress: exactly one of them must be specified.

Expand Down Expand Up @@ -1531,7 +1497,6 @@ It is mutually exclusive with EmailAddress: exactly one of them must be specifie
<sup><sup>[↩ Parent](#emailspec)</sup></sup>



TemplateRef references the EmailTemplate that should be rendered.

<table>
Expand All @@ -1558,7 +1523,6 @@ TemplateRef references the EmailTemplate that should be rendered.
<sup><sup>[↩ Parent](#emailspec)</sup></sup>



EmailVariable represents a name/value pair that will be injected into the template.

<table>
Expand Down Expand Up @@ -1632,7 +1596,6 @@ used to track the email delivery status (e.g. provider webhooks).<br/>
<sup><sup>[↩ Parent](#emailstatus)</sup></sup>



Condition contains details for one aspect of the current state of this API Resource.

<table>
Expand Down Expand Up @@ -1711,7 +1674,6 @@ with respect to the current state of the instance.<br/>




EmailTemplate is the Schema for the email templates API.
It represents a reusable e-mail template that can be rendered by substituting
the declared variables.
Expand Down Expand Up @@ -1767,7 +1729,6 @@ determine whether the template is ready for use.<br/>
<sup><sup>[↩ Parent](#emailtemplate)</sup></sup>



EmailTemplateSpec defines the desired state of EmailTemplate.
It contains the subject, content, and declared variables.

Expand Down Expand Up @@ -1816,7 +1777,6 @@ It contains the subject, content, and declared variables.
<sup><sup>[↩ Parent](#emailtemplatespec)</sup></sup>



TemplateVariable declares a variable that can be referenced in the template body or subject.
Each variable must be listed here so that callers know which parameters are expected.

Expand Down Expand Up @@ -1891,7 +1851,6 @@ determine whether the template is ready for use.
<sup><sup>[↩ Parent](#emailtemplatestatus)</sup></sup>



Condition contains details for one aspect of the current state of this API Resource.

<table>
Expand Down Expand Up @@ -1962,3 +1921,4 @@ with respect to the current state of the instance.<br/>
<td>false</td>
</tr></tbody>
</table>