Skip to content

INTER-2472: Update schema URL in sync script #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
erayaydin merged 2 commits into from
Sep 29, 2026
Merged

INTER-2472: Update schema URL in sync script #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bdd09e2
chore: update schema URL and harden sync script
erayaydin Sep 24, 2026
e509c6d
chore: rename baseDestination to exampleBaseDestination
erayaydin Sep 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Use the Gradle build to invoke `openapi-generator` and generate the code and doc
./gradlew build
```

To download the latest OpenAPI schema from [fingerprintjs/fingerprint-pro-server-api-openapi](https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi), run `./scripts/sync.sh`
To download the latest OpenAPI schema from [fingerprintjs/openapi](https://github.com/fingerprintjs/openapi), run `./scripts/sync.sh`

### Updating the codegen engine and templates

Expand Down
37 changes: 31 additions & 6 deletions scripts/sync.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,28 @@
#!/usr/bin/env bash
set -euo pipefail

set -ex
# Resolve paths relative to the repository root, so the script can be run from
# any working directory.
cd "$(dirname "${BASH_SOURCE[0]}")/.."

curl -fsSL -o ./res/fingerprint-server-api.yaml https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas/fingerprint-server-api-v4.yaml
defaultBaseUrl="https://fingerprintjs.github.io/openapi"
schemaUrl="${1:-$defaultBaseUrl/schemas/fingerprint-server-api-v4.yaml}"
examplesBaseUrl="${2:-$defaultBaseUrl/examples}"

examplesList=(
CURL_OPTS=(-fSL --retry 3 --proto-redir '=https' --connect-timeout 10 --max-time 300)
if [[ "${TRACE:-}" != "true" && "${ACTIONS_STEP_DEBUG:-}" != "true" ]]; then
CURL_OPTS+=(-s)
fi

schemaDestination="./res/fingerprint-server-api.yaml"
exampleBaseDestination="./sdk/src/test/resources/mocks"

mkdir -p "$(dirname "$schemaDestination")"

echo "Downloading $schemaUrl to $schemaDestination"
curl "${CURL_OPTS[@]}" -o "$schemaDestination" "$schemaUrl"

examples=(
'webhook/webhook_event.json'
'events/get_event_200.json'
'events/get_event_ruleset_200.json'
Expand Down Expand Up @@ -36,6 +54,13 @@ examplesList=(
'errors/500_internal_server_error.json'
)

for example in "${examplesList[@]}"; do
curl --create-dirs -fsSL -o ./sdk/src/test/resources/mocks/"$example" https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/examples/"$example"
done
for example in "${examples[@]}"; do
destinationPath="$exampleBaseDestination/$example"
mkdir -p "$(dirname "$destinationPath")"

exampleUrl="$examplesBaseUrl/$example"
echo "Downloading $exampleUrl to $destinationPath"
curl "${CURL_OPTS[@]}" -o "$destinationPath" "$exampleUrl"
done

echo "All OpenAPI schema downloads complete."
Loading