mirror of https://github.com/knative/docs.git
eventing-contrib API and consistent file names (#1805)
This commit is contained in:
RichieEscarez
Knative Prow Robot
parent
ecade3b21e
commit
1397e226d3
|
|
@ -11,7 +11,7 @@ The API source files are located at:
|
|||
|
||||
- [Serving API](./serving.md)
|
||||
- [Eventing API](./eventing/eventing.md)
|
||||
- [Eventing-contrib resources API](./eventing/eventing-resources.md)
|
||||
- [Eventing-contrib resources API](./eventing/eventing-contrib.md)
|
||||
|
||||
## Updating API Reference docs (for Knative maintainers)
|
||||
|
||||
|
|
@ -57,18 +57,20 @@ To generate a version of the API:
|
|||
1. Locate the commits or tags that correspond to the version of the API that you
|
||||
want to generate:
|
||||
|
||||
- [Serving](https://github.com/knative/serving/releases/)
|
||||
- [Eventing](https://github.com/knative/eventing/releases/)
|
||||
- [Eventing-contrib resources](https://github.com/knative/eventing-contrib/releases/)
|
||||
- [Serving](https://github.com/knative/serving/releases/)
|
||||
|
||||
1. To run the `gen-api-reference-docs.sh` command from the `hack` directory, you
|
||||
specify the commits or tags for each of the corresponding Knative component
|
||||
variables (`KNATIVE_[component_name]_COMMIT`):
|
||||
|
||||
```
|
||||
KNATIVE_EVENTING_COMMIT=[commit_or_tag] \
|
||||
KNATIVE_EVENTING_SOURCES_COMMIT=[commit_or_tag] \
|
||||
cd hack
|
||||
|
||||
KNATIVE_SERVING_COMMIT=[commit_or_tag] \
|
||||
KNATIVE_EVENTING_COMMIT=[commit_or_tag] \
|
||||
KNATIVE_EVENTING_CONTRIB_COMMIT=[commit_or_tag] \
|
||||
./gen-api-reference-docs.sh
|
||||
```
|
||||
|
||||
|
|
@ -85,12 +87,6 @@ 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
|
||||
|
|
@ -108,8 +104,8 @@ Using tags from each repo, you would run the following command to generate the
|
|||
v0.3.0 API source files:
|
||||
|
||||
```
|
||||
KNATIVE_EVENTING_COMMIT=v0.3.0 \
|
||||
KNATIVE_EVENTING_SOURCES_COMMIT=v0.3.0 \
|
||||
KNATIVE_SERVING_COMMIT=v0.3.0 \
|
||||
KNATIVE_EVENTING_COMMIT=v0.3.0 \
|
||||
KNATIVE_EVENTING_CONTRIB_COMMIT=v0.3.0 \
|
||||
./gen-api-reference-docs.sh
|
||||
```
|
||||
|
|
|
|||
|
|
@ -5,4 +5,4 @@ weight: 50
|
|||
type: "docs"
|
||||
---
|
||||
|
||||
{{< readfile file="eventing-contrib-resources.md" relative="true" >}}
|
||||
{{< readfile file="eventing-contrib.md" relative="true" >}}
|
||||
|
|
|
|||
|
|
@ -17,8 +17,6 @@ Resource Types:
|
|||
</li><li>
|
||||
<a href="#sources.eventing.knative.dev/v1alpha1.CamelSource">CamelSource</a>
|
||||
</li><li>
|
||||
<a href="#sources.eventing.knative.dev/v1alpha1.GcpPubSubSource">GcpPubSubSource</a>
|
||||
</li><li>
|
||||
<a href="#sources.eventing.knative.dev/v1alpha1.GitHubSource">GitHubSource</a>
|
||||
</li><li>
|
||||
<a href="#sources.eventing.knative.dev/v1alpha1.KafkaSource">KafkaSource</a>
|
||||
|
|
@ -249,160 +247,6 @@ CamelSourceStatus
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="sources.eventing.knative.dev/v1alpha1.GcpPubSubSource">GcpPubSubSource
|
||||
</h3>
|
||||
<p>
|
||||
<p>GcpPubSubSource is the Schema for the gcppubsubsources API.</p>
|
||||
</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>apiVersion</code></br>
|
||||
string</td>
|
||||
<td>
|
||||
<code>
|
||||
sources.eventing.knative.dev/v1alpha1
|
||||
</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>kind</code></br>
|
||||
string
|
||||
</td>
|
||||
<td><code>GcpPubSubSource</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>metadata</code></br>
|
||||
<em>
|
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#objectmeta-v1-meta">
|
||||
Kubernetes meta/v1.ObjectMeta
|
||||
</a>
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
Refer to the Kubernetes API documentation for the fields of the
|
||||
<code>metadata</code> field.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>spec</code></br>
|
||||
<em>
|
||||
<a href="#sources.eventing.knative.dev/v1alpha1.GcpPubSubSourceSpec">
|
||||
GcpPubSubSourceSpec
|
||||
</a>
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<br/>
|
||||
<br/>
|
||||
<table>
|
||||
<tr>
|
||||
<td>
|
||||
<code>gcpCredsSecret</code></br>
|
||||
<em>
|
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#secretkeyselector-v1-core">
|
||||
Kubernetes core/v1.SecretKeySelector
|
||||
</a>
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<p>GcpCredsSecret is the credential to use to poll the GCP PubSub Subscription. It is not used
|
||||
to create or delete the Subscription, only to poll it. The value of the secret entry must be
|
||||
a service account key in the JSON format
|
||||
( see <a href="https://cloud.google.com/iam/docs/creating-managing-service-account-keys">https://cloud.google.com/iam/docs/creating-managing-service-account-keys</a> ).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>googleCloudProject</code></br>
|
||||
<em>
|
||||
string
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<p>GoogleCloudProject is the ID of the Google Cloud Project that the PubSub Topic exists in.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>topic</code></br>
|
||||
<em>
|
||||
string
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<p>Topic is the ID of the GCP PubSub Topic to Subscribe to. It must be in the form of the
|
||||
unique identifier within the project, not the entire name. E.g. it must be ‘laconia’, not
|
||||
‘projects/my-gcp-project/topics/laconia’.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>sink</code></br>
|
||||
<em>
|
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#objectreference-v1-core">
|
||||
Kubernetes core/v1.ObjectReference
|
||||
</a>
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<em>(Optional)</em>
|
||||
<p>Sink is a reference to an object that will resolve to a domain name to use as the sink.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>transformer</code></br>
|
||||
<em>
|
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#objectreference-v1-core">
|
||||
Kubernetes core/v1.ObjectReference
|
||||
</a>
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<em>(Optional)</em>
|
||||
<p>Transformer is a reference to an object that will resolve to a domain name to use as the transformer.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>serviceAccountName</code></br>
|
||||
<em>
|
||||
string
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<p>ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive
|
||||
Adapter Deployment.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>status</code></br>
|
||||
<em>
|
||||
<a href="#sources.eventing.knative.dev/v1alpha1.GcpPubSubSourceStatus">
|
||||
GcpPubSubSourceStatus
|
||||
</a>
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="sources.eventing.knative.dev/v1alpha1.GitHubSource">GitHubSource
|
||||
</h3>
|
||||
<p>
|
||||
|
|
@ -1075,164 +919,6 @@ string
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="sources.eventing.knative.dev/v1alpha1.GcpPubSubSourceSpec">GcpPubSubSourceSpec
|
||||
</h3>
|
||||
<p>
|
||||
(<em>Appears on:</em>
|
||||
<a href="#sources.eventing.knative.dev/v1alpha1.GcpPubSubSource">GcpPubSubSource</a>)
|
||||
</p>
|
||||
<p>
|
||||
<p>GcpPubSubSourceSpec defines the desired state of the GcpPubSubSource.</p>
|
||||
</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>gcpCredsSecret</code></br>
|
||||
<em>
|
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#secretkeyselector-v1-core">
|
||||
Kubernetes core/v1.SecretKeySelector
|
||||
</a>
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<p>GcpCredsSecret is the credential to use to poll the GCP PubSub Subscription. It is not used
|
||||
to create or delete the Subscription, only to poll it. The value of the secret entry must be
|
||||
a service account key in the JSON format
|
||||
( see <a href="https://cloud.google.com/iam/docs/creating-managing-service-account-keys">https://cloud.google.com/iam/docs/creating-managing-service-account-keys</a> ).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>googleCloudProject</code></br>
|
||||
<em>
|
||||
string
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<p>GoogleCloudProject is the ID of the Google Cloud Project that the PubSub Topic exists in.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>topic</code></br>
|
||||
<em>
|
||||
string
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<p>Topic is the ID of the GCP PubSub Topic to Subscribe to. It must be in the form of the
|
||||
unique identifier within the project, not the entire name. E.g. it must be ‘laconia’, not
|
||||
‘projects/my-gcp-project/topics/laconia’.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>sink</code></br>
|
||||
<em>
|
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#objectreference-v1-core">
|
||||
Kubernetes core/v1.ObjectReference
|
||||
</a>
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<em>(Optional)</em>
|
||||
<p>Sink is a reference to an object that will resolve to a domain name to use as the sink.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>transformer</code></br>
|
||||
<em>
|
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#objectreference-v1-core">
|
||||
Kubernetes core/v1.ObjectReference
|
||||
</a>
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<em>(Optional)</em>
|
||||
<p>Transformer is a reference to an object that will resolve to a domain name to use as the transformer.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>serviceAccountName</code></br>
|
||||
<em>
|
||||
string
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<p>ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive
|
||||
Adapter Deployment.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="sources.eventing.knative.dev/v1alpha1.GcpPubSubSourceStatus">GcpPubSubSourceStatus
|
||||
</h3>
|
||||
<p>
|
||||
(<em>Appears on:</em>
|
||||
<a href="#sources.eventing.knative.dev/v1alpha1.GcpPubSubSource">GcpPubSubSource</a>)
|
||||
</p>
|
||||
<p>
|
||||
<p>GcpPubSubSourceStatus defines the observed state of GcpPubSubSource.</p>
|
||||
</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>Status</code></br>
|
||||
<em>
|
||||
knative.dev/pkg/apis/duck/v1alpha1.Status
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
(Members of <code>Status</code> are embedded into this type.)
|
||||
</p>
|
||||
<p>inherits duck/v1alpha1 Status, which currently provides:
|
||||
* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller.
|
||||
* Conditions - the latest available observations of a resource’s current state.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>sinkUri</code></br>
|
||||
<em>
|
||||
string
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<em>(Optional)</em>
|
||||
<p>SinkURI is the current active sink URI that has been configured for the GcpPubSubSource.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>transformerUri</code></br>
|
||||
<em>
|
||||
string
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<em>(Optional)</em>
|
||||
<p>TransformerURI is the current active transformer URI that has been configured for the GcpPubSubSource.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="sources.eventing.knative.dev/v1alpha1.GitHubSourceSpec">GitHubSourceSpec
|
||||
</h3>
|
||||
<p>
|
||||
|
|
@ -1863,7 +1549,8 @@ SecretValueFromSource
|
|||
</h3>
|
||||
<p>
|
||||
(<em>Appears on:</em>
|
||||
<a href="#sources.eventing.knative.dev/v1alpha1.GitHubSourceSpec">GitHubSourceSpec</a>)
|
||||
<a href="#sources.eventing.knative.dev/v1alpha1.KafkaSourceSASLSpec">KafkaSourceSASLSpec</a>,
|
||||
<a href="#sources.eventing.knative.dev/v1alpha1.KafkaSourceTLSSpec">KafkaSourceTLSSpec</a>)
|
||||
</p>
|
||||
<p>
|
||||
<p>SecretValueFromSource represents the source of a secret value</p>
|
||||
|
|
@ -1895,8 +1582,7 @@ Kubernetes core/v1.SecretKeySelector
|
|||
</h3>
|
||||
<p>
|
||||
(<em>Appears on:</em>
|
||||
<a href="#sources.eventing.knative.dev/v1alpha1.KafkaSourceSASLSpec">KafkaSourceSASLSpec</a>,
|
||||
<a href="#sources.eventing.knative.dev/v1alpha1.KafkaSourceTLSSpec">KafkaSourceTLSSpec</a>)
|
||||
<a href="#sources.eventing.knative.dev/v1alpha1.GitHubSourceSpec">GitHubSourceSpec</a>)
|
||||
</p>
|
||||
<p>
|
||||
<p>SecretValueFromSource represents the source of a secret value</p>
|
||||
|
|
@ -1932,6 +1618,8 @@ Kubernetes core/v1.SecretKeySelector
|
|||
Resource Types:
|
||||
<ul><li>
|
||||
<a href="#messaging.knative.dev/v1alpha1.KafkaChannel">KafkaChannel</a>
|
||||
</li><li>
|
||||
<a href="#messaging.knative.dev/v1alpha1.NatssChannel">NatssChannel</a>
|
||||
</li></ul>
|
||||
<h3 id="messaging.knative.dev/v1alpha1.KafkaChannel">KafkaChannel
|
||||
</h3>
|
||||
|
|
@ -2018,7 +1706,7 @@ int16
|
|||
<td>
|
||||
<code>subscribable</code></br>
|
||||
<em>
|
||||
github.com/knative/eventing/pkg/apis/duck/v1alpha1.Subscribable
|
||||
knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
|
|
@ -2045,6 +1733,96 @@ date.</p>
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="messaging.knative.dev/v1alpha1.NatssChannel">NatssChannel
|
||||
</h3>
|
||||
<p>
|
||||
<p>NatssChannel is a resource representing a NATSS Channel.</p>
|
||||
</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>apiVersion</code></br>
|
||||
string</td>
|
||||
<td>
|
||||
<code>
|
||||
messaging.knative.dev/v1alpha1
|
||||
</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>kind</code></br>
|
||||
string
|
||||
</td>
|
||||
<td><code>NatssChannel</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>metadata</code></br>
|
||||
<em>
|
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#objectmeta-v1-meta">
|
||||
Kubernetes meta/v1.ObjectMeta
|
||||
</a>
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<em>(Optional)</em>
|
||||
Refer to the Kubernetes API documentation for the fields of the
|
||||
<code>metadata</code> field.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>spec</code></br>
|
||||
<em>
|
||||
<a href="#messaging.knative.dev/v1alpha1.NatssChannelSpec">
|
||||
NatssChannelSpec
|
||||
</a>
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<p>Spec defines the desired state of the Channel.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<table>
|
||||
<tr>
|
||||
<td>
|
||||
<code>subscribable</code></br>
|
||||
<em>
|
||||
knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<p>NatssChannel conforms to Duck type Subscribable.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>status</code></br>
|
||||
<em>
|
||||
<a href="#messaging.knative.dev/v1alpha1.NatssChannelStatus">
|
||||
NatssChannelStatus
|
||||
</a>
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<em>(Optional)</em>
|
||||
<p>Status represents the current state of the NatssChannel. This data may be out of
|
||||
date.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="messaging.knative.dev/v1alpha1.KafkaChannelSpec">KafkaChannelSpec
|
||||
</h3>
|
||||
<p>
|
||||
|
|
@ -2088,7 +1866,7 @@ int16
|
|||
<td>
|
||||
<code>subscribable</code></br>
|
||||
<em>
|
||||
github.com/knative/eventing/pkg/apis/duck/v1alpha1.Subscribable
|
||||
knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
|
|
@ -2151,7 +1929,103 @@ provided targets from inside the cluster.</p>
|
|||
<td>
|
||||
<code>SubscribableTypeStatus</code></br>
|
||||
<em>
|
||||
github.com/knative/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus
|
||||
knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
(Members of <code>SubscribableTypeStatus</code> are embedded into this type.)
|
||||
</p>
|
||||
<p>Subscribers is populated with the statuses of each of the Channelable’s subscribers.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="messaging.knative.dev/v1alpha1.NatssChannelSpec">NatssChannelSpec
|
||||
</h3>
|
||||
<p>
|
||||
(<em>Appears on:</em>
|
||||
<a href="#messaging.knative.dev/v1alpha1.NatssChannel">NatssChannel</a>)
|
||||
</p>
|
||||
<p>
|
||||
<p>NatssChannelSpec defines the specification for a NatssChannel.</p>
|
||||
</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>subscribable</code></br>
|
||||
<em>
|
||||
knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<p>NatssChannel conforms to Duck type Subscribable.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="messaging.knative.dev/v1alpha1.NatssChannelStatus">NatssChannelStatus
|
||||
</h3>
|
||||
<p>
|
||||
(<em>Appears on:</em>
|
||||
<a href="#messaging.knative.dev/v1alpha1.NatssChannel">NatssChannel</a>)
|
||||
</p>
|
||||
<p>
|
||||
<p>NatssChannelStatus represents the current state of a NatssChannel.</p>
|
||||
</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>Status</code></br>
|
||||
<em>
|
||||
knative.dev/pkg/apis/duck/v1beta1.Status
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
(Members of <code>Status</code> are embedded into this type.)
|
||||
</p>
|
||||
<p>inherits duck/v1beta1 Status, which currently provides:
|
||||
* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller.
|
||||
* Conditions - the latest available observations of a resource’s current state.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>AddressStatus</code></br>
|
||||
<em>
|
||||
knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
(Members of <code>AddressStatus</code> are embedded into this type.)
|
||||
</p>
|
||||
<p>NatssChannel is Addressable. It currently exposes the endpoint as a
|
||||
fully-qualified DNS name which will distribute traffic over the
|
||||
provided targets from inside the cluster.</p>
|
||||
<p>It generally has the form {channel}.{namespace}.svc.{cluster domain name}</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>SubscribableTypeStatus</code></br>
|
||||
<em>
|
||||
knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
|
|
@ -2166,5 +2040,5 @@ github.com/knative/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus
|
|||
<hr/>
|
||||
<p><em>
|
||||
Generated with <code>gen-crd-api-reference-docs</code>
|
||||
on git commit <code>4bda4fca</code>.
|
||||
on git commit <code>89b43a1d</code>.
|
||||
</em></p>
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -1,4 +1,4 @@
|
|||
|
||||
<p>See the <a href="https://github.com/knative/serving/tree/master/pkg/apis">Knative Serving repo</a> for the v0.8 API.</p>
|
||||
<p>See the <a href="https://github.com/knative/serving/tree/master/pkg/apis">Knative Serving repo</a> for the API.</p>
|
||||
|
||||
<p>There is currently an API doc build tool issue that we hope to resolve soon.</p>
|
||||
<p>There is currently an [API doc build tool issue](https://github.com/knative/docs/issues/1661) that we hope to resolve soon.</p>
|
||||
|
|
|
|||
|
|
@ -33,9 +33,9 @@ KNATIVE_EVENTING_REPO="github.com/knative/eventing"
|
|||
KNATIVE_EVENTING_COMMIT="${KNATIVE_EVENTING_COMMIT:?specify the \$KNATIVE_EVENTING_COMMIT variable}"
|
||||
KNATIVE_EVENTING_OUT_FILE="eventing/eventing.md"
|
||||
|
||||
KNATIVE_EVENTING_RESOURCES_REPO="github.com/knative/eventing-contrib"
|
||||
KNATIVE_EVENTING_RESOURCES_COMMIT="${KNATIVE_EVENTING_RESOURCES_COMMIT:?specify the \$KNATIVE_EVENTING_RESOURCES_COMMIT variable}"
|
||||
KNATIVE_EVENTING_RESOURCES_OUT_FILE="eventing/eventing-contrib-resources.md"
|
||||
KNATIVE_EVENTING_CONTRIB_REPO="github.com/knative/eventing-contrib"
|
||||
KNATIVE_EVENTING_CONTRIB_COMMIT="${KNATIVE_EVENTING_CONTRIB_COMMIT:?specify the \$KNATIVE_EVENTING_CONTRIB_COMMIT variable}"
|
||||
KNATIVE_EVENTING_CONTRIB_OUT_FILE="eventing/eventing-contrib.md"
|
||||
|
||||
cleanup_refdocs_root=
|
||||
cleanup_repo_clone_root=
|
||||
|
|
@ -163,12 +163,12 @@ main() {
|
|||
gen_refdocs "${refdocs_bin}" "${clone_root}" "${template_dir}" \
|
||||
"${out_dir}/${KNATIVE_EVENTING_OUT_FILE}" "${knative_eventing_root}" "./pkg/apis"
|
||||
|
||||
local knative_eventing_resources_root
|
||||
knative_eventing_resources_root="${clone_root}/src/${KNATIVE_EVENTING_RESOURCES_REPO}"
|
||||
clone_at_commit "https://${KNATIVE_EVENTING_RESOURCES_REPO}.git" "${KNATIVE_EVENTING_RESOURCES_COMMIT}" \
|
||||
"${knative_eventing_resources_root}"
|
||||
local knative_eventing_contrib_root
|
||||
knative_eventing_contrib_root="${clone_root}/src/${KNATIVE_EVENTING_CONTRIB_REPO}"
|
||||
clone_at_commit "https://${KNATIVE_EVENTING_CONTRIB_REPO}.git" "${KNATIVE_EVENTING_CONTRIB_COMMIT}" \
|
||||
"${knative_eventing_contrib_root}"
|
||||
gen_refdocs "${refdocs_bin}" "${clone_root}" "${template_dir}" \
|
||||
"${out_dir}/${KNATIVE_EVENTING_RESOURCES_OUT_FILE}" "${knative_eventing_resources_root}" "."
|
||||
"${out_dir}/${KNATIVE_EVENTING_CONTRIB_OUT_FILE}" "${knative_eventing_contrib_root}" "."
|
||||
|
||||
log "SUCCESS: Generated docs written to ${out_dir}/."
|
||||
log "Opening the ${out_dir}/ directory. You can now copy these API files"
|
||||
|
|
|
|||
Loading…
Reference in New Issue