Vital API Definition

Tagging a release on this repository will update the:

• Python SDK
• Java SDK
• TypeScript SDK
• Go SDK

What is in this repository?

This repository contains

• Vital's OpenAPI spec which lives in the openapi folder
• Generators (see generators.yml)

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

npm install -g fern-api
fern check

What are generators?

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

fern generate --group java-sdk --version <release version>
fern generate --group node-sdk --version <release version>
fern generate --group python-sdk --version <release version>
fern generate --group go-sdk --version <release version>

How to preview generated SDKs locally?

fern generate --group local-preview

The generated code would be located at ./generated/.

How to generate new postman collection locally?

fern generate --group postman

The generated code would be located at ./postman/.

How to make a release?

A release happens automatically on every Vital Api prod release.