chore: reduce release merge conflicts by stabilizing OpenAPI client headers (#507)

Author: FelixTJDietrich

package.json

@@ -11,7 +11,7 @@
     "generate:api:application-server": "npm run generate:api:application-server:specs && npm run generate:api:application-server:client",
     "generate:api:intelligence-service:clean": "shx rm -rf server/application-server/src/main/java/de/tum/in/www1/hephaestus/intelligenceservice",
     "generate:api:intelligence-service:specs": "cd server/intelligence-service && poetry run openapi",
-    "generate:api:intelligence-service:client": "npx openapi-generator-cli generate -i server/intelligence-service/openapi.yaml -g java --library resttemplate --api-package de.tum.in.www1.hephaestus.intelligenceservice.api --model-package de.tum.in.www1.hephaestus.intelligenceservice.model --invoker-package de.tum.in.www1.hephaestus.intelligenceservice --additional-properties useJakartaEe=true,performBeanValidation=true,hideGenerationTimestamp=true,openApiNullable=true,serializationLibrary=jackson --package-name de.tum.in.www1.hephaestus.intelligenceservice -o tmp/java-client && shx mkdir -p server/application-server/src/main/java/de/tum/in/www1/hephaestus && shx cp -r tmp/java-client/src/main/java/de/tum/in/www1/hephaestus/intelligenceservice server/application-server/src/main/java/de/tum/in/www1/hephaestus/ && shx rm -rf tmp",
+    "generate:api:intelligence-service:client": "npx openapi-generator-cli generate -i server/intelligence-service/openapi.yaml -g java --library resttemplate --api-package de.tum.in.www1.hephaestus.intelligenceservice.api --model-package de.tum.in.www1.hephaestus.intelligenceservice.model --invoker-package de.tum.in.www1.hephaestus.intelligenceservice --additional-properties useJakartaEe=true,performBeanValidation=true,hideGenerationTimestamp=true,openApiNullable=true,serializationLibrary=jackson --package-name de.tum.in.www1.hephaestus.intelligenceservice -o tmp/java-client && shx mkdir -p server/application-server/src/main/java/de/tum/in/www1/hephaestus && shx cp -r tmp/java-client/src/main/java/de/tum/in/www1/hephaestus/intelligenceservice server/application-server/src/main/java/de/tum/in/www1/hephaestus/ && shx rm -rf tmp && node scripts/postprocess-openapi-java.mjs",
     "generate:api:intelligence-service": "npm run generate:api:intelligence-service:clean && npm run generate:api:intelligence-service:specs && npm run generate:api:intelligence-service:client",
     "generate:api": "npm run generate:api:intelligence-service && npm run generate:api:application-server",
     "format:java": "prettier --write server/application-server/src/**/*.java --config-precedence prefer-file --config server/application-server/.prettierrc.yaml --ignore-path server/application-server/.prettierignore",

scripts/postprocess-openapi-java.mjs

@@ -0,0 +1,86 @@
+#!/usr/bin/env node
+import { promises as fs } from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const repoRoot = path.resolve(__dirname, '..');
+const targetDir = path.join(
+  repoRoot,
+  'server',
+  'application-server',
+  'src',
+  'main',
+  'java',
+  'de',
+  'tum',
+  'in',
+  'www1',
+  'hephaestus',
+  'intelligenceservice',
+);
+
+const replacementText =
+  'The version of the OpenAPI document is defined in server/intelligence-service/openapi.yaml.';
+
+async function walk(dir) {
+  const entries = await fs.readdir(dir, { withFileTypes: true });
+  const files = await Promise.all(
+    entries.map(async (entry) => {
+      const fullPath = path.join(dir, entry.name);
+      if (entry.isDirectory()) {
+        return walk(fullPath);
+      }
+      if (entry.isFile() && entry.name.endsWith('.java')) {
+        return [fullPath];
+      }
+      return [];
+    }),
+  );
+  return files.flat();
+}
+
+async function processFile(filePath) {
+  const content = await fs.readFile(filePath, 'utf8');
+  if (!content.includes('The version of the OpenAPI document:')) {
+    return false;
+  }
+  const updated = content.replace(
+    /^\s*\* The version of the OpenAPI document.*$/gm,
+    ` * ${replacementText}`,
+  );
+  if (updated === content) {
+    return false;
+  }
+  await fs.writeFile(filePath, updated, 'utf8');
+  return true;
+}
+
+async function main() {
+  try {
+    await fs.access(targetDir);
+  } catch (error) {
+    if (error && error.code === 'ENOENT') {
+      console.warn(`Target directory not found: ${targetDir}`);
+      return;
+    }
+    throw error;
+  }
+
+  const javaFiles = await walk(targetDir);
+  let changedCount = 0;
+
+  for (const file of javaFiles) {
+    if (await processFile(file)) {
+      changedCount += 1;
+    }
+  }
+
+  console.log(`Processed ${javaFiles.length} Java files. Updated ${changedCount} files.`);
+}
+
+main().catch((error) => {
+  console.error(error);
+  process.exitCode = 1;
+});

server/application-server/src/main/java/de/tum/in/www1/hephaestus/intelligenceservice/JavaTimeFormatter.java

@@ -2,7 +2,7 @@
  * Hephaestus Intelligence Service API
  * API documentation for the Hephaestus Intelligence Service.
  *
- * The version of the OpenAPI document: 0.9.2-rc.1
+ * The version of the OpenAPI document is defined in server/intelligence-service/openapi.yaml.
  * Contact: felixtj.dietrich@tum.de
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

server/application-server/src/main/java/de/tum/in/www1/hephaestus/intelligenceservice/RFC3339DateFormat.java

@@ -2,7 +2,7 @@
  * Hephaestus Intelligence Service API
  * API documentation for the Hephaestus Intelligence Service.
  *
- * The version of the OpenAPI document: 0.9.2-rc.1
+ * The version of the OpenAPI document is defined in server/intelligence-service/openapi.yaml.
  * Contact: felixtj.dietrich@tum.de
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

server/application-server/src/main/java/de/tum/in/www1/hephaestus/intelligenceservice/model/BadPractice.java

@@ -2,7 +2,7 @@
  * Hephaestus Intelligence Service API
  * API documentation for the Hephaestus Intelligence Service.
  *
- * The version of the OpenAPI document: 0.9.2-rc.1
+ * The version of the OpenAPI document is defined in server/intelligence-service/openapi.yaml.
  * Contact: felixtj.dietrich@tum.de
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

server/application-server/src/main/java/de/tum/in/www1/hephaestus/intelligenceservice/model/BadPracticeStatus.java

@@ -2,7 +2,7 @@
  * Hephaestus Intelligence Service API
  * API documentation for the Hephaestus Intelligence Service.
  *
- * The version of the OpenAPI document: 0.9.2-rc.1
+ * The version of the OpenAPI document is defined in server/intelligence-service/openapi.yaml.
  * Contact: felixtj.dietrich@tum.de
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

server/application-server/src/main/java/de/tum/in/www1/hephaestus/intelligenceservice/model/ChatRequest.java

@@ -2,7 +2,7 @@
  * Hephaestus Intelligence Service API
  * API documentation for the Hephaestus Intelligence Service.
  *
- * The version of the OpenAPI document: 0.9.2-rc.1
+ * The version of the OpenAPI document is defined in server/intelligence-service/openapi.yaml.
  * Contact: felixtj.dietrich@tum.de
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

server/application-server/src/main/java/de/tum/in/www1/hephaestus/intelligenceservice/model/ChatResponse.java

@@ -2,7 +2,7 @@
  * Hephaestus Intelligence Service API
  * API documentation for the Hephaestus Intelligence Service.
  *
- * The version of the OpenAPI document: 0.9.2-rc.1
+ * The version of the OpenAPI document is defined in server/intelligence-service/openapi.yaml.
  * Contact: felixtj.dietrich@tum.de
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

server/application-server/src/main/java/de/tum/in/www1/hephaestus/intelligenceservice/model/CreateDocumentInput.java

@@ -2,7 +2,7 @@
  * Hephaestus Intelligence Service API
  * API documentation for the Hephaestus Intelligence Service.
  *
- * The version of the OpenAPI document: 0.9.2-rc.1
+ * The version of the OpenAPI document is defined in server/intelligence-service/openapi.yaml.
  * Contact: felixtj.dietrich@tum.de
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

server/application-server/src/main/java/de/tum/in/www1/hephaestus/intelligenceservice/model/CreateDocumentOutput.java

@@ -2,7 +2,7 @@
  * Hephaestus Intelligence Service API
  * API documentation for the Hephaestus Intelligence Service.
  *
- * The version of the OpenAPI document: 0.9.2-rc.1
+ * The version of the OpenAPI document is defined in server/intelligence-service/openapi.yaml.
  * Contact: felixtj.dietrich@tum.de
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).