Skip to content

Hookdeck's API Definition, which is used to generate SDKs.

Notifications You must be signed in to change notification settings

hookdeck/hookdeck-api-schema

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

59 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hookdeck API

Tagging a release on this repository will:

  • Update the Go SDK
  • More SDKs to come...

What is in this repository?

This repository contains

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

Publishing

To trigger the generators run:

fern release <version>

The publish command currently runs in a GitHub workflow (see ci.yml). To trigger the generators using Github Actions:

1. Click on Releases

Step 1 screenshot

2. Click on Draft a new release

Step 2 screenshot

3. Click on Choose a tag

Step 3 screenshot

4. Specify a version

This version string is used when publishing SDKs to registries (e.g. npm, maven).

Step 4 screenshot

5. In the title, re-enter the version number

Step 5 screenshot

6. Click on Publish release

Step 6 screenshot

7. Click on Actions

See the Actions that will run fern generate.

Step 7 screenshot



About

Hookdeck's API Definition, which is used to generate SDKs.

Resources

Code of conduct

Stars

Watchers

Forks

Languages