F gpu 2196

Jenkinsfile.split

@@ -18,6 +18,7 @@ properties([
 		booleanParam(name: 'runUnstableTests',    defaultValue: true,  description: "Whether to run tests in failing group."),
 		booleanParam(name: 'runPerformanceTests', defaultValue: false, description: "Whether to run performance tests."),
 		booleanParam(name: 'runClusterTests',     defaultValue: false, description: "Whether to run cluster tests."),
+		booleanParam(name: 'useOpenApiTestClient',defaultValue: false, description: "Whether to use an autogenerated OpenAPI OkHTTP 3 based REST client for the tests."),
 		booleanParam(name: 'runDeploy',           defaultValue: false, description: "Whether to run the deploy steps."),
 		booleanParam(name: 'runDeployTesting',    defaultValue: false, description: "Whether to run the testing deploy steps."),
 		booleanParam(name: 'runDocker',           defaultValue: false, description: "Whether to run the docker steps."),
@@ -68,19 +69,19 @@ final def testPart(partName, current, branches) {
 								// prior to starting the tests, start the docker containers with the db and the testdb-manager
 								sh 'docker login -u $repoUsername -p $repoPassword docker.gentics.com'
 								if (Boolean.valueOf(params.testMaria)) {
-								sh "mvn -pl :mesh-database-connector-mariadb docker:start -Dskip.mariadb.tests=${noMariadb} "
+									sh "mvn -pl :mesh-database-connector-mariadb docker:start -Dskip.mariadb.tests=${noMariadb} "
 								}
 								// run the tests
-								withEnv(["TESTCONTAINERS_RYUK_DISABLED=true", "MESH_CONSISTENCY_CHECKS=" + (Boolean.valueOf(params.consistencyChecks) ? "true" : "false"), "MAVEN_OPTS=-Xmx1g -XX:MaxMetaspaceSize=128m "]) {
+								withEnv(["TESTCONTAINERS_RYUK_DISABLED=true", "MESH_CONSISTENCY_CHECKS=" + (Boolean.valueOf(params.consistencyChecks) ? "true" : "false"), "MAVEN_OPTS=-Xmx1g -XX:MaxMetaspaceSize=128m ", "MESH_REST_CLIENT_CLASS=" + (Boolean.valueOf(params.useOpenApiTestClient) ? "com.gentics.mesh.test.openapi.OpenAPIMeshRestClient" : "")]) {
 									sh ".jenkins/run-splits.sh includes-${postfix} ${jacoco} ${partName} ${partId}"
 								}
 							} finally {
 								// finally stop the docker containers
 								if (Boolean.valueOf(params.testMaria)) {
-								sh "mvn -pl :mesh-database-connector-mariadb docker:stop -Dskip.mariadb.tests=${noMariadb} "
+									sh "mvn -pl :mesh-database-connector-mariadb docker:stop -Dskip.mariadb.tests=${noMariadb} "
+								}
 							}
 						}
-						}
 						stash name: "jacoco" + current, includes: "**/jacoco-partial.exec", allowEmpty: true
 					} finally {
 						step([$class: 'JUnitResultArchiver', testResults: '**/target/surefire-reports/*.xml'])
@@ -216,9 +217,9 @@ stage("Setup Build Environment") {
 							}
 							try {
 								withCredentials([usernamePassword(credentialsId: 'docker.gentics.com', usernameVariable: 'repoUsername', passwordVariable: 'repoPassword'),usernamePassword(credentialsId: 'gentics.gpg', usernameVariable: 'gpgKeyName', passwordVariable: 'gpgKeyPass')]) {
-									withEnv(["TESTCONTAINERS_RYUK_DISABLED=true", "MESH_CONSISTENCY_CHECKS=" + (Boolean.valueOf(params.consistencyChecks) ? "true" : "false")]) {
+									withEnv(["TESTCONTAINERS_RYUK_DISABLED=true", "MESH_CONSISTENCY_CHECKS=" + (Boolean.valueOf(params.consistencyChecks) ? "true" : "false"), "MESH_REST_CLIENT_CLASS=" + (Boolean.valueOf(params.useOpenApiTestClient) ? "com.gentics.mesh.test.openapi.OpenAPIMeshRestClient" : "")]) {
 										sh "mvn -fae -Dsurefire.excludedGroups=com.gentics.mesh.test.category.FailingTests,com.gentics.mesh.test.category.ClusterTests -Dmaven.javadoc.skip=true -Dskip.cluster.tests=true -Dmaven.test.failure.ignore=true -Dmesh.container.image.prefix=docker.gentics.com/ -Dskip.mariadb.tests=${noMariadb} -Dskip.hsqlmemory.tests=${noHsqldb} -B -U -e test"
-								}
+									}
 								}
 							} finally {
 								step([$class: 'JUnitResultArchiver', testResults: '**/target/surefire-reports/*.xml'])

api/src/main/java/com/gentics/mesh/etc/config/Format.java

@@ -0,0 +1,49 @@
+package com.gentics.mesh.etc.config;
+
+import org.apache.commons.lang3.StringUtils;
+
+/**
+ * OpenAPI output format
+ */
+public enum Format {
+	/**
+	 * Yaml
+	 */
+	YAML(0),
+	/**
+	 * JSON
+	 */
+	JSON(1);
+
+	private final int level;
+
+	private Format(int level) {
+		this.level = level;
+	}
+
+	/**
+	 * Get the filtering int value.
+	 * 
+	 * @return
+	 */
+	public int getLevel() {
+		return level;
+	}
+
+	/**
+	 * Safe parse string value
+	 * 
+	 * @param format
+	 * @param defaultValue
+	 * @return
+	 */
+	public static Format parse(String format, Format defaultValue) {
+		if (StringUtils.isNotBlank(format)) {
+			switch (format.toUpperCase()) {
+			case "YAML": return YAML;
+			case "JSON": return JSON;
+			}
+		}
+		return defaultValue;
+	}
+}

api/src/main/java/com/gentics/mesh/etc/config/MeshOptions.java

@@ -37,6 +37,7 @@ public abstract class MeshOptions implements Option {
 	public static final String MESH_CLUSTER_INIT_ENV = "MESH_CLUSTER_INIT";
 	public static final String MESH_LOCK_PATH_ENV = "MESH_LOCK_PATH";
 	public static final String MESH_LIVE_PATH_ENV = "MESH_LIVE_PATH";
+	public static final String MESH_SERVE_OPENAPI_ENV = "MESH_SERVE_OPENAPI";
 	public static final String MESH_START_IN_READ_ONLY_ENV = "MESH_START_IN_READ_ONLY";
 	public static final String MESH_INITIAL_ADMIN_PASSWORD_ENV = "MESH_INITIAL_ADMIN_PASSWORD";
 	public static final String MESH_INITIAL_ADMIN_PASSWORD_FORCE_RESET_ENV = "MESH_INITIAL_ADMIN_PASSWORD_FORCE_RESET";
@@ -152,6 +153,10 @@ public abstract class MeshOptions implements Option {
 	@EnvironmentVariable(name = MESH_MIGRATION_TRIGGER_INTERVAL, description = "Override the migration trigger interval")
 	private long migrationTriggerInterval = DEFAULT_MIGRATION_TRIGGER_INTERVAL;
 
+	@JsonProperty(required = false)
+	@EnvironmentVariable(name = MESH_SERVE_OPENAPI_ENV, description = "Serve OpenAPI specification under `/openapi*` endpoints. Default: true")
+	private boolean serveOpenApi = true;
+
 	@JsonProperty(required = true)
 	@JsonPropertyDescription("GraphQL options.")
 	private GraphQLOptions graphQLOptions = new GraphQLOptions();
@@ -272,7 +277,6 @@ public MeshOptions setMonitoringOptions(MonitoringConfig monitoringOptions) {
 		return this;
 	}
 
-
 	/**
 	 * Get the graphql options
 	 * @return graphql options
@@ -544,6 +548,15 @@ public MeshOptions setPluginUseHttp2(boolean pluginUseHttp2) {
 		return this;
 	}
 
+	public boolean isServeOpenApi() {
+		return serveOpenApi;
+	}
+
+	@Setter
+	public void setServeOpenApi(boolean serveOpenApi) {
+		this.serveOpenApi = serveOpenApi;
+	}
+
 	@JsonIgnore
 	public abstract NativeQueryFiltering getNativeQueryFiltering();
 
@@ -608,4 +621,24 @@ public void validate(MeshOptions options) {
 	}
 
 	public abstract boolean hasDatabaseLevelCache();
+
+	/**
+	 * Get default OpenAPI spec version
+	 * 
+	 * @return
+	 */
+	public abstract Version getDefaultOpenAPIVersion();
+
+	/**
+	 * Get default OpenAPI spec format
+	 * 
+	 * @return
+	 */
+	public abstract Format getDefaultOpenAPIFormat();
+
+	/**
+	 * Get the comma separated list of plugin, that should provide no API info. Can be null or empty.
+	 * @return
+	 */
+	public abstract String getNoApiInfoPlugins();
 }

api/src/main/java/com/gentics/mesh/etc/config/Version.java

@@ -0,0 +1,69 @@
+package com.gentics.mesh.etc.config;
+
+import org.apache.commons.lang3.StringUtils;
+
+/**
+ * OpenAPI specification version
+ */
+public enum Version {
+
+	/**
+	 * v3.0
+	 */
+	V30(0),
+	/**
+	 * v3.1
+	 */
+	V31(1);
+
+	private final int level;
+
+	private Version(int level) {
+		this.level = level;
+	}
+
+	/**
+	 * Get the filtering int value.
+	 * 
+	 * @return
+	 */
+	public int getLevel() {
+		return level;
+	}
+
+	/**
+	 * Safe parse string value
+	 * 
+	 * @param version
+	 * @param defaultValue
+	 * @return
+	 */
+	public static Version parse(String version, Version defaultValue) {
+		if (StringUtils.isNotBlank(version)) {
+			switch (version.toUpperCase()) {
+			case "V30": 
+			case "3.0": 
+				return V30;
+			case "V31": 
+			case "3.1": 
+				return V31;
+			}
+		}
+		return defaultValue;
+	}
+
+	/**
+	 * Pretty print the version
+	 * 
+	 * @return
+	 */
+	public String pretty() {
+		switch(this) {
+		case V30:
+			return "3.0";
+		case V31:
+			return "3.1";
+		}
+		return null;
+	}
+}

bom/pom.xml

@@ -47,6 +47,8 @@
 		<handlebars.version>4.3.1</handlebars.version>
 		<hsqldb.version>2.7.3</hsqldb.version>
 		<micrometer.version>1.15.5</micrometer.version>
+		<vertx.openapi.version>0.0.1-SNAPSHOT</vertx.openapi.version>
+		<okhttp.version>5.3.0</okhttp.version>
 	</properties>
 
 	<!-- IMPORTANT: Always keep dependencies in-sync with mesh-plugin-parent pom in order to avoid duplicate libraries in shaded plugin jars -->
@@ -108,6 +110,11 @@
 				<artifactId>commons-lang3</artifactId>
 				<version>3.18.0</version>
 			</dependency>
+			<dependency>
+				<groupId>com.gentics</groupId>
+				<artifactId>vertx-openapi</artifactId>
+				<version>${vertx.openapi.version}</version>
+			</dependency>
 			<dependency>
 				<groupId>commons-io</groupId>
 				<artifactId>commons-io</artifactId>
@@ -133,7 +140,12 @@
 			<dependency>
 				<groupId>com.squareup.okhttp3</groupId>
 				<artifactId>okhttp-jvm</artifactId>
-				<version>5.3.0</version>
+				<version>${okhttp.version}</version>
+			</dependency>
+			<dependency>
+				<groupId>com.squareup.okhttp3</groupId>
+				<artifactId>logging-interceptor</artifactId>
+				<version>${okhttp.version}</version>
 			</dependency>
 			<!-- Manage the dependency of okhttp due to Vulnerability -->
 			<dependency>
@@ -172,7 +184,7 @@
 			<dependency>
 				<groupId>com.google.code.gson</groupId>
 				<artifactId>gson</artifactId>
-				<version>2.8.9</version>
+				<version>2.10.1</version>
 			</dependency>
 
 			<!-- Tika -->
@@ -808,9 +820,9 @@
 				<version>3.2.0</version>
 			</dependency>
 			<dependency>
-			    <groupId>jakarta.persistence</groupId>
-			    <artifactId>jakarta.persistence-api</artifactId>
-			    <version>3.2.0</version>
+				<groupId>jakarta.persistence</groupId>
+				<artifactId>jakarta.persistence-api</artifactId>
+				<version>3.2.0</version>
 			</dependency>
 			<dependency>
 				<groupId>com.squareup.inject</groupId>
@@ -833,9 +845,9 @@
 				<version>${hazelcast-hibernate.version}</version>
 			</dependency>
 			<dependency>
-			      <groupId>org.hibernate.orm</groupId>
-			      <artifactId>hibernate-jcache</artifactId>
-			      <version>${hibernate.version}</version>
+				<groupId>org.hibernate.orm</groupId>
+				<artifactId>hibernate-jcache</artifactId>
+				<version>${hibernate.version}</version>
 			</dependency>
 			<dependency>
 				<groupId>org.hibernate.orm</groupId>

changelog/src/changelog/entries/2026/03/8685.GPU-2196.enhancement

@@ -0,0 +1 @@
+REST API: Along with existing RAML API definition, it is now possible to generate an OpenAPI (aka Swagger) specification for the Mesh REST API. For that, an endpoint `/openapi.yaml` has been provided.