@@ -65,6 +65,7 @@ check-test:

 	hack/verify-generated-completions.sh

 	hack/verify-generated-docs.sh

 	hack/verify-generated-swagger-spec.sh

+	hack/verify-api-descriptions.sh

 	hack/test-cmd.sh

 	KUBE_RACE=" " hack/test-integration.sh

 .PHONY: check-test

@@ -93,6 +94,7 @@ test:

 	hack/verify-generated-completions.sh

 	hack/verify-generated-docs.sh

 	hack/verify-generated-swagger-spec.sh

+	hack/verify-api-descriptions.sh

 	hack/test-cmd.sh

 	KUBE_RACE=" " hack/test-integration-docker.sh

 	hack/test-end-to-end-docker.sh

new file mode 100644

@@ -0,0 +1,221 @@

+## ---------------------------------------------- ##

+## THIS WHITELIST ALLOWS FOR THE VERIFY SCRIPT TO ##

+## SUCCEED WHILE DESCRIPTIONS ARE ADDED. IF A NEW ##

+## DESCRIPTION IS ADDED, THE CORRESPONDING ENTRY  ##

+## IN THIS LIST SHOULD BE REMOVED.                ##

+## ADDING NEW ENTRIES TO THIS LIST IS DISALLOWED  ##

+## ---------------------------------------------- ##

+api.patch

+integer

+json.watchevent

+patch.object

+runtime.rawextension

+v1.awselasticblockstorevolumesource

+v1.binding

+v1.build

+v1.buildconfiglist

+v1.buildconfigspec

+v1.buildconfigstatus

+v1.buildlist

+v1.buildlog

+v1.buildoutput

+v1.buildrequest

+v1.buildsource

+v1.buildspec

+v1.buildstatus

+v1.buildstrategy

+v1.buildtriggerpolicy

+v1.capabilities

+v1.capability

+v1.cephfsvolumesource

+v1.clusternetwork

+v1.clusternetworklist

+v1.clusterpolicy

+v1.clusterpolicybinding

+v1.clusterpolicybindinglist

+v1.clusterpolicylist

+v1.clusterrole

+v1.clusterrolebinding

+v1.clusterrolebindinglist

+v1.clusterrolelist

+v1.componentcondition

+v1.componentstatus

+v1.componentstatuslist

+v1.container

+v1.containerport

+v1.containerstate

+v1.containerstaterunning

+v1.containerstateterminated

+v1.containerstatewaiting

+v1.containerstatus

+v1.custombuildstrategy

+v1.customdeploymentstrategyparams

+v1.deleteoptions

+v1.deploymentcause

+v1.deploymentcauseimagetrigger

+v1.deploymentconfiglist

+v1.deploymentconfigrollback

+v1.deploymentconfigrollbackspec

+v1.deploymentconfigspec

+v1.deploymentconfigstatus

+v1.deploymentdetails

+v1.deploymentstrategy

+v1.deploymenttriggerimagechangeparams

+v1.deploymenttriggerpolicy

+v1.dockerbuildstrategy

+v1.emptydirvolumesource

+v1.endpointaddress

+v1.endpointport

+v1.endpoints

+v1.endpointslist

+v1.endpointsubset

+v1.envvar

+v1.envvarsource

+v1.event

+v1.eventlist

+v1.eventsource

+v1.execaction

+v1.execnewpodhook

+v1.finalizername

+v1.gcepersistentdiskvolumesource

+v1.gitbuildsource

+v1.gitrepovolumesource

+v1.gitsourcerevision

+v1.glusterfsvolumesource

+v1.group

+v1.grouplist

+v1.handler

+v1.hostpathvolumesource

+v1.hostsubnet

+v1.hostsubnetlist

+v1.httpgetaction

+v1.identity

+v1.identitylist

+v1.image

+v1.imagechangetrigger

+v1.imagelist

+v1.imagestream

+v1.imagestreamimage

+v1.imagestreamlist

+v1.imagestreammapping

+v1.imagestreamspec

+v1.imagestreamstatus

+v1.imagestreamtag

+v1.iscsivolumesource

+v1.lifecycle

+v1.lifecyclehook

+v1.limitrange

+v1.limitrangeitem

+v1.limitrangelist

+v1.limitrangespec

+v1.listmeta

+v1.loadbalanceringress

+v1.loadbalancerstatus

+v1.localobjectreference

+v1.metadatafile

+v1.metadatavolumesource

+v1.namedclusterrole

+v1.namedclusterrolebinding

+v1.namedrole

+v1.namedrolebinding

+v1.namedtageventlist

+v1.namedtagreference

+v1.namespace

+v1.namespacelist

+v1.namespacespec

+v1.namespacestatus

+v1.nfsvolumesource

+v1.nodeaddress

+v1.nodecondition

+v1.nodelist

+v1.nodespec

+v1.nodestatus

+v1.nodesysteminfo

+v1.oauthaccesstoken

+v1.oauthaccesstokenlist

+v1.oauthauthorizetoken

+v1.oauthauthorizetokenlist

+v1.oauthclient

+v1.oauthclientauthorization

+v1.oauthclientauthorizationlist

+v1.oauthclientlist

+v1.objectfieldselector

+v1.objectmeta

+v1.objectreference

+v1.parameter

+v1.persistentvolumeaccessmode

+v1.persistentvolumeclaimlist

+v1.persistentvolumeclaimspec

+v1.persistentvolumeclaimstatus

+v1.persistentvolumeclaimvolumesource

+v1.persistentvolumelist

+v1.persistentvolumespec

+v1.persistentvolumestatus

+v1.podcondition

+v1.podlist

+v1.podspec

+v1.podstatus

+v1.podtemplate

+v1.podtemplatelist

+v1.podtemplatespec

