Skip to content

Commit 8561954

Browse files
RichieEscarezRichieEscarez
authored
API docs for v0.5.0 release (#1142)
1 parent f437aa4 commit 8561954

File tree

4 files changed

+643
-82
lines changed

4 files changed

+643
-82
lines changed

‎docs/reference/build.md‎

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -740,6 +740,21 @@ BuildSpecStatus
740740
<tbody>
741741
<tr>
742742
<td>
743+
<code>Status</code></br>
744+
<em>
745+
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Status">
746+
github.com/knative/pkg/apis/duck/v1alpha1.Status
747+
</a>
748+
</em>
749+
</td>
750+
<td>
751+
<p>
752+
(Members of <code>Status</code> are embedded into this type.)
753+
</p>
754+
</td>
755+
</tr>
756+
<tr>
757+
<td>
743758
<code>builder</code></br>
744759
<em>
745760
<a href="#BuildProvider">
@@ -833,20 +848,6 @@ Kubernetes meta/v1.Time
833848
<p>StepsCompleted lists the name of build steps completed.</p>
834849
</td>
835850
</tr>
836-
<tr>
837-
<td>
838-
<code>conditions</code></br>
839-
<em>
840-
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Conditions">
841-
github.com/knative/pkg/apis/duck/v1alpha1.Conditions
842-
</a>
843-
</em>
844-
</td>
845-
<td>
846-
<em>(Optional)</em>
847-
<p>Conditions describes the set of conditions of this build.</p>
848-
</td>
849-
</tr>
850851
</tbody>
851852
</table>
852853
<h3 id="BuildTemplateInterface">BuildTemplateInterface
@@ -858,7 +859,7 @@ github.com/knative/pkg/apis/duck/v1alpha1.Conditions
858859
</h3>
859860
<p>
860861
(<em>Appears on:</em>
861-
<a href="#BuildTemplate">BuildTemplate</a>,
862+
<a href="#BuildTemplate">BuildTemplate</a>,
862863
<a href="#ClusterBuildTemplate">ClusterBuildTemplate</a>)
863864
</p>
864865
<p>
@@ -1352,5 +1353,5 @@ This will override any of the template&rsquo;s steps environment variables.</p>
13521353
<hr/>
13531354
<p><em>
13541355
Generated with <code>gen-crd-api-reference-docs</code>
1355-
on git commit <code>ee63efc</code>.
1356+
on git commit <code>4fc8663f</code>.
13561357
</em></p>

‎docs/reference/eventing/eventing-sources.md‎

Lines changed: 94 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -550,6 +550,30 @@ Kubernetes core/v1.ObjectReference
550550
name to use as the sink.</p>
551551
</td>
552552
</tr>
553+
<tr>
554+
<td>
555+
<code>githubAPIURL</code></br>
556+
<em>
557+
string
558+
</em>
559+
</td>
560+
<td>
561+
<em>(Optional)</em>
562+
<p>API URL if using github enterprise (default <a href="https://api.github.com">https://api.github.com</a>)</p>
563+
</td>
564+
</tr>
565+
<tr>
566+
<td>
567+
<code>secure</code></br>
568+
<em>
569+
bool
570+
</em>
571+
</td>
572+
<td>
573+
<em>(Optional)</em>
574+
<p>Secure can be set to true to configure the webhook to use https.</p>
575+
</td>
576+
</tr>
553577
</table>
554578
</td>
555579
</tr>
@@ -769,16 +793,20 @@ run the Receive Adapter Deployment.</p>
769793
<tbody>
770794
<tr>
771795
<td>
772-
<code>conditions</code></br>
796+
<code>Status</code></br>
773797
<em>
774-
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Conditions">
775-
github.com/knative/pkg/apis/duck/v1alpha1.Conditions
798+
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Status">
799+
github.com/knative/pkg/apis/duck/v1alpha1.Status
776800
</a>
777801
</em>
778802
</td>
779803
<td>
780-
<em>(Optional)</em>
781-
<p>Conditions holds the state of a source at a point in time.</p>
804+
<p>
805+
(Members of <code>Status</code> are embedded into this type.)
806+
</p>
807+
<p>inherits duck/v1alpha1 Status, which currently provides:
808+
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
809+
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
782810
</td>
783811
</tr>
784812
<tr>
@@ -897,16 +925,20 @@ Kubernetes core/v1.ObjectReference
897925
<tbody>
898926
<tr>
899927
<td>
900-
<code>conditions</code></br>
928+
<code>Status</code></br>
901929
<em>
902-
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Conditions">
903-
github.com/knative/pkg/apis/duck/v1alpha1.Conditions
930+
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Status">
931+
github.com/knative/pkg/apis/duck/v1alpha1.Status
904932
</a>
905933
</em>
906934
</td>
907935
<td>
908-
<em>(Optional)</em>
909-
<p>Conditions holds the state of a source at a point in time.</p>
936+
<p>
937+
(Members of <code>Status</code> are embedded into this type.)
938+
</p>
939+
<p>inherits duck/v1alpha1 Status, which currently provides:
940+
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
941+
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
910942
</td>
911943
</tr>
912944
<tr>
@@ -1009,16 +1041,20 @@ Adapter Deployment.</p>
10091041
<tbody>
10101042
<tr>
10111043
<td>
1012-
<code>conditions</code></br>
1044+
<code>Status</code></br>
10131045
<em>
1014-
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Conditions">
1015-
github.com/knative/pkg/apis/duck/v1alpha1.Conditions
1046+
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Status">
1047+
github.com/knative/pkg/apis/duck/v1alpha1.Status
10161048
</a>
10171049
</em>
10181050
</td>
10191051
<td>
1020-
<em>(Optional)</em>
1021-
<p>Conditions holds the state of a source at a point in time.</p>
1052+
<p>
1053+
(Members of <code>Status</code> are embedded into this type.)
1054+
</p>
1055+
<p>inherits duck/v1alpha1 Status, which currently provides:
1056+
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
1057+
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
10221058
</td>
10231059
</tr>
10241060
<tr>
@@ -1140,6 +1176,30 @@ Kubernetes core/v1.ObjectReference
11401176
name to use as the sink.</p>
11411177
</td>
11421178
</tr>
1179+
<tr>
1180+
<td>
1181+
<code>githubAPIURL</code></br>
1182+
<em>
1183+
string
1184+
</em>
1185+
</td>
1186+
<td>
1187+
<em>(Optional)</em>
1188+
<p>API URL if using github enterprise (default <a href="https://api.github.com">https://api.github.com</a>)</p>
1189+
</td>
1190+
</tr>
1191+
<tr>
1192+
<td>
1193+
<code>secure</code></br>
1194+
<em>
1195+
bool
1196+
</em>
1197+
</td>
1198+
<td>
1199+
<em>(Optional)</em>
1200+
<p>Secure can be set to true to configure the webhook to use https.</p>
1201+
</td>
1202+
</tr>
11431203
</tbody>
11441204
</table>
11451205
<h3 id="GitHubSourceStatus">GitHubSourceStatus
@@ -1161,16 +1221,20 @@ name to use as the sink.</p>
11611221
<tbody>
11621222
<tr>
11631223
<td>
1164-
<code>conditions</code></br>
1224+
<code>Status</code></br>
11651225
<em>
1166-
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Conditions">
1167-
github.com/knative/pkg/apis/duck/v1alpha1.Conditions
1226+
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Status">
1227+
github.com/knative/pkg/apis/duck/v1alpha1.Status
11681228
</a>
11691229
</em>
11701230
</td>
11711231
<td>
1172-
<em>(Optional)</em>
1173-
<p>Conditions holds the state of a source at a point in time.</p>
1232+
<p>
1233+
(Members of <code>Status</code> are embedded into this type.)
1234+
</p>
1235+
<p>inherits duck/v1alpha1 Status, which currently provides:
1236+
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
1237+
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
11741238
</td>
11751239
</tr>
11761240
<tr>
@@ -1276,16 +1340,20 @@ as the sink.</p>
12761340
<tbody>
12771341
<tr>
12781342
<td>
1279-
<code>conditions</code></br>
1343+
<code>Status</code></br>
12801344
<em>
1281-
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Conditions">
1282-
github.com/knative/pkg/apis/duck/v1alpha1.Conditions
1345+
<a href="https://godoc.org/github.com/knative/pkg/apis/duck/v1alpha1#Status">
1346+
github.com/knative/pkg/apis/duck/v1alpha1.Status
12831347
</a>
12841348
</em>
12851349
</td>
12861350
<td>
1287-
<em>(Optional)</em>
1288-
<p>Conditions holds the state of a source at a point in time.</p>
1351+
<p>
1352+
(Members of <code>Status</code> are embedded into this type.)
1353+
</p>
1354+
<p>inherits duck/v1alpha1 Status, which currently provides:
1355+
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
1356+
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
12891357
</td>
12901358
</tr>
12911359
<tr>
@@ -1337,5 +1405,5 @@ Kubernetes core/v1.SecretKeySelector
13371405
<hr/>
13381406
<p><em>
13391407
Generated with <code>gen-crd-api-reference-docs</code>
1340-
on git commit <code>2efe55e1</code>.
1408+
on git commit <code>32ce3778</code>.
13411409
</em></p>

0 commit comments

Comments
 (0)