Skip to content

Commit

Permalink
API docs for v0.5.0 release (#1142)
Browse files Browse the repository at this point in the history
  • Loading branch information
@RichieEscarez
RichieEscarez authored Apr 6, 2019
1 parent f437aa4 commit 8561954
Show file tree
Hide file tree
Showing 4 changed files with 643 additions and 82 deletions.
33 changes: 17 additions & 16 deletions docs/reference/build.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -740,6 +740,21 @@ BuildSpecStatus
<tbody>
<tr>
<td>
<code>Status</code></br>
<em>
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Status">
github.com/knative/pkg/apis/duck/v1alpha1.Status
</a>
</em>
</td>
<td>
<p>
(Members of <code>Status</code> are embedded into this type.)
</p>
</td>
</tr>
<tr>
<td>
<code>builder</code></br>
<em>
<a href="#BuildProvider">
Expand Down Expand Up @@ -833,20 +848,6 @@ Kubernetes meta/v1.Time
<p>StepsCompleted lists the name of build steps completed.</p>
</td>
</tr>
<tr>
<td>
<code>conditions</code></br>
<em>
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Conditions">
github.com/knative/pkg/apis/duck/v1alpha1.Conditions
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Conditions describes the set of conditions of this build.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="BuildTemplateInterface">BuildTemplateInterface
Expand All @@ -858,7 +859,7 @@ github.com/knative/pkg/apis/duck/v1alpha1.Conditions
</h3>
<p>
(<em>Appears on:</em>
<a href="#BuildTemplate">BuildTemplate</a>,
<a href="#BuildTemplate">BuildTemplate</a>,
<a href="#ClusterBuildTemplate">ClusterBuildTemplate</a>)
</p>
<p>
Expand Down Expand Up @@ -1352,5 +1353,5 @@ This will override any of the template&rsquo;s steps environment variables.</p>
<hr/>
<p><em>
Generated with <code>gen-crd-api-reference-docs</code>
on git commit <code>ee63efc</code>.
on git commit <code>4fc8663f</code>.
</em></p>
120 changes: 94 additions & 26 deletions docs/reference/eventing/eventing-sources.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -550,6 +550,30 @@ Kubernetes core/v1.ObjectReference
name to use as the sink.</p>
</td>
</tr>
<tr>
<td>
<code>githubAPIURL</code></br>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>API URL if using github enterprise (default <a href="https://api.github.com">https://api.github.com</a>)</p>
</td>
</tr>
<tr>
<td>
<code>secure</code></br>
<em>
bool
</em>
</td>
<td>
<em>(Optional)</em>
<p>Secure can be set to true to configure the webhook to use https.</p>
</td>
</tr>
</table>
</td>
</tr>
Expand Down Expand Up @@ -769,16 +793,20 @@ run the Receive Adapter Deployment.</p>
<tbody>
<tr>
<td>
<code>conditions</code></br>
<code>Status</code></br>
<em>
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Conditions">
github.com/knative/pkg/apis/duck/v1alpha1.Conditions
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Status">
github.com/knative/pkg/apis/duck/v1alpha1.Status
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Conditions holds the state of a source at a point in time.</p>
<p>
(Members of <code>Status</code> are embedded into this type.)
</p>
<p>inherits duck/v1alpha1 Status, which currently provides:
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -897,16 +925,20 @@ Kubernetes core/v1.ObjectReference
<tbody>
<tr>
<td>
<code>conditions</code></br>
<code>Status</code></br>
<em>
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Conditions">
github.com/knative/pkg/apis/duck/v1alpha1.Conditions
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Status">
github.com/knative/pkg/apis/duck/v1alpha1.Status
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Conditions holds the state of a source at a point in time.</p>
<p>
(Members of <code>Status</code> are embedded into this type.)
</p>
<p>inherits duck/v1alpha1 Status, which currently provides:
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -1009,16 +1041,20 @@ Adapter Deployment.</p>
<tbody>
<tr>
<td>
<code>conditions</code></br>
<code>Status</code></br>
<em>
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Conditions">
github.com/knative/pkg/apis/duck/v1alpha1.Conditions
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Status">
github.com/knative/pkg/apis/duck/v1alpha1.Status
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Conditions holds the state of a source at a point in time.</p>
<p>
(Members of <code>Status</code> are embedded into this type.)
</p>
<p>inherits duck/v1alpha1 Status, which currently provides:
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -1140,6 +1176,30 @@ Kubernetes core/v1.ObjectReference
name to use as the sink.</p>
</td>
</tr>
<tr>
<td>
<code>githubAPIURL</code></br>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>API URL if using github enterprise (default <a href="https://api.github.com">https://api.github.com</a>)</p>
</td>
</tr>
<tr>
<td>
<code>secure</code></br>
<em>
bool
</em>
</td>
<td>
<em>(Optional)</em>
<p>Secure can be set to true to configure the webhook to use https.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="GitHubSourceStatus">GitHubSourceStatus
Expand All @@ -1161,16 +1221,20 @@ name to use as the sink.</p>
<tbody>
<tr>
<td>
<code>conditions</code></br>
<code>Status</code></br>
<em>
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Conditions">
github.com/knative/pkg/apis/duck/v1alpha1.Conditions
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Status">
github.com/knative/pkg/apis/duck/v1alpha1.Status
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Conditions holds the state of a source at a point in time.</p>
<p>
(Members of <code>Status</code> are embedded into this type.)
</p>
<p>inherits duck/v1alpha1 Status, which currently provides:
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -1276,16 +1340,20 @@ as the sink.</p>
<tbody>
<tr>
<td>
<code>conditions</code></br>
<code>Status</code></br>
<em>
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Conditions">
github.com/knative/pkg/apis/duck/v1alpha1.Conditions
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Status">
github.com/knative/pkg/apis/duck/v1alpha1.Status
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Conditions holds the state of a source at a point in time.</p>
<p>
(Members of <code>Status</code> are embedded into this type.)
</p>
<p>inherits duck/v1alpha1 Status, which currently provides:
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -1337,5 +1405,5 @@ Kubernetes core/v1.SecretKeySelector
<hr/>
<p><em>
Generated with <code>gen-crd-api-reference-docs</code>
on git commit <code>2efe55e1</code>.
on git commit <code>32ce3778</code>.
</em></p>
Loading

0 comments on commit 8561954

Please sign in to comment.