+v1.policy

+v1.policybinding

+v1.policybindinglist

+v1.policylist

+v1.policyrule

+v1.probe

+v1.projectlist

+v1.projectrequest

+v1.projectspec

+v1.projectstatus

+v1.rbdvolumesource

+v1.recreatedeploymentstrategyparams

+v1.replicationcontroller

+v1.replicationcontrollerlist

+v1.replicationcontrollerspec

+v1.replicationcontrollerstatus

+v1.resourceaccessreview

+v1.resourcequota

+v1.resourcequotalist

+v1.resourcequotaspec

+v1.resourcequotastatus

+v1.resourcerequirements

+v1.role

+v1.rolebinding

+v1.rolebindinglist

+v1.rolelist

+v1.rollingdeploymentstrategyparams

+v1.routespec

+v1.routestatus

+v1.runasuserstrategyoptions

+v1.secret

+v1.secretlist

+v1.secretvolumesource

+v1.securitycontext

+v1.securitycontextconstraints

+v1.securitycontextconstraintslist

+v1.selinuxcontextstrategyoptions

+v1.selinuxoptions

+v1.serviceaccount

+v1.serviceaccountlist

+v1.servicelist

+v1.serviceport

+v1.servicespec

+v1.servicestatus

+v1.sourcebuildstrategy

+v1.sourcecontroluser

+v1.sourcerevision

+v1.status

+v1.statuscause

+v1.statusdetails

+v1.subjectaccessreview

+v1.tagevent

+v1.tcpsocketaction

+v1.template

+v1.templatelist

+v1.tlsconfig

+v1.useridentitymapping

+v1.userlist

+v1.volume

+v1.volumemount

+v1.webhooktrigger

new file mode 100644

@@ -0,0 +1,13 @@

+import json;

+import sys;

+import string;

+

+if len(sys.argv)!=2:

+	print("Useage: python hack/list-swagger-objects.py <swagger-spec-location>")

+	sys.exit(1)

+

+swagger_spec_location=sys.argv[1]

+

+with open(swagger_spec_location, 'r') as source:

+	for model in json.load(source)["models"]:

+		print(string.lower(model))

\ No newline at end of file

@@ -61,8 +61,15 @@ popd > /dev/null

 wait_for_url "${HOST}/healthz" "apiserver: " 0.25 80

 echo "Updating ${SWAGGER_SPEC_OUT_DIR}:"

-echo "Updating ${SWAGGER_SPEC_OUT_DIR}/oapi-v1.json from ${SWAGGER_API_PATH}oapi/v1..."

-curl "${SWAGGER_API_PATH}oapi/v1" > "${SWAGGER_SPEC_OUT_DIR}/oapi-v1.json"

-echo "Updating ${SWAGGER_SPEC_OUT_DIR}/api-v1.json from ${SWAGGER_API_PATH}api/v1..."

-curl "${SWAGGER_API_PATH}api/v1" > "${SWAGGER_SPEC_OUT_DIR}/api-v1.json"

+

+ENDPOINT_TYPES="oapi api"

+for type in $ENDPOINT_TYPES

+do

+    ENDPOINTS=$(curl "${HOST}" | grep -Po "(?<=\/${type}\/)[a-z0-9]+" | sed '/v1beta3/d')

+    for endpoint in $ENDPOINTS

+    do

+        echo "Updating ${SWAGGER_SPEC_OUT_DIR}/${type}-${endpoint}.json from ${SWAGGER_API_PATH}${type}/${endpoint}..."

+        curl "${SWAGGER_API_PATH}${type}/${endpoint}" > "${SWAGGER_SPEC_OUT_DIR}/${type}-${endpoint}.json"    

+    done

+done

 echo "SUCCESS"

\ No newline at end of file

new file mode 100755

@@ -0,0 +1,66 @@

+#!/bin/bash

+

+set -o errexit

+set -o nounset

+set -o pipefail

+

+OS_ROOT=$(dirname "${BASH_SOURCE}")/..

+source "${OS_ROOT}/hack/common.sh"

+

+cd "${OS_ROOT}"

+

+DEF_MISSING=false

+UPDATE_WHITELIST=false

+

+function verify-api-descriptions-for-spec ()

+{

+	SPEC=$1

+	echo "Verifying Descriptions for Spec: ${SPEC}"

+	OBJECTS=$(python hack/list-swagger-objects.py ${SPEC})

+	for object in $OBJECTS

+	do

+		desc_location="api/definitions/${object}"

+		if [ -d "${desc_location}" ]

+		then

+			if [ ! -s "${desc_location}/description.adoc" ]

+			then

+				if ! grep -qx "^${object}$" hack/api-description-whitelist.txt

+				then

+					echo "Description missing for: ${object}"

+					DEF_MISSING=true

+				fi

+			else

+				if grep -qx "^${object}$" hack/api-description-whitelist.txt

+				then

+					echo "Unnecessary whitelist entry for: ${object}"

+					UPDATE_WHITELIST=true

+				fi

+			fi

+		else

+			if ! grep -q "${object}" hack/api-description-whitelist.txt

+			then

+				echo "Description missing for: ${object}"

+				DEF_MISSING=true

+			fi

+		fi

+	done

+}

+

+SPECS="${OS_ROOT}/api/swagger-spec/*.json"

+for spec in $SPECS

+do

+	verify-api-descriptions-for-spec $spec

+done

+

+if $DEF_MISSING || $UPDATE_WHITELIST

+then

+	if $DEF_MISSING

+	then

+		echo "FAILURE: Add missing descriptions to api/definitions"

+	else

+		echo "FAILURE: Prune unnecessary whitelist entries"

+	fi

+	exit 1

+else

+	echo SUCCESS

+fi

\ No newline at end of file