chore(event-source-custom-resource): added api specification markdown…

… files
argoproj · Dec 12, 2019 · 20c0d15 · 20c0d15
1 parent 8d85191
commit 20c0d15
Show file tree

Hide file tree

Showing 8 changed files with 75 additions and 53 deletions.
diff --git a/api/event-source.html b/api/event-source.html
@@ -253,7 +253,7 @@ <h3 id="argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec
 <code>calendar</code></br>
 <em>
 <a href="#argoproj.io/v1alpha1.CalendarEventSource">
-map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.CalendarEventSource
+map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.CalendarEventSource
 </a>
 </em>
 </td>
@@ -266,7 +266,7 @@ <h3 id="argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec
 <code>file</code></br>
 <em>
 <a href="#argoproj.io/v1alpha1.FileEventSource">
-map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.FileEventSource
+map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.FileEventSource
 </a>
 </em>
 </td>
@@ -279,7 +279,7 @@ <h3 id="argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec
 <code>resource</code></br>
 <em>
 <a href="#argoproj.io/v1alpha1.ResourceEventSource">
-map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.ResourceEventSource
+map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.ResourceEventSource
 </a>
 </em>
 </td>
@@ -303,7 +303,7 @@ <h3 id="argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec
 <code>amqp</code></br>
 <em>
 <a href="#argoproj.io/v1alpha1.AMQPEventSource">
-map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.AMQPEventSource
+map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.AMQPEventSource
 </a>
 </em>
 </td>
@@ -316,7 +316,7 @@ <h3 id="argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec
 <code>kafka</code></br>
 <em>
 <a href="#argoproj.io/v1alpha1.KafkaEventSource">
-map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.KafkaEventSource
+map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.KafkaEventSource
 </a>
 </em>
 </td>
@@ -329,7 +329,7 @@ <h3 id="argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec
 <code>mqtt</code></br>
 <em>
 <a href="#argoproj.io/v1alpha1.MQTTEventSource">
-map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.MQTTEventSource
+map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.MQTTEventSource
 </a>
 </em>
 </td>
@@ -342,7 +342,7 @@ <h3 id="argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec
 <code>nats</code></br>
 <em>
 <a href="#argoproj.io/v1alpha1.NATSEventsSource">
-map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.NATSEventsSource
+map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.NATSEventsSource
 </a>
 </em>
 </td>
@@ -355,7 +355,7 @@ <h3 id="argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec
 <code>sns</code></br>
 <em>
 <a href="#argoproj.io/v1alpha1.SNSEventSource">
-map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.SNSEventSource
+map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.SNSEventSource
 </a>
 </em>
 </td>
@@ -368,7 +368,7 @@ <h3 id="argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec
 <code>sqs</code></br>
 <em>
 <a href="#argoproj.io/v1alpha1.SQSEventSource">
-map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.SQSEventSource
+map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.SQSEventSource
 </a>
 </em>
 </td>
@@ -381,7 +381,7 @@ <h3 id="argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec
 <code>pubSub</code></br>
 <em>
 <a href="#argoproj.io/v1alpha1.PubSubEventSource">
-map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.PubSubEventSource
+map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.PubSubEventSource
 </a>
 </em>
 </td>
@@ -394,7 +394,7 @@ <h3 id="argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec
 <code>github</code></br>
 <em>
 <a href="#argoproj.io/v1alpha1.GithubEventSource">
-map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.GithubEventSource
+map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.GithubEventSource
 </a>
 </em>
 </td>
@@ -407,7 +407,7 @@ <h3 id="argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec
 <code>gitlab</code></br>
 <em>
 <a href="#argoproj.io/v1alpha1.GitlabEventSource">
-map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.GitlabEventSource
+map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.GitlabEventSource
 </a>
 </em>
 </td>
@@ -420,7 +420,7 @@ <h3 id="argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec
 <code>hdfs</code></br>
 <em>
 <a href="#argoproj.io/v1alpha1.HDFSEventSource">
-map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.HDFSEventSource
+map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.HDFSEventSource
 </a>
 </em>
 </td>
@@ -433,7 +433,7 @@ <h3 id="argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec
 <code>slack</code></br>
 <em>
 <a href="#argoproj.io/v1alpha1.SlackEventSource">
-map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.SlackEventSource
+map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.SlackEventSource
 </a>
 </em>
 </td>
@@ -446,7 +446,7 @@ <h3 id="argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec
 <code>storageGrid</code></br>
 <em>
 <a href="#argoproj.io/v1alpha1.StorageGridEventSource">
-map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.StorageGridEventSource
+map[string]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.StorageGridEventSource
 </a>
 </em>
 </td>
