Merge pull request #22 from hookdeck/dsheridan/update-openapi-spec

Improvement: Update OpenAPI spec

Author: dannysheridan

.github/workflows/check.yml

@@ -0,0 +1,20 @@
+name: fern-check
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install Fern
+        run: npm install -g fern-api
+
+      - name: Check API is valid
+        run: fern check

.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: generate-sdks
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install Fern
+        run: npm install -g fern-api
+
+      - name: Generate Go SDK
+        env:
+          FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
+        run: |
+          fern generate --group publish --log-level debug --version ${{ github.ref_name }}

.github/workflows/generate-sdks.yml

@@ -2,19 +2,15 @@
 
 Tagging a release on this repository will:
 
-- Update the [Go SDK GitHub Repo](https://github.com/hookdeck/hookdeck-go-sdk)
+- Update the [Go SDK](https://github.com/hookdeck/hookdeck-go-sdk)
 - _More SDKs to come..._
 
 ## What is in this repository?
 
 This repository contains
 
-- Hookdeck's Fern API Definition which lives in the [definition](./fern/api/definition/) folder
-- Generators (see [generators.yml](./fern/api/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 [connection.yml](fern/api/definition/connection.yml) and [event.yml](fern/api/definition/event.yml).
+- Hookdeck's Fern API Definition which lives in the [OpenApi](./fern/openapi/) folder
+- Generators (see [generators.yml](./fern/generators.yml))
 
 In order to make sure that the definition is valid, you can use the Fern CLI.
 
@@ -25,7 +21,7 @@ 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](./fern/api/generators.yml).
+Generators read in your API Definition and output files or code (i.e. the TypeScript SDK Generator) and are tracked in [generators.yml](./fern/generators.yml).
 
 ### Local preview
 

.vscode/settings.json

@@ -1,4 +1,4 @@
 {
   "organization": "hookdeck",
-  "version": "0.15.0-rc17"
+  "version": "0.16.36"
 }

README.md

@@ -2,7 +2,7 @@ groups:
   local:
     generators:
       - name: fernapi/fern-go-sdk
-        version: 0.6.1
+        version: 0.9.4
         config:
           enableExplicitNull: true
           module:
@@ -13,7 +13,7 @@ groups:
   publish:
     generators:
       - name: fernapi/fern-go-sdk
-        version: 0.6.1
+        version: 0.9.4
         config:
           enableExplicitNull: true
         github: