Skip to content

Commit

Permalink
chore(update-cloud-events): update api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
VaibhavPage committed Dec 20, 2019
1 parent c580a25 commit 9166092
Show file tree
Hide file tree
Showing 7 changed files with 317 additions and 226 deletions.
2 changes: 1 addition & 1 deletion api/event-source.html
Expand Up @@ -1751,5 +1751,5 @@ <h3 id="argoproj.io/v1alpha1.StorageGridFilter">StorageGridFilter
<hr/>
<p><em>
Generated with <code>gen-crd-api-reference-docs</code>
on git commit <code>8d85191</code>.
on git commit <code>c580a25</code>.
</em></p>
2 changes: 1 addition & 1 deletion api/event-source.md
Expand Up @@ -3484,6 +3484,6 @@ Description
<p>

<em> Generated with <code>gen-crd-api-reference-docs</code> on git
commit <code>8d85191</code>. </em>
commit <code>c580a25</code>. </em>

</p>
2 changes: 1 addition & 1 deletion api/gateway.html
Expand Up @@ -727,5 +727,5 @@ <h3 id="argoproj.io/v1alpha1.SensorNotificationWatcher">SensorNotificationWatche
<hr/>
<p><em>
Generated with <code>gen-crd-api-reference-docs</code>
on git commit <code>8d85191</code>.
on git commit <code>c580a25</code>.
</em></p>
2 changes: 1 addition & 1 deletion api/gateway.md
Expand Up @@ -1446,6 +1446,6 @@ Namespace of the sensor
<p>

<em> Generated with <code>gen-crd-api-reference-docs</code> on git
commit <code>8d85191</code>. </em>
commit <code>c580a25</code>. </em>

</p>
191 changes: 110 additions & 81 deletions api/sensor.html
Expand Up @@ -119,10 +119,6 @@ <h3 id="argoproj.io/v1alpha1.ArtifactLocation">ArtifactLocation
<h3 id="argoproj.io/v1alpha1.Backoff">Backoff
</h3>
<p>
(<em>Appears on:</em>
<a href="#argoproj.io/v1alpha1.TriggerPolicy">TriggerPolicy</a>)
</p>
<p>
<p>Backoff for an operation</p>
</p>
<table>
Expand Down Expand Up @@ -365,26 +361,37 @@ <h3 id="argoproj.io/v1alpha1.EventDependency">EventDependency
</tr>
<tr>
<td>
<code>filters</code></br>
<code>gatewayName</code></br>
<em>
<a href="#argoproj.io/v1alpha1.EventDependencyFilter">
EventDependencyFilter
</a>
string
</em>
</td>
<td>
<p>Filters and rules governing tolerations of success and constraints on the context and data of an event</p>
<p>GatewayName is the name of the gateway from whom the event is received</p>
</td>
</tr>
<tr>
<td>
<code>connected</code></br>
<code>eventName</code></br>
<em>
bool
string
</em>
</td>
<td>
<p>Connected tells if subscription is already setup in case of nats protocol.</p>
<p>EventName is the name of the event</p>
</td>
</tr>
<tr>
<td>
<code>filters</code></br>
<em>
<a href="#argoproj.io/v1alpha1.EventDependencyFilter">
EventDependencyFilter
</a>
</em>
</td>
<td>
<p>Filters and rules governing toleration of success and constraints on the context and data of an event</p>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -438,7 +445,7 @@ <h3 id="argoproj.io/v1alpha1.EventDependencyFilter">EventDependencyFilter
</em>
</td>
<td>
<p>Context filter constraints with escalation</p>
<p>Context filter constraints</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -875,6 +882,36 @@ <h3 id="argoproj.io/v1alpha1.NotificationType">NotificationType
<p>
<p>NotificationType represent a type of notifications that are handled by a sensor</p>
</p>
<h3 id="argoproj.io/v1alpha1.ResourceLabelsPolicy">ResourceLabelsPolicy
</h3>
<p>
(<em>Appears on:</em>
<a href="#argoproj.io/v1alpha1.TriggerPolicy">TriggerPolicy</a>)
</p>
<p>
<p>ResourceLabels refers to the policy used to check the resource state using labels</p>
</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>labels</code></br>
<em>
map[string]string
</em>
</td>
<td>
<p>Labels required to identify whether a resource is in success state</p>
</td>
</tr>
</tbody>
</table>
<h3 id="argoproj.io/v1alpha1.Sensor">Sensor
</h3>
<p>
Expand Down Expand Up @@ -967,6 +1004,18 @@ <h3 id="argoproj.io/v1alpha1.Sensor">Sensor
</tr>
<tr>
<td>
<code>port</code></br>
<em>
int
</em>
</td>
<td>
<em>(Optional)</em>
<p>Port on which sensor server should run.</p>
</td>
</tr>
<tr>
<td>
<code>circuit</code></br>
<em>
string
Expand Down Expand Up @@ -1133,6 +1182,18 @@ <h3 id="argoproj.io/v1alpha1.SensorSpec">SensorSpec
</tr>
<tr>
<td>
<code>port</code></br>
<em>
int
</em>
</td>
<td>
<em>(Optional)</em>
<p>Port on which sensor server should run.</p>
</td>
</tr>
<tr>
<td>
<code>circuit</code></br>
<em>
string
Expand Down Expand Up @@ -1421,48 +1482,6 @@ <h3 id="argoproj.io/v1alpha1.Trigger">Trigger
</tr>
</tbody>
</table>
<h3 id="argoproj.io/v1alpha1.TriggerCondition">TriggerCondition
</h3>
<p>
(<em>Appears on:</em>
<a href="#argoproj.io/v1alpha1.TriggerTemplate">TriggerTemplate</a>)
</p>
<p>
<p>TriggerCondition describes condition which must be satisfied in order to execute a trigger.
Depending upon condition type, status of dependency groups is used to evaluate the result.</p>
</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>any</code></br>
<em>
[]string
</em>
</td>
<td>
<p>Any acts as a OR operator between dependencies</p>
</td>
</tr>
<tr>
<td>
<code>all</code></br>
<em>
[]string
</em>
</td>
<td>
<p>All acts as a AND operator between dependencies</p>
</td>
</tr>
</tbody>
</table>
<h3 id="argoproj.io/v1alpha1.TriggerCycleState">TriggerCycleState
(<code>string</code> alias)</p></h3>
<p>
Expand Down Expand Up @@ -1572,7 +1591,7 @@ <h3 id="argoproj.io/v1alpha1.TriggerParameterSource">TriggerParameterSource
</tr>
<tr>
<td>
<code>path</code></br>
<code>contextKey</code></br>
<em>
string
</em>
Expand All @@ -1586,6 +1605,16 @@ <h3 id="argoproj.io/v1alpha1.TriggerParameterSource">TriggerParameterSource
</tr>
<tr>
<td>
<code>dataKey</code></br>
<em>
string
</em>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>value</code></br>
<em>
string
Expand Down Expand Up @@ -1620,9 +1649,7 @@ <h3 id="argoproj.io/v1alpha1.TriggerPolicy">TriggerPolicy
<td>
<code>backoff</code></br>
<em>
<a href="#argoproj.io/v1alpha1.Backoff">
Backoff
</a>
k8s.io/apimachinery/pkg/util/wait.Backoff
</em>
</td>
<td>
Expand All @@ -1631,38 +1658,40 @@ <h3 id="argoproj.io/v1alpha1.TriggerPolicy">TriggerPolicy
</tr>
<tr>
<td>
<code>state</code></br>
<code>errorOnBackoffTimeout</code></br>
<em>
<a href="#argoproj.io/v1alpha1.TriggerStateLabels">
TriggerStateLabels
</a>
bool
</em>
</td>
<td>
<p>State refers to labels used to check the resource state</p>
<p>ErrorOnBackoffTimeout determines whether sensor should transition to error state if the trigger policy is unable to determine
the state of the resource</p>
</td>
</tr>
<tr>
<td>
<code>errorOnBackoffTimeout</code></br>
<code>resourceLabels</code></br>
<em>
bool
<a href="#argoproj.io/v1alpha1.ResourceLabelsPolicy">
ResourceLabelsPolicy
</a>
</em>
</td>
<td>
<p>ErrorOnBackoffTimeout determines whether sensor should transition to error state if the backoff times out and yet the resource neither transitioned into success or failure.</p>
<p>ResourceLabels refers to the policy used to check the resource state using labels</p>
</td>
</tr>
</tbody>
</table>
<h3 id="argoproj.io/v1alpha1.TriggerStateLabels">TriggerStateLabels
<h3 id="argoproj.io/v1alpha1.TriggerSwitch">TriggerSwitch
</h3>
<p>
(<em>Appears on:</em>
<a href="#argoproj.io/v1alpha1.TriggerPolicy">TriggerPolicy</a>)
<a href="#argoproj.io/v1alpha1.TriggerTemplate">TriggerTemplate</a>)
</p>
<p>
<p>TriggerStateLabels defines the labels used to decide if a resource is in success or failure state.</p>
<p>TriggerSwitch describes condition which must be satisfied in order to execute a trigger.
Depending upon condition type, status of dependency groups is used to evaluate the result.</p>
</p>
<table>
<thead>
Expand All @@ -1674,24 +1703,24 @@ <h3 id="argoproj.io/v1alpha1.TriggerStateLabels">TriggerStateLabels
<tbody>
<tr>
<td>
<code>success</code></br>
<code>any</code></br>
<em>
map[string]string
[]string
</em>
</td>
<td>
<p>Success defines labels required to identify a resource in success state</p>
<p>Any acts as a OR operator between dependencies</p>
</td>
</tr>
<tr>
<td>
<code>failure</code></br>
<code>all</code></br>
<em>
map[string]string
[]string
</em>
</td>
<td>
<p>Failure defines labels required to identify a resource in failed state</p>
<p>All acts as a AND operator between dependencies</p>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -1726,15 +1755,15 @@ <h3 id="argoproj.io/v1alpha1.TriggerTemplate">TriggerTemplate
</tr>
<tr>
<td>
<code>when</code></br>
<code>switch</code></br>
<em>
<a href="#argoproj.io/v1alpha1.TriggerCondition">
TriggerCondition
<a href="#argoproj.io/v1alpha1.TriggerSwitch">
TriggerSwitch
</a>
</em>
</td>
<td>
<p>When is the condition to execute the trigger</p>
<p>Switch is the condition to execute the trigger</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -1812,5 +1841,5 @@ <h3 id="argoproj.io/v1alpha1.URLArtifact">URLArtifact
<hr/>
<p><em>
Generated with <code>gen-crd-api-reference-docs</code>
on git commit <code>8d85191</code>.
on git commit <code>c580a25</code>.
</em></p>

0 comments on commit 9166092

Please sign in to comment.