Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 1.62 KB

README.md

File metadata and controls

56 lines (36 loc) · 1.62 KB
Raw

Hookdeck OpenAPI Schema

In addition to the standard uses of OpenAPI schema, the Hookdeck OpenAPI schema is used to generate our SDKS using Fern:

What is in this repository?

This repository contains

  • Hookdeck's API Definition which lives in the root directory and contains some Fern specific extensions
  • Generators used to generate the SDK (see generators.yml)

About Fern

Fern is used to generate our SDKs from the OpenAPI specification.

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.

Local preview

You can preview the generated code in the ./local/go/generated/hookdeck-go-sdk directory by running the following command:

fern generate --group local

Validating your API Definition

To validate your API, run:

npm install -g fern-api # only required once
fern check

Updating your SDKs

To update your SDKs, run fern generate.

npm install -g fern-api # only required once
fern generate --group node-sdk

This repository contains Github Actions that will trigger SDK generation. Check them out by navigating to the Actions tab and clicking Release TypeScript SDK.