README.md

Raven API

Tagging a release on this repository will update the:

• TypeScript SDK repo
• Java SDK repo
• Postman collection repo
• OpenAPI spec repo
• More SDKs to come...

What is in this repository?

This repository contains

• Raven's Fern API Definition which lives in the definition folder
• Generators (see generators.yml)

What is in the API Definition?

The API Definition contains information about what endpoints, types, and errors are used in the API. The definition is broken into smaller files such as device.yml.

In order to make sure that the definition 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 files or code (i.e. 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 <0.0.x>

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