| ... | ... |
@@ -64,7 +64,6 @@ endif |
| 64 | 64 |
hack/verify-generated-completions.sh |
| 65 | 65 |
hack/verify-generated-docs.sh |
| 66 | 66 |
hack/verify-generated-swagger-spec.sh |
| 67 |
- hack/verify-api-descriptions.sh |
|
| 68 | 67 |
.PHONY: verify |
| 69 | 68 |
|
| 70 | 69 |
# check and verify can't run concurently because of strange concurrent build issues. |
| 71 | 70 |
deleted file mode 100644 |
| ... | ... |
@@ -1,237 +0,0 @@ |
| 1 |
-## ---------------------------------------------- ## |
|
| 2 |
-## THIS WHITELIST ALLOWS FOR THE VERIFY SCRIPT TO ## |
|
| 3 |
-## SUCCEED WHILE DESCRIPTIONS ARE ADDED. IF A NEW ## |
|
| 4 |
-## DESCRIPTION IS ADDED, THE CORRESPONDING ENTRY ## |
|
| 5 |
-## IN THIS LIST SHOULD BE REMOVED. ## |
|
| 6 |
-## ADDING NEW ENTRIES TO THIS LIST IS DISALLOWED ## |
|
| 7 |
-## ---------------------------------------------- ## |
|
| 8 |
-api.patch |
|
| 9 |
-integer |
|
| 10 |
-json.watchevent |
|
| 11 |
-patch.object |
|
| 12 |
-runtime.rawextension |
|
| 13 |
-v1.awselasticblockstorevolumesource |
|
| 14 |
-v1.binarybuildsource |
|
| 15 |
-v1.binding |
|
| 16 |
-v1.build |
|
| 17 |
-v1.buildconfiglist |
|
| 18 |
-v1.buildconfigspec |
|
| 19 |
-v1.buildconfigstatus |
|
| 20 |
-v1.buildlist |
|
| 21 |
-v1.buildlog |
|
| 22 |
-v1.buildoutput |
|
| 23 |
-v1.buildrequest |
|
| 24 |
-v1.buildsource |
|
| 25 |
-v1.buildspec |
|
| 26 |
-v1.buildstatus |
|
| 27 |
-v1.buildstrategy |
|
| 28 |
-v1.buildtriggerpolicy |
|
| 29 |
-v1.capabilities |
|
| 30 |
-v1.capability |
|
| 31 |
-v1.cephfsvolumesource |
|
| 32 |
-v1.clusternetwork |
|
| 33 |
-v1.clusternetworklist |
|
| 34 |
-v1.clusterpolicy |
|
| 35 |
-v1.clusterpolicybinding |
|
| 36 |
-v1.clusterpolicybindinglist |
|
| 37 |
-v1.clusterpolicylist |
|
| 38 |
-v1.clusterrole |
|
| 39 |
-v1.clusterrolebinding |
|
| 40 |
-v1.clusterrolebindinglist |
|
| 41 |
-v1.clusterrolelist |
|
| 42 |
-v1.componentcondition |
|
| 43 |
-v1.componentstatus |
|
| 44 |
-v1.componentstatuslist |
|
| 45 |
-v1.container |
|
| 46 |
-v1.containerport |
|
| 47 |
-v1.containerstate |
|
| 48 |
-v1.containerstaterunning |
|
| 49 |
-v1.containerstateterminated |
|
| 50 |
-v1.containerstatewaiting |
|
| 51 |
-v1.containerstatus |
|
| 52 |
-v1.custombuildstrategy |
|
| 53 |
-v1.customdeploymentstrategyparams |
|
| 54 |
-v1.daemonendpoint |
|
| 55 |
-v1.deleteoptions |
|
| 56 |
-v1.deploymentcause |
|
| 57 |
-v1.deploymentcauseimagetrigger |
|
| 58 |
-v1.deploymentconfiglist |
|
| 59 |
-v1.deploymentconfigrollback |
|
| 60 |
-v1.deploymentconfigrollbackspec |
|
| 61 |
-v1.deploymentconfigspec |
|
| 62 |
-v1.deploymentconfigstatus |
|
| 63 |
-v1.deploymentdetails |
|
| 64 |
-v1.deploymentstrategy |
|
| 65 |
-v1.deploymenttriggerimagechangeparams |
|
| 66 |
-v1.deploymenttriggerpolicy |
|
| 67 |
-v1.dockerbuildstrategy |
|
| 68 |
-v1.emptydirvolumesource |
|
| 69 |
-v1.endpointaddress |
|
| 70 |
-v1.endpointport |
|
| 71 |
-v1.endpoints |
|
| 72 |
-v1.endpointslist |
|
| 73 |
-v1.endpointsubset |
|
| 74 |
-v1.envvar |
|
| 75 |
-v1.envvarsource |
|
| 76 |
-v1.event |
|
| 77 |
-v1.eventlist |
|
| 78 |
-v1.eventsource |
|
| 79 |
-v1.execaction |
|
| 80 |
-v1.execnewpodhook |
|
| 81 |
-v1.fcvolumesource |
|
| 82 |
-v1.finalizername |
|
| 83 |
-v1.flockervolumesource |
|
| 84 |
-v1.gcepersistentdiskvolumesource |
|
| 85 |
-v1.gitbuildsource |
|
| 86 |
-v1.gitrepovolumesource |
|
| 87 |
-v1.gitsourcerevision |
|
| 88 |
-v1.glusterfsvolumesource |
|
| 89 |
-v1.group |
|
| 90 |
-v1.grouplist |
|
| 91 |
-v1.handler |
|
| 92 |
-v1.hostpathvolumesource |
|
| 93 |
-v1.hostsubnet |
|
| 94 |
-v1.hostsubnetlist |
|
| 95 |
-v1.httpgetaction |
|
| 96 |
-v1.identity |
|
| 97 |
-v1.identitylist |
|
| 98 |
-v1.image |
|
| 99 |
-v1.imagechangetrigger |
|
| 100 |
-v1.imagelist |
|
| 101 |
-v1.imagestream |
|
| 102 |
-v1.imagestreamimage |
|
| 103 |
-v1.imagestreamlist |
|
| 104 |
-v1.imagestreammapping |
|
| 105 |
-v1.imagestreamspec |
|
| 106 |
-v1.imagestreamstatus |
|
| 107 |
-v1.imagestreamtag |
|
| 108 |
-v1.imagestreamtaglist |
|
| 109 |
-v1.iscsivolumesource |
|
| 110 |
-v1.lifecycle |
|
| 111 |
-v1.lifecyclehook |
|
| 112 |
-v1.limitrange |
|
| 113 |
-v1.limitrangeitem |
|
| 114 |
-v1.limitrangelist |
|
| 115 |
-v1.limitrangespec |
|
| 116 |
-v1.listmeta |
|
| 117 |
-v1.loadbalanceringress |
|
| 118 |
-v1.loadbalancerstatus |
|
| 119 |
-v1.localobjectreference |
|
| 120 |
-v1.metadatafile |
|
| 121 |
-v1.metadatavolumesource |
|
| 122 |
-v1.namedclusterrole |
|
| 123 |
-v1.namedclusterrolebinding |
|
| 124 |
-v1.namedrole |
|
| 125 |
-v1.namedrolebinding |
|
| 126 |
-v1.namedtageventlist |
|
| 127 |
-v1.namedtagreference |
|
| 128 |
-v1.namespace |
|
| 129 |
-v1.namespacelist |
|
| 130 |
-v1.namespacespec |
|
| 131 |
-v1.namespacestatus |
|
| 132 |
-v1.nfsvolumesource |
|
| 133 |
-v1.nodeaddress |
|
| 134 |
-v1.nodecondition |
|
| 135 |
-v1.nodedaemonendpoints |
|
| 136 |
-v1.nodelist |
|
| 137 |
-v1.nodespec |
|
| 138 |
-v1.nodestatus |
|
| 139 |
-v1.nodesysteminfo |
|
| 140 |
-v1.oauthaccesstoken |
|
| 141 |
-v1.oauthaccesstokenlist |
|
| 142 |
-v1.oauthauthorizetoken |
|
| 143 |
-v1.oauthauthorizetokenlist |
|
| 144 |
-v1.oauthclient |
|
| 145 |
-v1.oauthclientauthorization |
|
| 146 |
-v1.oauthclientauthorizationlist |
|
| 147 |
-v1.oauthclientlist |
|
| 148 |
-v1.objectfieldselector |
|
| 149 |
-v1.objectmeta |
|
| 150 |
-v1.objectreference |
|
| 151 |
-v1.parameter |
|
| 152 |
-v1.persistentvolumeaccessmode |
|
| 153 |
-v1.persistentvolumeclaimlist |
|
| 154 |
-v1.persistentvolumeclaimspec |
|
| 155 |
-v1.persistentvolumeclaimstatus |
|
| 156 |
-v1.persistentvolumeclaimvolumesource |
|
| 157 |
-v1.persistentvolumelist |
|
| 158 |
-v1.persistentvolumespec |
|
| 159 |
-v1.persistentvolumestatus |
|
| 160 |
-v1.podcondition |
|
| 161 |
-v1.podlist |
|
| 162 |
-v1.podspec |
|
| 163 |
-v1.podsecuritycontext |
|
| 164 |
-v1.podstatus |
|
| 165 |
-v1.podtemplate |
|
| 166 |
-v1.podtemplatelist |
|
| 167 |
-v1.podtemplatespec |
|
| 168 |
-v1.policy |
|
| 169 |
-v1.policybinding |
|
| 170 |
-v1.policybindinglist |
|
| 171 |
-v1.policylist |
|
| 172 |
-v1.policyrule |
|
| 173 |
-v1.probe |
|
| 174 |
-v1.projectlist |
|
| 175 |
-v1.projectrequest |
|
| 176 |
-v1.projectspec |
|
| 177 |
-v1.projectstatus |
|
| 178 |
-v1.rbdvolumesource |
|
| 179 |
-v1.recreatedeploymentstrategyparams |
|
| 180 |
-v1.replicationcontroller |
|
| 181 |
-v1.replicationcontrollerlist |
|
| 182 |
-v1.replicationcontrollerspec |
|
| 183 |
-v1.replicationcontrollerstatus |
|
| 184 |
-v1.resourceaccessreview |
|
| 185 |
-v1.resourcequota |
|
| 186 |
-v1.resourcequotalist |
|
| 187 |
-v1.resourcequotaspec |
|
| 188 |
-v1.resourcequotastatus |
|
| 189 |
-v1.resourcerequirements |
|
| 190 |
-v1.role |
|
| 191 |
-v1.rolebinding |
|
| 192 |
-v1.rolebindinglist |
|
| 193 |
-v1.rolelist |
|
| 194 |
-v1.rollingdeploymentstrategyparams |
|
| 195 |
-v1.routelist |
|
| 196 |
-v1.routeport |
|
| 197 |
-v1.routespec |
|
| 198 |
-v1.routestatus |
|
| 199 |
-v1.runasuserstrategyoptions |
|
| 200 |
-v1.secret |
|
| 201 |
-v1.secretlist |
|
| 202 |
-v1.secretvolumesource |
|
| 203 |
-v1.securitycontext |
|
| 204 |
-v1.securitycontextconstraints |
|
| 205 |
-v1.securitycontextconstraintslist |
|
| 206 |
-v1.selinuxcontextstrategyoptions |
|
| 207 |
-v1.selinuxoptions |
|
| 208 |
-v1.serviceaccount |
|
| 209 |
-v1.serviceaccountlist |
|
| 210 |
-v1.servicelist |
|
| 211 |
-v1.serviceport |
|
| 212 |
-v1.servicespec |
|
| 213 |
-v1.servicestatus |
|
| 214 |
-v1.sourcebuildstrategy |
|
| 215 |
-v1.sourcecontroluser |
|
| 216 |
-v1.sourcerevision |
|
| 217 |
-v1.status |
|
| 218 |
-v1.statuscause |
|
| 219 |
-v1.statusdetails |
|
| 220 |
-v1.subjectaccessreview |
|
| 221 |
-v1.tagevent |
|
| 222 |
-v1.tcpsocketaction |
|
| 223 |
-v1.template |
|
| 224 |
-v1.templatelist |
|
| 225 |
-v1.tlsconfig |
|
| 226 |
-v1.useridentitymapping |
|
| 227 |
-v1.userlist |
|
| 228 |
-v1.volume |
|
| 229 |
-v1.volumemount |
|
| 230 |
-v1.webhooktrigger |
|
| 231 |
-unversioned.status |
|
| 232 |
-unversioned.statuscause |
|
| 233 |
-unversioned.statusdetails |
|
| 234 |
-unversioned.patch |
|
| 235 |
-unversioned.listmeta |
|
| 236 |
-v1beta1.scalestatus |
|
| 237 |
-v1beta1.scalespec |
| 238 | 1 |
deleted file mode 100755 |
| ... | ... |
@@ -1,66 +0,0 @@ |
| 1 |
-#!/bin/bash |
|
| 2 |
- |
|
| 3 |
-set -o errexit |
|
| 4 |
-set -o nounset |
|
| 5 |
-set -o pipefail |
|
| 6 |
- |
|
| 7 |
-OS_ROOT=$(dirname "${BASH_SOURCE}")/..
|
|
| 8 |
-source "${OS_ROOT}/hack/common.sh"
|
|
| 9 |
- |
|
| 10 |
-cd "${OS_ROOT}"
|
|
| 11 |
- |
|
| 12 |
-DEF_MISSING=false |
|
| 13 |
-UPDATE_WHITELIST=false |
|
| 14 |
- |
|
| 15 |
-function verify-api-descriptions-for-spec () |
|
| 16 |
-{
|
|
| 17 |
- SPEC=$1 |
|
| 18 |
- echo "Verifying Descriptions for Spec: ${SPEC}"
|
|
| 19 |
- OBJECTS=$(python hack/list-swagger-objects.py ${SPEC})
|
|
| 20 |
- for object in $OBJECTS |
|
| 21 |
- do |
|
| 22 |
- desc_location="api/definitions/${object}"
|
|
| 23 |
- if [ -d "${desc_location}" ]
|
|
| 24 |
- then |
|
| 25 |
- if [ ! -s "${desc_location}/description.adoc" ]
|
|
| 26 |
- then |
|
| 27 |
- if ! grep -qx "^${object}$" hack/api-description-whitelist.txt
|
|
| 28 |
- then |
|
| 29 |
- echo "Description missing for: ${object}"
|
|
| 30 |
- DEF_MISSING=true |
|
| 31 |
- fi |
|
| 32 |
- else |
|
| 33 |
- if grep -qx "^${object}$" hack/api-description-whitelist.txt
|
|
| 34 |
- then |
|
| 35 |
- echo "Unnecessary whitelist entry for: ${object}"
|
|
| 36 |
- UPDATE_WHITELIST=true |
|
| 37 |
- fi |
|
| 38 |
- fi |
|
| 39 |
- else |
|
| 40 |
- if ! grep -q "${object}" hack/api-description-whitelist.txt
|
|
| 41 |
- then |
|
| 42 |
- echo "Description missing for: ${object}"
|
|
| 43 |
- DEF_MISSING=true |
|
| 44 |
- fi |
|
| 45 |
- fi |
|
| 46 |
- done |
|
| 47 |
-} |
|
| 48 |
- |
|
| 49 |
-SPECS="${OS_ROOT}/api/swagger-spec/*.json"
|
|
| 50 |
-for spec in $SPECS |
|
| 51 |
-do |
|
| 52 |
- verify-api-descriptions-for-spec $spec |
|
| 53 |
-done |
|
| 54 |
- |
|
| 55 |
-if $DEF_MISSING || $UPDATE_WHITELIST |
|
| 56 |
-then |
|
| 57 |
- if $DEF_MISSING |
|
| 58 |
- then |
|
| 59 |
- echo "FAILURE: Add missing descriptions to api/definitions" |
|
| 60 |
- else |
|
| 61 |
- echo "FAILURE: Prune unnecessary whitelist entries" |
|
| 62 |
- fi |
|
| 63 |
- exit 1 |
|
| 64 |
-else |
|
| 65 |
- echo SUCCESS |
|
| 66 |
-fi |
|
| 67 | 1 |
\ No newline at end of file |