Merge branch 'api-doc-template-version' into 'master'

<fix>[doc]: use project.version for api doc template

See merge request zstackio/zstack!3567

Author: gitlab

rest/src/main/resources/scripts/RestDocumentationGenerator.groovy

@@ -1,8 +1,10 @@
 package scripts
 
+
 import com.google.common.io.Resources
 import groovy.json.JsonBuilder
 import org.apache.commons.io.Charsets
+import org.apache.commons.io.FileUtils
 import org.apache.commons.lang.StringUtils
 import org.jsoup.Jsoup
 import org.jsoup.nodes.Document
@@ -12,12 +14,7 @@ import org.jsoup.select.Elements
 import org.markdown4j.Markdown4jProcessor
 import org.springframework.http.HttpMethod
 import org.zstack.core.Platform
-import org.zstack.core.config.GlobalConfig
-import org.zstack.core.config.GlobalConfigDef
-import org.zstack.core.config.GlobalConfigDefinition
-import org.zstack.core.config.GlobalConfigException
-import org.zstack.core.config.GlobalConfigValidation
-import org.zstack.core.config.GlobalConfigValidatorExtensionPoint
+import org.zstack.core.config.*
 import org.zstack.header.core.NoDoc
 import org.zstack.header.errorcode.ErrorCode
 import org.zstack.header.exception.CloudRuntimeException
@@ -30,9 +27,9 @@ import org.zstack.header.query.APIQueryMessage
 import org.zstack.header.rest.APINoSee
 import org.zstack.header.rest.RestRequest
 import org.zstack.header.rest.RestResponse
+import org.zstack.resourceconfig.BindResourceConfig
 import org.zstack.rest.RestConstants
 import org.zstack.rest.sdk.DocumentGenerator
-import org.zstack.resourceconfig.BindResourceConfig
 import org.zstack.utils.*
 import org.zstack.utils.data.StringTemplate
 import org.zstack.utils.gson.JSONObjectUtil
@@ -51,6 +48,7 @@ import java.nio.file.Paths
 import java.util.regex.Matcher
 import java.util.regex.Pattern
 import java.util.stream.Collectors
+
 /**
  * Created by xing5 on 2016/12/21.
  */
@@ -435,6 +433,8 @@ class RestDocumentationGenerator implements DocumentGenerator {
 
     String rootPath
 
+    String projectVersion
+
     Map<String, File> sourceFiles = [:]
 
     def MUTUAL_FIELDS = [
@@ -505,9 +505,25 @@ class RestDocumentationGenerator implements DocumentGenerator {
         c(emc)
     }
 
+    void tryInitVersionOfCurrentRepo() {
+        def f = new File("${rootPath}/VERSION")
+        if (!f.exists()) {
+            println("missing version file[path: ${rootPath}/VERSION]")
+            return
+        }
+
+        def versionNumber = []
+        FileUtils.readLines(f).each { String line ->
+            versionNumber.add(line.split("=")[1].trim())
+        }
+
+        projectVersion = versionNumber.join(".")
+    }
+
     @Override
     void generateDocTemplates(String scanPath, DocMode mode) {
         rootPath = scanPath
+        tryInitVersionOfCurrentRepo()
         scanJavaSourceFiles()
 
         Set<Class> apiClasses = getRequestRequestApiSet()
@@ -2081,7 +2097,7 @@ ${txt}
 \t\tname "${n}"
 \t\tdesc "${desc == null ? "" : desc}"
 \t\ttype "${type}"
-\t\tsince "0.6"
+\t\tsince "${projectVersion != null ? projectVersion : "0.6"}"
 \t}"""
         }
 
@@ -2097,7 +2113,7 @@ ${txt}
 \t\tpath "${path}"
 \t\tdesc "${desc}"${overrideDesc != null ? ",${overrideDesc}" : ""}
 \t\ttype "${type}"
-\t\tsince "0.6"
+\t\tsince "${projectVersion != null ? projectVersion : "0.6"}"
 \t\tclz ${clz.simpleName}.class
 \t}"""
         }
@@ -2273,7 +2289,7 @@ ${fieldStr}
 \t\t\t\t\tlocation "${location}"
 \t\t\t\t\ttype "${af.type.simpleName}"
 \t\t\t\t\toptional ${ap == null ? true : !ap.required()}
-\t\t\t\t\tsince "0.6"
+\t\t\t\t\tsince "${projectVersion != null ? projectVersion : "0.6"}"
 """)
                 if (values != null) {
                     cols.add("\t\t\t\t\t${values}")