Merge pull request #665 from openziti/mgmt-api

add management-api module/artifact

Author: ekoby

build.gradle.kts

@@ -24,7 +24,6 @@ plugins {
     alias(libs.plugins.kotlin).apply(false)
     alias(libs.plugins.nexus.publish)
     alias(libs.plugins.semver.git)
-    alias(libs.plugins.openapi)
 }
 
 semver {
@@ -110,31 +109,3 @@ nexusPublishing {
 }
 
 
-// generate Ziti Edge API client
-// only needed if new version was published in github.com/openziti/edge-api
-// run `./gradlew :openApiGenerate`, check build, commit, push
-val edgeApiVersion = libs.versions.ziti.api.get()
-
-openApiGenerate {
-    applyDefaults()
-
-    remoteInputSpec.set("https://raw.githubusercontent.com/openziti/edge-api/v${edgeApiVersion}/client.yml")
-    outputDir.set("$projectDir/edge-api")
-    generatorName.set("java")
-    groupId.set("org.openziti")
-    id.set("edge-api")
-    modelPackage.set("org.openziti.edge.model")
-    apiPackage.set("org.openziti.edge.api")
-    generateModelTests.set(false)
-    generateApiTests.set(false)
-    configOptions = mapOf(
-        "dateLibrary" to "java8",
-        "library" to "native",
-        "asyncNative" to true.toString(),
-    )
-}
-
-tasks.named("openApiGenerate").get().finalizedBy(":edge-api:spotlessApply")
-
-
-

edge-api/build.gradle

@@ -0,0 +1,118 @@
+
+plugins {
+    id("java")
+    id("maven-publish")
+    alias(libs.plugins.openapi)
+    alias(libs.plugins.spotless)
+}
+
+// Some text from the schema is copy/pasted into the source files as UTF-8
+// but the default still seems to be to use platform encoding
+tasks.withType<JavaCompile>().configureEach {
+    sourceCompatibility = "11"
+    targetCompatibility = "11"
+
+    options.encoding = "UTF-8"
+}
+
+tasks.withType<Javadoc>().configureEach {
+    options.encoding = "UTF-8"
+}
+
+java {
+    withSourcesJar()
+}
+
+tasks.register<Jar>("javadocJar") {
+    archiveClassifier = "javadoc"
+    from(tasks.javadoc.get().destinationDir)
+    dependsOn(tasks.javadoc)
+}
+
+
+publishing {
+    publications {
+        create<MavenPublication>(project.name) {
+            artifactId = project.name
+            from(components["java"])
+            artifact(tasks["javadocJar"])
+        }
+    }
+}
+
+val jacksonVersion = libs.versions.jackson.get()
+val jakartaAnnotationVersion = libs.versions.jakarta.annotation.get()
+
+ext {
+    description = "OpenZiti Edge API client"
+}
+
+dependencies {
+    implementation("com.google.code.findbugs:jsr305:3.0.2")
+    implementation(libs.jackson.core)
+    implementation(libs.jackson.annotations)
+    implementation(libs.jackson.bind)
+    implementation(libs.jackson.datatype)
+    implementation("org.openapitools:jackson-databind-nullable:0.2.6")
+    implementation("jakarta.annotation:jakarta.annotation-api:$jakartaAnnotationVersion")
+}
+
+
+// generate Ziti Edge API client
+// only needed if new version was published in github.com/openziti/edge-api
+// run `./gradlew :openApiGenerate`, check build, commit, push
+val edgeApiVersion = libs.versions.ziti.api.get()
+
+openApiGenerate {
+    applyDefaults()
+
+    remoteInputSpec.set("https://raw.githubusercontent.com/openziti/edge-api/v${edgeApiVersion}/client.yml")
+    version.set(project.version.toString())
+    outputDir.set("$projectDir")
+    generatorName.set("java")
+    groupId.set("org.openziti")
+    id.set("edge-api")
+    modelPackage.set("org.openziti.edge.model")
+    apiPackage.set("org.openziti.edge.api")
+    generateModelTests.set(false)
+    generateApiTests.set(false)
+    configOptions = mapOf(
+        "dateLibrary" to "java8",
+        "library" to "native",
+        "asyncNative" to true.toString(),
+    )
+}
+
+
+tasks.named("openApiGenerate").get().finalizedBy("spotlessApply")
+// Use spotless plugin to automatically format code, remove unused import, etc
+// To apply changes directly to the file, run `gradlew spotlessApply`
+// Ref: https://github.com/diffplug/spotless/tree/main/plugin-gradle
+spotless {
+    // comment out below to run spotless as part of the `check` task
+//    enforceCheck = false
+    format("misc") {
+        // define the files (e.g. '*.gradle', '*.md') to apply `misc` to
+        target(".gitignore")
+        // define the steps to apply to those files
+        trimTrailingWhitespace()
+        leadingTabsToSpaces() // Takes an integer argument if you don't like 4
+        endWithNewline()
+    }
+    java {
+        // don't need to set target, it is inferred from java
+        // apply a specific flavor of google-java-format
+        googleJavaFormat("1.22.0").aosp().reflowLongStrings()
+        removeUnusedImports()
+        importOrder()
+    }
+}
+
+
+tasks.named("spotlessApply").get().mustRunAfter("openApiGenerate")
+tasks.named("spotlessJava").get().mustRunAfter("openApiGenerate")
+tasks.named("spotlessMisc").get().mustRunAfter("openApiGenerate")
+
+apply(from = rootProject.file("publish.gradle"))
+
+

edge-api/build.gradle.kts

@@ -0,0 +1,35 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
+
+settings.gradle
+build.sbt
+git_push.sh
+pom.xml
+gradle*
+.gitignore
+.travis.yml
+.github/
+gradle/
+
+build.gradle