add openapi.json into the root of the repo

Author: hugodutka

.github/workflows/check-openapi.yml

@@ -0,0 +1,37 @@
+name: Check OpenAPI Schema
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  check-openapi:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version: 'stable'
+
+    - name: Generate OpenAPI schema
+      run: go run main.go server --print-openapi dummy > generated-openapi.json
+
+    - name: Check OpenAPI schema
+      run: |
+        if [ ! -f "openapi.json" ]; then
+          echo "::warning::openapi.json does not exist"
+          exit 1
+        fi
+        
+        # Compare schemas
+        if ! cmp -s openapi.json generated-openapi.json; then
+          echo "::error::The openapi.json file is out of sync with the generated schema"
+          echo "Diff:"
+          diff -u openapi.json generated-openapi.json || true
+          exit 1
+        fi
+        echo "OpenAPI schema is up to date"

README.md

@@ -54,7 +54,9 @@ agentapi server -- aider --model sonnet --api-key anthropic=sk-ant-apio3-XXX
 agentapi server -- goose
 ```
 
-By default, the server runs on port 3284. The server exposes an OpenAPI schema at http://localhost:3284/openapi.json. You may also inspect the available endpoints at http://localhost:3284/docs.
+The OpenAPI schema is available in this repository: [openapi.json](openapi.json).
+
+By default, the server runs on port 3284. Additionally, the server exposes an OpenAPI schema at http://localhost:3284/openapi.json. You may also inspect the available endpoints at http://localhost:3284/docs.
 
 There are 4 endpoints:
 

cmd/server/server.go

@@ -12,11 +12,13 @@ import (
 	"github.com/coder/agentapi/lib/httpapi"
 	"github.com/coder/agentapi/lib/logctx"
 	"github.com/coder/agentapi/lib/msgfmt"
+	"github.com/coder/agentapi/lib/termexec"
 )
 
 var (
 	agentTypeVar string
 	port         int
+	printOpenAPI bool
 )
 
 type AgentType = msgfmt.AgentType
@@ -76,12 +78,21 @@ var ServerCmd = &cobra.Command{
 			logger.Error("Failed to parse agent type", "error", err)
 			os.Exit(1)
 		}
-		process, err := httpapi.SetupProcess(ctx, agent, argsToPass[1:]...)
-		if err != nil {
-			logger.Error("Failed to setup process", "error", err)
-			os.Exit(1)
+		var process *termexec.Process
+		if printOpenAPI {
+			process = nil
+		} else {
+			process, err = httpapi.SetupProcess(ctx, agent, argsToPass[1:]...)
+			if err != nil {
+				logger.Error("Failed to setup process", "error", err)
+				os.Exit(1)
+			}
 		}
 		srv := httpapi.NewServer(ctx, agentType, process, port)
+		if printOpenAPI {
+			fmt.Println(srv.GetOpenAPI())
+			os.Exit(0)
+		}
 		logger.Info("Starting server on port", "port", port)
 		go func() {
 			if err := process.Wait(); err != nil {
@@ -101,4 +112,5 @@ var ServerCmd = &cobra.Command{
 func init() {
 	ServerCmd.Flags().StringVarP(&agentTypeVar, "type", "t", "", "Override the agent type (one of: claude, goose, aider, custom)")
 	ServerCmd.Flags().IntVarP(&port, "port", "p", 3284, "Port to run the server on")
+	ServerCmd.Flags().BoolVarP(&printOpenAPI, "print-openapi", "P", false, "Print the OpenAPI schema to stdout and exit")
 }

lib/httpapi/server.go

@@ -2,6 +2,7 @@ package httpapi
 
 import (
 	"context"
+	"encoding/json"
 	"fmt"
 	"log/slog"
 	"net/http"
@@ -34,6 +35,23 @@ type Server struct {
 	emitter      *EventEmitter
 }
 
+func (s *Server) GetOpenAPI() string {
+	jsonBytes, err := s.api.OpenAPI().MarshalJSON()
+	if err != nil {
+		return ""
+	}
+	// unmarshal the json and pretty print it
+	var jsonObj any
+	if err := json.Unmarshal(jsonBytes, &jsonObj); err != nil {
+		return ""
+	}
+	prettyJSON, err := json.MarshalIndent(jsonObj, "", "  ")
+	if err != nil {
+		return ""
+	}
+	return string(prettyJSON)
+}
+
 // NewServer creates a new server instance
 func NewServer(ctx context.Context, agentType mf.AgentType, process *termexec.Process, port int) *Server {
 	router := chi.NewMux()