feat(next): update generated core and public clients from Katapult 2.…

…68.0 schemas (#179) Also update the generate.sh script to print some basic information about what it is doing.
krystal · Nov 29, 2024 · 4c8efb9 · 4c8efb9
1 parent 7af4d65
commit 4c8efb9
Show file tree

Hide file tree

Showing 5 changed files with 101 additions and 18 deletions.
diff --git a/next/client.go b/next/client.go
@@ -7,6 +7,8 @@ import (
 	"github.com/krystal/go-katapult/next/public"
 )
 
+//go:generate ./generate.sh
+
 type Client struct {
 	Core   core.ClientInterface
 	Public public.ClientInterface

diff --git a/next/core/core.go b/next/core/core.go
diff --git a/next/generate.sh b/next/generate.sh
@@ -1,9 +1,16 @@
 #!/bin/bash
 
+echo "Generating Core and Public clients using OpenAPI specs"
 
-go_version=$(grep goVersion generator-config.yml | cut -d':' -f2 | tr -d '[:space:]')
-generator_version=$(grep generatorVersion generator-config.yml | cut -d':' -f2 | tr -d '[:space:]')
+go_version="$(grep goVersion generator-config.yml | cut -d':' -f2 | tr -d '[:space:]')"
+generator_version="$(grep generatorVersion generator-config.yml | cut -d':' -f2 | tr -d '[:space:]')"
+core_api_version="$(jq -r '.info."x-katapult-version"' katapult-core-openapi.json)"
+public_api_version="$(jq -r '.info."x-katapult-version"' katapult-public-openapi.json)"
 
+echo " -> Using Go version: $go_version"
+echo " -> Using OpenAPI generator version: $generator_version"
+
+echo " -> Generating Core client (Katapult version: ${core_api_version})..."
 docker run \
   --user "$(id -u):$(id -g)" \
   -v "$(pwd):/local" \
@@ -12,8 +19,9 @@ docker run \
   -generate types,client \
   -package core \
   -templates /local/templates \
-   /local/katapult-core-openapi.json > "./core/core.go" 
+  /local/katapult-core-openapi.json > "./core/core.go"
 
+echo " -> Generating Public client (Katapult version: ${public_api_version})..."
 docker run \
   --user "$(id -u):$(id -g)" \
   -v "$(pwd):/local" \
@@ -22,4 +30,4 @@ docker run \
   -generate types,client \
   -package public \
   -templates /local/templates \
-   /local/katapult-public-openapi.json > "./public/public.go" 
+  /local/katapult-public-openapi.json > "./public/public.go"
diff --git a/next/katapult-core-openapi.json b/next/katapult-core-openapi.json
@@ -1,14 +1,14 @@
 {
   "openapi": "3.0.0",
   "info": {
-    "x-katapult-version": "2.64.0",
+    "x-katapult-version": "2.68.0",
     "version": "1.0.0",
     "title": "Katapult Core API",
     "description": "Welcome to the documentation for the Katapult Core API"
   },
   "externalDocs": {
     "description": "Katapult API Documentation",
-    "url": "https://developers.katapult.io/docs/category/core-api"
+    "url": "https://docs.katapult.io/docs/category/core-api"
   },
   "servers": [
     {
@@ -15943,6 +15943,9 @@
           "404": {
             "$ref": "#/components/responses/NoVirtualMachineForAPITokenResponse"
           },
+          "409": {
+            "$ref": "#/components/responses/ContinuousManagementDisabledResponse"
+          },
           "429": {
             "$ref": "#/components/responses/APIAuthenticator429Response"
           },
@@ -16300,6 +16303,10 @@
             "type": "string",
             "nullable": true
           },
+          "default": {
+            "type": "boolean",
+            "description": "Indicates if this network is the default network for the data center."
+          },
           "data_center": {
             "$ref": "#/components/schemas/GetDataCenterDefaultNetworkPartDataCenter"
           }
@@ -19976,6 +19983,10 @@
             "type": "string",
             "nullable": true
           },
+          "default": {
+            "type": "boolean",
+            "description": "Indicates if this network is the default network for the data center."
+          },
           "data_center": {
             "$ref": "#/components/schemas/DataCenter"
           }
@@ -20518,6 +20529,12 @@
           "no_virtual_machine_for_api_token"
         ]
       },
+      "ContinuousManagementDisabledEnum": {
+        "type": "string",
+        "enum": [
+          "continuous_management_disabled"
+        ]
+      },
       "ZoneLookup": {
         "description": "All 'zone[]' params are mutually exclusive, only one can be provided.",
         "type": "object",
@@ -22955,6 +22972,10 @@
             "type": "string",
             "nullable": true
           },
+          "default": {
+            "type": "boolean",
+            "description": "Indicates if this network is the default network for the data center."
+          },
           "data_center": {
             "$ref": "#/components/schemas/GetOrganizationAvailableNetworksPartDataCenter"
           }
@@ -26713,6 +26734,26 @@
           }
         }
       },
+      "ContinuousManagementDisabledResponse": {
+        "description": "SSH Key Continuous management is not enabled for this virtual machine",
+        "content": {
+          "application/json": {
+            "schema": {
+              "properties": {
+                "code": {
+                  "$ref": "#/components/schemas/ContinuousManagementDisabledEnum"
+                },
+                "description": {
+                  "type": "string"
+                },
+                "detail": {
+                  "type": "object"
+                }
+              }
+            }
+          }
+        }
+      },
       "OrganizationNotActivatedPermissionDeniedResourceCreationRestricted403Res": {
         "description": "403 error response",
         "content": {

diff --git a/next/katapult-public-openapi.json b/next/katapult-public-openapi.json
@@ -1,14 +1,14 @@
 {
   "openapi": "3.0.0",
   "info": {
-    "x-katapult-version": "2.64.0",
+    "x-katapult-version": "2.68.0",
     "version": "1.0.0",
     "title": "Katapult Public API",
     "description": "Welcome to the documentation for the Katapult Public API"
   },
   "externalDocs": {
     "description": "Katapult API Documentation",
-    "url": "https://developers.katapult.io/docs/category/public-api"
+    "url": "https://docs.katapult.io/docs/category/public-api"
   },
   "servers": [
     {