@@ -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>.
 </em></p>
diff --git a/api/event-source.md b/api/event-source.md
@@ -528,7 +528,7 @@ Minio event sources
 
 <code>calendar</code></br> <em>
 <a href="#argoproj.io/v1alpha1.CalendarEventSource">
-map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.CalendarEventSource
+map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.CalendarEventSource
 </a> </em>
 
 </td>
@@ -551,7 +551,7 @@ Calendar event sources
 
 <code>file</code></br> <em>
 <a href="#argoproj.io/v1alpha1.FileEventSource">
-map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.FileEventSource
+map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.FileEventSource
 </a> </em>
 
 </td>
@@ -574,7 +574,7 @@ File event sources
 
 <code>resource</code></br> <em>
 <a href="#argoproj.io/v1alpha1.ResourceEventSource">
-map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.ResourceEventSource
+map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.ResourceEventSource
 </a> </em>
 
 </td>
@@ -619,7 +619,7 @@ Webhook event sources
 
 <code>amqp</code></br> <em>
 <a href="#argoproj.io/v1alpha1.AMQPEventSource">
-map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.AMQPEventSource
+map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.AMQPEventSource
 </a> </em>
 
 </td>
@@ -642,7 +642,7 @@ AMQP event sources
 
 <code>kafka</code></br> <em>
 <a href="#argoproj.io/v1alpha1.KafkaEventSource">
-map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.KafkaEventSource
+map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.KafkaEventSource
 </a> </em>
 
 </td>
@@ -665,7 +665,7 @@ Kafka event sources
 
 <code>mqtt</code></br> <em>
 <a href="#argoproj.io/v1alpha1.MQTTEventSource">
-map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.MQTTEventSource
+map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.MQTTEventSource
 </a> </em>
 
 </td>
@@ -688,7 +688,7 @@ MQTT event sources
 
 <code>nats</code></br> <em>
 <a href="#argoproj.io/v1alpha1.NATSEventsSource">
-map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.NATSEventsSource
+map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.NATSEventsSource
 </a> </em>
 
 </td>
@@ -711,7 +711,7 @@ NATS event sources
 
 <code>sns</code></br> <em>
 <a href="#argoproj.io/v1alpha1.SNSEventSource">
-map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.SNSEventSource
+map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.SNSEventSource
 </a> </em>
 
 </td>
@@ -734,7 +734,7 @@ SNS event sources
 
 <code>sqs</code></br> <em>
 <a href="#argoproj.io/v1alpha1.SQSEventSource">
-map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.SQSEventSource
+map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.SQSEventSource
 </a> </em>
 
 </td>
@@ -757,7 +757,7 @@ SQS event sources
 
 <code>pubSub</code></br> <em>
 <a href="#argoproj.io/v1alpha1.PubSubEventSource">
-map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.PubSubEventSource
+map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.PubSubEventSource
 </a> </em>
 
 </td>
@@ -780,7 +780,7 @@ PubSub eevnt sources
 
 <code>github</code></br> <em>
 <a href="#argoproj.io/v1alpha1.GithubEventSource">
-map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.GithubEventSource
+map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.GithubEventSource
 </a> </em>
 
 </td>
@@ -803,7 +803,7 @@ Github event sources
 
 <code>gitlab</code></br> <em>
 <a href="#argoproj.io/v1alpha1.GitlabEventSource">
-map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.GitlabEventSource
+map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.GitlabEventSource
 </a> </em>
 
 </td>
@@ -826,7 +826,7 @@ Gitlab event sources
 
 <code>hdfs</code></br> <em>
 <a href="#argoproj.io/v1alpha1.HDFSEventSource">
-map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.HDFSEventSource
+map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.HDFSEventSource
 </a> </em>
 
 </td>
@@ -849,7 +849,7 @@ HDFS event sources
 
 <code>slack</code></br> <em>
 <a href="#argoproj.io/v1alpha1.SlackEventSource">
-map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.SlackEventSource
+map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.SlackEventSource
 </a> </em>
 
 </td>
@@ -872,7 +872,7 @@ Slack event sources
 
 <code>storageGrid</code></br> <em>
 <a href="#argoproj.io/v1alpha1.StorageGridEventSource">
-map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1/.StorageGridEventSource
+map\[string\]github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1.StorageGridEventSource
 </a> </em>
 
 </td>
@@ -3483,6 +3483,7 @@ Description
 
 <p>
 
-<em> Generated with <code>gen-crd-api-reference-docs</code> . </em>
+<em> Generated with <code>gen-crd-api-reference-docs</code> on git
+commit <code>8d85191</code>. </em>
 
 </p>
