Skip to content
This repository was archived by the owner on May 5, 2025. It is now read-only.

Commit 53a56f1

Browse files
odacremolbapodacremolbap
committed
add Triggermesh sources + targets APIs
1 parent a3c031f commit 53a56f1

File tree

7 files changed

+7976
-1
lines changed

7 files changed

+7976
-1
lines changed

‎docs/apis/awseventbridge-target.md

Lines changed: 260 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,260 @@
1+
<style>
2+
.bs-sidebar {
3+
display: none;
4+
}
5+
</style>
6+
<p>Packages:</p>
7+
<ul>
8+
<li>
9+
<a href="#targets.triggermesh.io%2fv1alpha1">targets.triggermesh.io/v1alpha1</a>
10+
</li>
11+
</ul>
12+
<h2 id="targets.triggermesh.io/v1alpha1">targets.triggermesh.io/v1alpha1</h2>
13+
<p>
14+
<p>Package v1alpha1 contains API Schema definitions for the targets/v1alpha1 API group.</p>
15+
</p>
16+
Resource Types:
17+
<ul><li>
18+
<a href="#targets.triggermesh.io/v1alpha1.AWSEventBridgeTarget">AWSEventBridgeTarget</a>
19+
</li></ul>
20+
<h3 id="targets.triggermesh.io/v1alpha1.AWSEventBridgeTarget">AWSEventBridgeTarget
21+
</h3>
22+
<p>
23+
<p>AWSEventBridgeTarget is the Schema for the event target.</p>
24+
</p>
25+
<table>
26+
<thead>
27+
<tr>
28+
<th>Field</th>
29+
<th>Description</th>
30+
</tr>
31+
</thead>
32+
<tbody>
33+
<tr>
34+
<td>
35+
<code>apiVersion</code></br>
36+
string</td>
37+
<td>
38+
<code>
39+
targets.triggermesh.io/v1alpha1
40+
</code>
41+
</td>
42+
</tr>
43+
<tr>
44+
<td>
45+
<code>kind</code></br>
46+
string
47+
</td>
48+
<td><code>AWSEventBridgeTarget</code></td>
49+
</tr>
50+
<tr>
51+
<td>
52+
<code>metadata</code></br>
53+
<em>
54+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
55+
Kubernetes meta/v1.ObjectMeta
56+
</a>
57+
</em>
58+
</td>
59+
<td>
60+
Refer to the Kubernetes API documentation for the fields of the
61+
<code>metadata</code> field.
62+
</td>
63+
</tr>
64+
<tr>
65+
<td>
66+
<code>spec</code></br>
67+
<em>
68+
<a href="#targets.triggermesh.io/v1alpha1.AWSEventBridgeTargetSpec">
69+
AWSEventBridgeTargetSpec
70+
</a>
71+
</em>
72+
</td>
73+
<td>
74+
<br/>
75+
<br/>
76+
<table>
77+
<tr>
78+
<td>
79+
<code>accountID</code></br>
80+
<em>
81+
string
82+
</em>
83+
</td>
84+
<td>
85+
<p>ID of the AWS account to send events to.</p>
86+
</td>
87+
</tr>
88+
<tr>
89+
<td>
90+
<code>region</code></br>
91+
<em>
92+
string
93+
</em>
94+
</td>
95+
<td>
96+
<p>Name of the AWS region where the partner event source is located.</p>
97+
</td>
98+
</tr>
99+
</table>
100+
</td>
101+
</tr>
102+
<tr>
103+
<td>
104+
<code>status</code></br>
105+
<em>
106+
<a href="#targets.triggermesh.io/v1alpha1.AWSEventBridgeTargetStatus">
107+
AWSEventBridgeTargetStatus
108+
</a>
109+
</em>
110+
</td>
111+
<td>
112+
</td>
113+
</tr>
114+
</tbody>
115+
</table>
116+
<h3 id="targets.triggermesh.io/v1alpha1.AWSEventBridgeTargetSpec">AWSEventBridgeTargetSpec
117+
</h3>
118+
<p>
119+
(<em>Appears on:</em>
120+
<a href="#targets.triggermesh.io/v1alpha1.AWSEventBridgeTarget">AWSEventBridgeTarget</a>)
121+
</p>
122+
<p>
123+
<p>AWSEventBridgeTargetSpec defines the desired state of the event target.</p>
124+
</p>
125+
<table>
126+
<thead>
127+
<tr>
128+
<th>Field</th>
129+
<th>Description</th>
130+
</tr>
131+
</thead>
132+
<tbody>
133+
<tr>
134+
<td>
135+
<code>accountID</code></br>
136+
<em>
137+
string
138+
</em>
139+
</td>
140+
<td>
141+
<p>ID of the AWS account to send events to.</p>
142+
</td>
143+
</tr>
144+
<tr>
145+
<td>
146+
<code>region</code></br>
147+
<em>
148+
string
149+
</em>
150+
</td>
151+
<td>
152+
<p>Name of the AWS region where the partner event source is located.</p>
153+
</td>
154+
</tr>
155+
</tbody>
156+
</table>
157+
<h3 id="targets.triggermesh.io/v1alpha1.AWSEventBridgeTargetStatus">AWSEventBridgeTargetStatus
158+
</h3>
159+
<p>
160+
(<em>Appears on:</em>
161+
<a href="#targets.triggermesh.io/v1alpha1.AWSEventBridgeTarget">AWSEventBridgeTarget</a>)
162+
</p>
163+
<p>
164+
<p>AWSEventBridgeTargetStatus defines the observed state of the event target.</p>
165+
</p>
166+
<table>
167+
<thead>
168+
<tr>
169+
<th>Field</th>
170+
<th>Description</th>
171+
</tr>
172+
</thead>
173+
<tbody>
174+
<tr>
175+
<td>
176+
<code>Status</code></br>
177+
<em>
178+
knative.dev/pkg/apis/duck/v1.Status
179+
</em>
180+
</td>
181+
<td>
182+
<p>
183+
(Members of <code>Status</code> are embedded into this type.)
184+
</p>
185+
</td>
186+
</tr>
187+
<tr>
188+
<td>
189+
<code>AddressStatus</code></br>
190+
<em>
191+
knative.dev/pkg/apis/duck/v1.AddressStatus
192+
</em>
193+
</td>
194+
<td>
195+
<p>
196+
(Members of <code>AddressStatus</code> are embedded into this type.)
197+
</p>
198+
</td>
199+
</tr>
200+
<tr>
201+
<td>
202+
<code>partnerEventSource</code></br>
203+
<em>
204+
<a href="#targets.triggermesh.io/v1alpha1.PartnerEventSource">
205+
PartnerEventSource
206+
</a>
207+
</em>
208+
</td>
209+
<td>
210+
<p>Description of the partner event source associated with the target.</p>
211+
</td>
212+
</tr>
213+
</tbody>
214+
</table>
215+
<h3 id="targets.triggermesh.io/v1alpha1.PartnerEventSource">PartnerEventSource
216+
</h3>
217+
<p>
218+
(<em>Appears on:</em>
219+
<a href="#targets.triggermesh.io/v1alpha1.AWSEventBridgeTargetStatus">AWSEventBridgeTargetStatus</a>)
220+
</p>
221+
<p>
222+
<p>PartnerEventSource contains details about a partner event source.</p>
223+
</p>
224+
<table>
225+
<thead>
226+
<tr>
227+
<th>Field</th>
228+
<th>Description</th>
229+
</tr>
230+
</thead>
231+
<tbody>
232+
<tr>
233+
<td>
234+
<code>name</code></br>
235+
<em>
236+
string
237+
</em>
238+
</td>
239+
<td>
240+
<p>Name of the partner event source</p>
241+
</td>
242+
</tr>
243+
<tr>
244+
<td>
245+
<code>state</code></br>
246+
<em>
247+
string
248+
</em>
249+
</td>
250+
<td>
251+
<p>State of the partner event source</p>
252+
</td>
253+
</tr>
254+
</tbody>
255+
</table>
256+
<hr/>
257+
<p><em>
258+
Generated with <code>gen-crd-api-reference-docs</code>
259+
on git commit <code>c4da90f</code>.
260+
</em></p>

‎docs/apis/index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Triggermesh APIs
2+
3+
Triggermesh is built on top of Knative API, which you can use with your credentials.
4+
Knative API is [documented at the project](https://knative.dev/docs/reference/api/).
5+
6+
## TriggerMesh Sources API
7+
8+
* [Triggermesh Public Sources](./public-sources.md).
9+
* [Triggermesh Sources](./private-sources.md).
10+
11+
## TriggerMesh Targets API
12+
13+
* [Triggermesh Targets](./private-targets.md).
14+
* [Triggermesh AWS Eventbridge target](./awseventbridge-target.md).
15+

0 commit comments

Comments
 (0)