Squidex API

Tagging a release on this repository will update the:

• Node.js SDK repo
• Java SDK repo

What is in this repository?

This repository contains

• Squidex's OpenAPI specs which lives in the definition folder
• Generators (see generators.yml)

To make sure that the OpenAPI is valid, you can use the Fern CLI.

npm install -g fern-api # Installs CLI
fern check # Checks if the definition is valid

What are generators?

Generators read in your API Definition and output artifacts (e.g. the TypeScript SDK Generator) and are tracked in generators.yml.

To trigger the generators run:

# output generated files locally
fern generate

# publish generated files
fern generate --group publish --version <version>

The publish command currently runs in a GitHub workflow (see ci.yml)