* new 07 API with eventing-contrib

* manually fix HTML links and dup pkgs

* update readme to mention manual updates
This commit is contained in:
RichieEscarez 2019-06-28 15:21:07 -07:00 committed by Knative Prow Robot
parent eb734da7cb
commit 48d71201c8
6 changed files with 2586 additions and 603 deletions

View File

@ -88,6 +88,12 @@ To generate a version of the API:
1. Copy the generated API files into the `docs/reference` directory of your
knative/docs clone.
1. IMPORTANT: There are some limitations to the build script that require
manual changes to the HTML. For the `serving.md` and
`eventing-contrib-resources.md`, you must manually fix the `Packages` lists.
Details for the required manual changes are in
[PR 1552](https://github.com/knative/docs/pull/1552#issuecomment-506891983).
You can now perform the necessary steps to open a PR, complete a review, and
merge the new API files into the appropriate branch of the `knative/docs` repo.
See the [contributor flow](../../contributing/DOCS-CONTRIBUTING.md) for details

View File

@ -10,13 +10,13 @@
</p>
Resource Types:
<ul><li>
<a href="#Build">Build</a>
<a href="#github.com%2fknative%2fbuild%2fpkg%2fapis%2fbuild%2fv1alpha1.Build">Build</a>
</li><li>
<a href="#BuildTemplate">BuildTemplate</a>
<a href="#github.com%2fknative%2fbuild%2fpkg%2fapis%2fbuild%2fv1alpha1.BuildTemplate">BuildTemplate</a>
</li><li>
<a href="#ClusterBuildTemplate">ClusterBuildTemplate</a>
<a href="#github.com%2fknative%2fbuild%2fpkg%2fapis%2fbuild%2fv1alpha1.ClusterBuildTemplate">ClusterBuildTemplate</a>
</li></ul>
<h3 id="Build">Build
<h3 id="github.com/knative/build/pkg/apis/build/v1alpha1.Build">Build
</h3>
<p>
<p>Build represents a build of a container image. A Build is made up of a
@ -66,7 +66,7 @@ Refer to the Kubernetes API documentation for the fields of the
<td>
<code>spec</code></br>
<em>
<a href="#BuildSpec">
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.BuildSpec">
BuildSpec
</a>
</em>
@ -93,8 +93,8 @@ to migrate</p>
<td>
<code>source</code></br>
<em>
<a href="#SourceSpec">
SourceSpec
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.SourceSpec">
github.com/knative/build/pkg/apis/build/v1alpha1.SourceSpec
</a>
</em>
</td>
@ -107,8 +107,8 @@ SourceSpec
<td>
<code>sources</code></br>
<em>
<a href="#SourceSpec">
[]SourceSpec
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.SourceSpec">
[][]github.com/knative/build/pkg/apis/build/v1alpha1.SourceSpec
</a>
</em>
</td>
@ -163,8 +163,8 @@ string
<td>
<code>template</code></br>
<em>
<a href="#TemplateInstantiationSpec">
TemplateInstantiationSpec
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.TemplateInstantiationSpec">
github.com/knative/build/pkg/apis/build/v1alpha1.TemplateInstantiationSpec
</a>
</em>
</td>
@ -223,7 +223,7 @@ Kubernetes core/v1.Affinity
<td>
<code>Status</code></br>
<em>
<a href="#BuildSpecStatus">
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.BuildSpecStatus">
BuildSpecStatus
</a>
</em>
@ -240,7 +240,7 @@ BuildSpecStatus
<td>
<code>status</code></br>
<em>
<a href="#BuildStatus">
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.BuildStatus">
BuildStatus
</a>
</em>
@ -250,7 +250,7 @@ BuildStatus
</tr>
</tbody>
</table>
<h3 id="BuildTemplate">BuildTemplate
<h3 id="github.com/knative/build/pkg/apis/build/v1alpha1.BuildTemplate">BuildTemplate
</h3>
<p>
<p>BuildTemplate is a template that can used to easily create Builds.</p>
@ -298,7 +298,7 @@ Refer to the Kubernetes API documentation for the fields of the
<td>
<code>spec</code></br>
<em>
<a href="#BuildTemplateSpec">
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.BuildTemplateSpec">
BuildTemplateSpec
</a>
</em>
@ -325,8 +325,8 @@ to migrate</p>
<td>
<code>parameters</code></br>
<em>
<a href="#ParameterSpec">
[]ParameterSpec
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.ParameterSpec">
[][]github.com/knative/build/pkg/apis/build/v1alpha1.ParameterSpec
</a>
</em>
</td>
@ -367,7 +367,7 @@ steps of the build.</p>
</tr>
</tbody>
</table>
<h3 id="ClusterBuildTemplate">ClusterBuildTemplate
<h3 id="github.com/knative/build/pkg/apis/build/v1alpha1.ClusterBuildTemplate">ClusterBuildTemplate
</h3>
<p>
<p>ClusterBuildTemplate is a template that can used to easily create Builds.</p>
@ -415,7 +415,7 @@ Refer to the Kubernetes API documentation for the fields of the
<td>
<code>spec</code></br>
<em>
<a href="#BuildTemplateSpec">
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.BuildTemplateSpec">
BuildTemplateSpec
</a>
</em>
@ -442,8 +442,8 @@ to migrate</p>
<td>
<code>parameters</code></br>
<em>
<a href="#ParameterSpec">
[]ParameterSpec
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.ParameterSpec">
[][]github.com/knative/build/pkg/apis/build/v1alpha1.ParameterSpec
</a>
</em>
</td>
@ -484,11 +484,11 @@ steps of the build.</p>
</tr>
</tbody>
</table>
<h3 id="ArgumentSpec">ArgumentSpec
<h3 id="github.com/knative/build/pkg/apis/build/v1alpha1.ArgumentSpec">ArgumentSpec
</h3>
<p>
(<em>Appears on:</em>
<a href="#TemplateInstantiationSpec">TemplateInstantiationSpec</a>)
<a href="#github.com%2fknative%2fbuild%2fpkg%2fapis%2fbuild%2fv1alpha1.TemplateInstantiationSpec">TemplateInstantiationSpec</a>)
</p>
<p>
<p>ArgumentSpec defines the actual values to use to populate a template&rsquo;s
@ -526,20 +526,20 @@ string
</tr>
</tbody>
</table>
<h3 id="BuildProvider">BuildProvider
<h3 id="github.com/knative/build/pkg/apis/build/v1alpha1.BuildProvider">BuildProvider
(<code>string</code> alias)</p></h3>
<p>
(<em>Appears on:</em>
<a href="#BuildStatus">BuildStatus</a>)
<a href="#github.com%2fknative%2fbuild%2fpkg%2fapis%2fbuild%2fv1alpha1.BuildStatus">BuildStatus</a>)
</p>
<p>
<p>BuildProvider defines a build execution implementation.</p>
</p>
<h3 id="BuildSpec">BuildSpec
<h3 id="github.com/knative/build/pkg/apis/build/v1alpha1.BuildSpec">BuildSpec
</h3>
<p>
(<em>Appears on:</em>
<a href="#Build">Build</a>)
<a href="#github.com%2fknative%2fbuild%2fpkg%2fapis%2fbuild%2fv1alpha1.Build">Build</a>)
</p>
<p>
<p>BuildSpec is the spec for a Build resource.</p>
@ -570,8 +570,8 @@ to migrate</p>
<td>
<code>source</code></br>
<em>
<a href="#SourceSpec">
SourceSpec
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.SourceSpec">
github.com/knative/build/pkg/apis/build/v1alpha1.SourceSpec
</a>
</em>
</td>
@ -584,8 +584,8 @@ SourceSpec
<td>
<code>sources</code></br>
<em>
<a href="#SourceSpec">
[]SourceSpec
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.SourceSpec">
[][]github.com/knative/build/pkg/apis/build/v1alpha1.SourceSpec
</a>
</em>
</td>
@ -640,8 +640,8 @@ string
<td>
<code>template</code></br>
<em>
<a href="#TemplateInstantiationSpec">
TemplateInstantiationSpec
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.TemplateInstantiationSpec">
github.com/knative/build/pkg/apis/build/v1alpha1.TemplateInstantiationSpec
</a>
</em>
</td>
@ -700,7 +700,7 @@ Kubernetes core/v1.Affinity
<td>
<code>Status</code></br>
<em>
<a href="#BuildSpecStatus">
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.BuildSpecStatus">
BuildSpecStatus
</a>
</em>
@ -712,20 +712,20 @@ BuildSpecStatus
</tr>
</tbody>
</table>
<h3 id="BuildSpecStatus">BuildSpecStatus
<h3 id="github.com/knative/build/pkg/apis/build/v1alpha1.BuildSpecStatus">BuildSpecStatus
(<code>string</code> alias)</p></h3>
<p>
(<em>Appears on:</em>
<a href="#BuildSpec">BuildSpec</a>)
<a href="#github.com%2fknative%2fbuild%2fpkg%2fapis%2fbuild%2fv1alpha1.BuildSpec">BuildSpec</a>)
</p>
<p>
<p>BuildSpecStatus defines the build spec status the user can provide</p>
</p>
<h3 id="BuildStatus">BuildStatus
<h3 id="github.com/knative/build/pkg/apis/build/v1alpha1.BuildStatus">BuildStatus
</h3>
<p>
(<em>Appears on:</em>
<a href="#Build">Build</a>)
<a href="#github.com%2fknative%2fbuild%2fpkg%2fapis%2fbuild%2fv1alpha1.Build">Build</a>)
</p>
<p>
<p>BuildStatus is the status for a Build resource</p>
@ -757,7 +757,7 @@ github.com/knative/pkg/apis/duck/v1alpha1.Status
<td>
<code>builder</code></br>
<em>
<a href="#BuildProvider">
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.BuildProvider">
BuildProvider
</a>
</em>
@ -770,8 +770,8 @@ BuildProvider
<td>
<code>cluster</code></br>
<em>
<a href="#ClusterSpec">
ClusterSpec
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.ClusterSpec">
github.com/knative/build/pkg/apis/build/v1alpha1.ClusterSpec
</a>
</em>
</td>
@ -784,8 +784,8 @@ ClusterSpec
<td>
<code>google</code></br>
<em>
<a href="#GoogleSpec">
GoogleSpec
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.GoogleSpec">
github.com/knative/build/pkg/apis/build/v1alpha1.GoogleSpec
</a>
</em>
</td>
@ -850,17 +850,17 @@ Kubernetes meta/v1.Time
</tr>
</tbody>
</table>
<h3 id="BuildTemplateInterface">BuildTemplateInterface
<h3 id="github.com/knative/build/pkg/apis/build/v1alpha1.BuildTemplateInterface">BuildTemplateInterface
</h3>
<p>
<p>BuildTemplateInterface is implemented by BuildTemplate and ClusterBuildTemplate</p>
</p>
<h3 id="BuildTemplateSpec">BuildTemplateSpec
<h3 id="github.com/knative/build/pkg/apis/build/v1alpha1.BuildTemplateSpec">BuildTemplateSpec
</h3>
<p>
(<em>Appears on:</em>
<a href="#BuildTemplate">BuildTemplate</a>,
<a href="#ClusterBuildTemplate">ClusterBuildTemplate</a>)
<a href="#github.com%2fknative%2fbuild%2fpkg%2fapis%2fbuild%2fv1alpha1.BuildTemplate">BuildTemplate</a>,
<a href="#github.com%2fknative%2fbuild%2fpkg%2fapis%2fbuild%2fv1alpha1.ClusterBuildTemplate">ClusterBuildTemplate</a>)
</p>
<p>
<p>BuildTemplateSpec is the spec for a BuildTemplate.</p>
@ -891,8 +891,8 @@ to migrate</p>
<td>
<code>parameters</code></br>
<em>
<a href="#ParameterSpec">
[]ParameterSpec
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.ParameterSpec">
[][]github.com/knative/build/pkg/apis/build/v1alpha1.ParameterSpec
</a>
</em>
</td>
@ -930,11 +930,11 @@ steps of the build.</p>
</tr>
</tbody>
</table>
<h3 id="ClusterSpec">ClusterSpec
<h3 id="github.com/knative/build/pkg/apis/build/v1alpha1.ClusterSpec">ClusterSpec
</h3>
<p>
(<em>Appears on:</em>
<a href="#BuildStatus">BuildStatus</a>)
<a href="#github.com%2fknative%2fbuild%2fpkg%2fapis%2fbuild%2fv1alpha1.BuildStatus">BuildStatus</a>)
</p>
<p>
<p>ClusterSpec provides information about the on-cluster build, if applicable.</p>
@ -971,11 +971,11 @@ string
</tr>
</tbody>
</table>
<h3 id="GCSSourceSpec">GCSSourceSpec
<h3 id="github.com/knative/build/pkg/apis/build/v1alpha1.GCSSourceSpec">GCSSourceSpec
</h3>
<p>
(<em>Appears on:</em>
<a href="#SourceSpec">SourceSpec</a>)
<a href="#github.com%2fknative%2fbuild%2fpkg%2fapis%2fbuild%2fv1alpha1.SourceSpec">SourceSpec</a>)
</p>
<p>
<p>GCSSourceSpec describes source input to the Build in the form of an archive,
@ -993,7 +993,7 @@ or a source manifest describing files to fetch.</p>
<td>
<code>type</code></br>
<em>
<a href="#GCSSourceType">
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.GCSSourceType">
GCSSourceType
</a>
</em>
@ -1015,20 +1015,20 @@ string
</tr>
</tbody>
</table>
<h3 id="GCSSourceType">GCSSourceType
<h3 id="github.com/knative/build/pkg/apis/build/v1alpha1.GCSSourceType">GCSSourceType
(<code>string</code> alias)</p></h3>
<p>
(<em>Appears on:</em>
<a href="#GCSSourceSpec">GCSSourceSpec</a>)
<a href="#github.com%2fknative%2fbuild%2fpkg%2fapis%2fbuild%2fv1alpha1.GCSSourceSpec">GCSSourceSpec</a>)
</p>
<p>
<p>GCSSourceType defines a type of GCS source fetch.</p>
</p>
<h3 id="GitSourceSpec">GitSourceSpec
<h3 id="github.com/knative/build/pkg/apis/build/v1alpha1.GitSourceSpec">GitSourceSpec
</h3>
<p>
(<em>Appears on:</em>
<a href="#SourceSpec">SourceSpec</a>)
<a href="#github.com%2fknative%2fbuild%2fpkg%2fapis%2fbuild%2fv1alpha1.SourceSpec">SourceSpec</a>)
</p>
<p>
<p>GitSourceSpec describes a Git repo source input to the Build.</p>
@ -1067,11 +1067,11 @@ information.</p>
</tr>
</tbody>
</table>
<h3 id="GoogleSpec">GoogleSpec
<h3 id="github.com/knative/build/pkg/apis/build/v1alpha1.GoogleSpec">GoogleSpec
</h3>
<p>
(<em>Appears on:</em>
<a href="#BuildStatus">BuildStatus</a>)
<a href="#github.com%2fknative%2fbuild%2fpkg%2fapis%2fbuild%2fv1alpha1.BuildStatus">BuildStatus</a>)
</p>
<p>
<p>GoogleSpec provides information about the GCB build, if applicable.</p>
@ -1097,11 +1097,11 @@ string
</tr>
</tbody>
</table>
<h3 id="ParameterSpec">ParameterSpec
<h3 id="github.com/knative/build/pkg/apis/build/v1alpha1.ParameterSpec">ParameterSpec
</h3>
<p>
(<em>Appears on:</em>
<a href="#BuildTemplateSpec">BuildTemplateSpec</a>)
<a href="#github.com%2fknative%2fbuild%2fpkg%2fapis%2fbuild%2fv1alpha1.BuildTemplateSpec">BuildTemplateSpec</a>)
</p>
<p>
<p>ParameterSpec defines the possible parameters that can be populated in a
@ -1151,11 +1151,11 @@ the build does not specify the value for this parameter.</p>
</tr>
</tbody>
</table>
<h3 id="SourceSpec">SourceSpec
<h3 id="github.com/knative/build/pkg/apis/build/v1alpha1.SourceSpec">SourceSpec
</h3>
<p>
(<em>Appears on:</em>
<a href="#BuildSpec">BuildSpec</a>)
<a href="#github.com%2fknative%2fbuild%2fpkg%2fapis%2fbuild%2fv1alpha1.BuildSpec">BuildSpec</a>)
</p>
<p>
<p>SourceSpec defines the input to the Build</p>
@ -1172,8 +1172,8 @@ the build does not specify the value for this parameter.</p>
<td>
<code>git</code></br>
<em>
<a href="#GitSourceSpec">
GitSourceSpec
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.GitSourceSpec">
github.com/knative/build/pkg/apis/build/v1alpha1.GitSourceSpec
</a>
</em>
</td>
@ -1186,8 +1186,8 @@ GitSourceSpec
<td>
<code>gcs</code></br>
<em>
<a href="#GCSSourceSpec">
GCSSourceSpec
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.GCSSourceSpec">
github.com/knative/build/pkg/apis/build/v1alpha1.GCSSourceSpec
</a>
</em>
</td>
@ -1258,17 +1258,17 @@ TargetPath should not be set for custom source.</p>
</tr>
</tbody>
</table>
<h3 id="Template">Template
<h3 id="github.com/knative/build/pkg/apis/build/v1alpha1.Template">Template
</h3>
<p>
<p>Template is an interface for accessing the BuildTemplateSpec
from various forms of template (namespace-/cluster-scoped).</p>
</p>
<h3 id="TemplateInstantiationSpec">TemplateInstantiationSpec
<h3 id="github.com/knative/build/pkg/apis/build/v1alpha1.TemplateInstantiationSpec">TemplateInstantiationSpec
</h3>
<p>
(<em>Appears on:</em>
<a href="#BuildSpec">BuildSpec</a>)
<a href="#github.com%2fknative%2fbuild%2fpkg%2fapis%2fbuild%2fv1alpha1.BuildSpec">BuildSpec</a>)
</p>
<p>
<p>TemplateInstantiationSpec specifies how a BuildTemplate is instantiated into
@ -1298,7 +1298,7 @@ The template is assumed to exist in the Build&rsquo;s namespace.</p>
<td>
<code>kind</code></br>
<em>
<a href="#TemplateKind">
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.TemplateKind">
TemplateKind
</a>
</em>
@ -1313,8 +1313,8 @@ or ClusterBuildTemplate. If nothing is specified, the default if is BuildTemplat
<td>
<code>arguments</code></br>
<em>
<a href="#ArgumentSpec">
[]ArgumentSpec
<a href="#github.com/knative/build/pkg/apis/build/v1alpha1.ArgumentSpec">
[][]github.com/knative/build/pkg/apis/build/v1alpha1.ArgumentSpec
</a>
</em>
</td>
@ -1341,11 +1341,11 @@ This will override any of the template&rsquo;s steps environment variables.</p>
</tr>
</tbody>
</table>
<h3 id="TemplateKind">TemplateKind
<h3 id="github.com/knative/build/pkg/apis/build/v1alpha1.TemplateKind">TemplateKind
(<code>string</code> alias)</p></h3>
<p>
(<em>Appears on:</em>
<a href="#TemplateInstantiationSpec">TemplateInstantiationSpec</a>)
<a href="#github.com%2fknative%2fbuild%2fpkg%2fapis%2fbuild%2fv1alpha1.TemplateInstantiationSpec">TemplateInstantiationSpec</a>)
</p>
<p>
<p>TemplateKind defines the type of BuildTemplate used by the build.</p>

View File

@ -3,17 +3,6 @@ title: "Eventing-contrib Resources"
linkTitle: "Eventing-contrib API"
weight: 50
type: "docs"
aliases:
- /docs/reference/eventing/eventing-contrib-resources/
---
The API definitions for the Eventing resources that conform to Knative Eventing
are located in the
[`knative/eventing-contrib`](https://github.com/knative/eventing-contrib/tree/release-0.7/)
repo:
- [`awssqs` source](https://github.com/knative/eventing-contrib/tree/release-0.7/contrib/awssqs/pkg/apis/sources/v1alpha1)
- [`camel` source](https://github.com/knative/eventing-contrib/tree/release-0.7/camel/source/pkg/apis/sources/v1alpha1)
- [`gcppubsub` source](https://github.com/knative/eventing-contrib/tree/release-0.7/contrib/gcppubsub/pkg/apis/sources/v1alpha1)
- [`github` source](https://github.com/knative/eventing-contrib/tree/release-0.7/contrib/github/pkg/apis/sources/v1alpha1)
- [`kafka` source](https://github.com/knative/eventing-contrib/tree/release-0.7/kafka/source/pkg/apis/sources/v1alpha1)
{{% readfile file="eventing-contrib-resources.md" relative="true" %}}

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff