Generate OpenAPI models for the workflow spec (issue #707)

.argo-ci/ci.yaml

@@ -35,7 +35,7 @@ spec:
  withItems:
  - dep ensure && make lint
  - dep ensure && make test
- - dep ensure && ./hack/verify-codegen.sh
+ - dep ensure && make verify-codegen
 
  - name: ci-builder
  inputs:

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 2.0.0-beta2 (Unreleased)
 + Add ability to specify affinity rules at both the workflow and template level
 + Add ability to specify imagePullSecrets in the workflow.spec
++ Generate OpenAPI models for the workflow spec
 - Fix issue preventing the referencing of artifacts in a container with retries
 - Fix issue preventing the use of volumes in a sidecar
 

Gopkg.toml

@@ -21,6 +21,10 @@ required = [
  name = "k8s.io/code-generator"
  branch = "release-1.9"
 
+[[constraint]]
+ name = "k8s.io/kube-openapi"
+ branch = "master"
+
 [[constraint]]
  name = "k8s.io/client-go"
  branch = "release-6.0"

Makefile

@@ -91,6 +91,11 @@ lint:
 test:
  go test ./...
 
+verify-codegen:
+ ./hack/verify-codegen.sh
+ # TODO(jessesuen) uncomment this when types.go is more stable and we are satisfied with the documentation
+ #./hack/update-openapigen.sh --verify-only
+
 clean:
  -rm -rf ${CURRENT_DIR}/dist
 

hack/update-codegen.sh

@@ -21,10 +21,6 @@ set -o pipefail
 SCRIPT_ROOT=$(dirname ${BASH_SOURCE})/..
 CODEGEN_PKG=${CODEGEN_PKG:-$(cd ${SCRIPT_ROOT}; ls -d -1 ./vendor/k8s.io/code-generator 2>/dev/null || echo ../code-generator)}
 
-# generate the code with:
-# --output-base because this script should also be able to run inside the vendor dir of
-# k8s.io/kubernetes. The output-base is needed for the generators to output into the vendor dir
-# instead of the $GOPATH directly. For normal projects this can be dropped.
 ${CODEGEN_PKG}/generate-groups.sh "deepcopy,client,informer,lister" \
  github.com/argoproj/argo/pkg/client github.com/argoproj/argo/pkg/apis \
  workflow:v1alpha1 \

hack/update-openapigen.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+PROJECT_ROOT=$(cd $(dirname "$0")/.. ; pwd)
+CODEGEN_PKG=${PROJECT_ROOT}/vendor/k8s.io/code-generator
+VERSION="v1alpha1"
+
+go run ${CODEGEN_PKG}/cmd/openapi-gen/main.go \
+ --go-header-file ${PROJECT_ROOT}/hack/custom-boilerplate.go.txt \
+ --input-dirs github.com/argoproj/argo/pkg/apis/workflow/${VERSION} \
+ --output-package github.com/argoproj/argo/pkg/apis/workflow/${VERSION} \
+ $@
+

pkg/apis/workflow/v1alpha1/doc.go

@@ -1,5 +1,5 @@
-// +k8s:deepcopy-gen=package,register
-
 // Package v1alpha1 is the v1alpha1 version of the API.
 // +groupName=argoproj.io
+// +k8s:deepcopy-gen=package,register
+// +k8s:openapi-gen=true
 package v1alpha1