Add an OpenAPI generator beside the supported client

.gitattributes

@@ -2,3 +2,7 @@
 
 # Shared test fixtures are compared byte for byte (webhook signatures): never rewrite them.
 src/test/resources/fixtures/** -text
+generated/** linguist-generated
+resources/shieldlabs-api.yaml linguist-generated
+sync.sh text eol=lf
+generate.sh text eol=lf

.github/workflows/ci.yml

@@ -37,3 +37,15 @@ jobs:
 
       - name: Compile the example against the installed SDK
         run: mvn -B -ntp -f examples/httpserver/pom.xml verify
+
+  generated:
+    name: Generated API types
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09
+        with:
+          persist-credentials: false
+      - name: Rebuild generated files
+        run: ./generate.sh
+      - name: Fail if generated files drifted
+        run: git diff --exit-code

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project are documented in this file. The format foll
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added
+
+- `sync.sh` downloads the OpenAPI description and `generate.sh` rebuilds `generated/` from it. The supported client is unchanged.
+
 ## [1.0.0] - 2026-09-30
 
 ### Added

README.md

@@ -335,6 +335,14 @@ Retries apply to GET requests only (every SDK call is a GET): exponential backof
 
 ## Development
 
+Refresh the generated client when the API description changes. This does not replace the supported library in this repository.
+
+```bash
+./sync.sh      # download the current OpenAPI description into resources/
+./generate.sh  # rebuild generated/ from that file
+```
+
+
 ```bash
 mvn verify                                   # compile with -Xlint:all -Werror, tests, coverage, javadoc
 mvn install -DskipTests && mvn -f examples/httpserver/pom.xml verify

config.json

@@ -0,0 +1,19 @@
+{
+  "groupId": "ai.shieldlabs",
+  "artifactId": "shieldlabs-generated",
+  "artifactVersion": "1.0.0",
+  "apiPackage": "ai.shieldlabs.generated.api",
+  "modelPackage": "ai.shieldlabs.generated.model",
+  "invokerPackage": "ai.shieldlabs.generated",
+  "library": "native",
+  "developerName": "ShieldLabs",
+  "developerEmail": "contact@shieldlabs.ai",
+  "developerOrganization": "ShieldLabs Inc.",
+  "developerOrganizationUrl": "https://shieldlabs.ai",
+  "licenseName": "MIT",
+  "licenseUrl": "https://opensource.org/licenses/MIT",
+  "scmConnection": "scm:git:https://github.com/ShieldLabs-ai/shieldlabs-java.git",
+  "scmDeveloperConnection": "scm:git:ssh://git@github.com/ShieldLabs-ai/shieldlabs-java.git",
+  "scmUrl": "https://github.com/ShieldLabs-ai/shieldlabs-java",
+  "hideGenerationTimestamp": true
+}

generate.sh

@@ -0,0 +1,69 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+cd "$(dirname "${BASH_SOURCE[0]}")"
+
+if ! docker info >/dev/null 2>&1; then
+  echo "Docker is not running. Start Docker and run this script again." >&2
+  exit 1
+fi
+
+generator="java"
+image="openapitools/openapi-generator-cli:v7.23.0"
+workdir="$(mktemp -d)"
+trap 'rm -rf "$workdir"' EXIT
+
+python3 - "$PWD/resources/shieldlabs-api.yaml" "$workdir/spec.yaml" << 'PY'
+import sys
+from pathlib import Path
+
+source, dest = sys.argv[1:]
+lines = Path(source).read_text().splitlines(keepends=True)
+out = []
+i = 0
+while i < len(lines):
+    if lines[i].startswith("  description:"):
+        out.append("  description: Identification results and risk scoring for your backend.\n")
+        i += 1
+        while i < len(lines) and not (lines[i].startswith("  ") and not lines[i].startswith("   ")):
+            i += 1
+        continue
+    out.append(lines[i])
+    i += 1
+Path(dest).write_text("".join(out))
+PY
+
+rm -rf generated
+mkdir -p generated
+cat > generated/.openapi-generator-ignore << 'IGN'
+README.md
+git_push.sh
+.travis.yml
+.gitignore
+docs/
+test/
+api/openapi.yaml
+.github/
+IGN
+
+docker run --rm -u "$(id -u):$(id -g)" \
+  -v "$PWD":/local -v "$workdir":/work -w /local \
+  "$image" generate \
+  -i /work/spec.yaml \
+  -g "$generator" \
+  -o /local/generated \
+  -c /local/config.json \
+  --global-property apis,models,supportingFiles,modelTests=false,apiTests=false,modelDocs=false,apiDocs=false
+
+find generated \( -name README.md -o -name '*README.md' -o -name git_push.sh -o -name .travis.yml -o -name appveyor.yml -o -name .gitignore -o -name build.sbt -o -name '*.sln' \) -delete
+rm -rf generated/docs generated/test generated/.github
+find generated -type d -empty -delete
+
+if [ "$generator" = "go" ]; then
+  docker run --rm -u "$(id -u):$(id -g)" -v "$PWD/generated":/src -w /src golang:1.24-bookworm gofmt -w .
+  cat > generated/go.mod << 'MOD'
+module github.com/ShieldLabs-ai/shieldlabs-go/generated
+
+go 1.23
+MOD
+fi