diff --git a/api/gateway.html b/api/gateway.html
@@ -500,7 +500,7 @@ <h3 id="argoproj.io/v1alpha1.GatewayStatus">GatewayStatus
 <code>nodes</code></br>
 <em>
 <a href="#argoproj.io/v1alpha1.NodeStatus">
-map[string]github.com/argoproj/argo-events/pkg/apis/gateway/v1alpha1/.NodeStatus
+map[string]github.com/argoproj/argo-events/pkg/apis/gateway/v1alpha1.NodeStatus
 </a>
 </em>
 </td>
@@ -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>.
 </em></p>
diff --git a/api/gateway.md b/api/gateway.md
@@ -983,7 +983,7 @@ its phase
 <td>
 
 <code>nodes</code></br> <em> <a href="#argoproj.io/v1alpha1.NodeStatus">
-map\[string\]github.com/argoproj/argo-events/pkg/apis/gateway/v1alpha1/.NodeStatus
+map\[string\]github.com/argoproj/argo-events/pkg/apis/gateway/v1alpha1.NodeStatus
 </a> </em>
 
 </td>
@@ -1445,6 +1445,7 @@ Namespace of the sensor
 
 <p>
 
-<em> Generated with <code>gen-crd-api-reference-docs</code> . </em>
+<em> Generated with <code>gen-crd-api-reference-docs</code> on git
+commit <code>8d85191</code>. </em>
 
 </p>
diff --git a/api/sensor.html b/api/sensor.html
@@ -1812,5 +1812,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>.
 </em></p>
diff --git a/api/sensor.md b/api/sensor.md
@@ -3655,6 +3655,7 @@ VerifyCert decides whether the connection is secure or not
 
 <p>
 
-<em> Generated with <code>gen-crd-api-reference-docs</code> . </em>
+<em> Generated with <code>gen-crd-api-reference-docs</code> on git
+commit <code>8d85191</code>. </em>
 
 </p>
diff --git a/hack/update-api-docs.sh b/hack/update-api-docs.sh
@@ -0,0 +1,34 @@
+#!/bin/bash
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+# Setup at https://github.com/ahmetb/gen-crd-api-reference-docs
+
+# Event Source
+${GOPATH}/src/github.com/ahmetb/gen-crd-api-reference-docs/gen-crd-api-reference-docs \
+ -config "${GOPATH}/src/github.com/ahmetb/gen-crd-api-reference-docs/example-config.json" \
+ -api-dir "github.com/argoproj/argo-events/pkg/apis/eventsources/v1alpha1" \
+ -out-file "${GOPATH}/src/github.com/argoproj/argo-events/api/event-source.html" \
+ -template-dir "${GOPATH}/src/github.com/ahmetb/gen-crd-api-reference-docs/template"
+
+# Gateway
+${GOPATH}/src/github.com/ahmetb/gen-crd-api-reference-docs/gen-crd-api-reference-docs \
+ -config "${GOPATH}/src/github.com/ahmetb/gen-crd-api-reference-docs/example-config.json" \
+ -api-dir "github.com/argoproj/argo-events/pkg/apis/gateway/v1alpha1" \
+ -out-file "${GOPATH}/src/github.com/argoproj/argo-events/api/gateway.html" \
+ -template-dir "${GOPATH}/src/github.com/ahmetb/gen-crd-api-reference-docs/template"
+
+# Sensor
+${GOPATH}/src/github.com/ahmetb/gen-crd-api-reference-docs/gen-crd-api-reference-docs \
+ -config "${GOPATH}/src/github.com/ahmetb/gen-crd-api-reference-docs/example-config.json" \
+ -api-dir "github.com/argoproj/argo-events/pkg/apis/sensor/v1alpha1" \
+ -out-file "${GOPATH}/src/github.com/argoproj/argo-events/api/sensor.html" \
+ -template-dir "${GOPATH}/src/github.com/ahmetb/gen-crd-api-reference-docs/template"
+
+# Setup at https://pandoc.org/installing.html
+
+pandoc --from markdown --to gfm ${GOPATH}/src/github.com/argoproj/argo-events/api/event-source.html > ${GOPATH}/src/github.com/argoproj/argo-events/api/event-source.md
+pandoc --from markdown --to gfm ${GOPATH}/src/github.com/argoproj/argo-events/api/gateway.html > ${GOPATH}/src/github.com/argoproj/argo-events/api/gateway.md
+pandoc --from markdown --to gfm ${GOPATH}/src/github.com/argoproj/argo-events/api/sensor.html > ${GOPATH}/src/github.com/argoproj/argo-events/api/sensor.md
diff --git a/hack/update-codegen.sh b/hack/update-codegen.sh
@@ -1,20 +1,5 @@
 #!/bin/bash
 
-# Copyright 2017 The Kubernetes Authors.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
 set -o errexit
 set -o nounset
 set -o pipefail