Skip to content

build(docs): failing to generate api spec should not be fatal #800

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rsdmike merged 1 commit into from
Feb 11, 2026
Merged

build(docs): failing to generate api spec should not be fatal #800

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions cmd/app/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,7 @@ func handleDebugMode(cfg *config.Config) {
if os.Getenv("GIN_MODE") != "debug" {
go launchBrowser(cfg)
} else {
if err := handleOpenAPIGeneration(); err != nil {
log.Fatalf("Failed to generate OpenAPI spec: %s", err)
}
handleOpenAPIGeneration(cfg)
}
}

Expand All @@ -107,8 +105,8 @@ func launchBrowser(cfg *config.Config) {
}
}

func handleOpenAPIGeneration() error {
l := logger.New("info")
func handleOpenAPIGeneration(cfg *config.Config) {
l := logger.New(cfg.Level)
usecases := usecase.Usecases{}

// Create OpenAPI generator
Expand All @@ -117,17 +115,19 @@ func handleOpenAPIGeneration() error {
// Generate specification
spec, err := generator.GenerateSpec()
if err != nil {
return err
l.Warn("Failed to generate OpenAPI spec: %s", err)

return
}

// Save to file
if err := generator.SaveSpec(spec, "doc/openapi.json"); err != nil {
return err
l.Warn("Failed to save OpenAPI spec: %s", err)

return
}

log.Println("OpenAPI specification generated at doc/openapi.json")

return nil
}

func handleSecretsConfig(cfg *config.Config) (security.Storager, error) {
Expand Down
6 changes: 2 additions & 4 deletions cmd/app/main_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,7 @@ func TestHandleOpenAPIGeneration_Success(t *testing.T) {
mockGen.On("GenerateSpec").Return(expectedSpec, nil)
mockGen.On("SaveSpec", expectedSpec, "doc/openapi.json").Return(nil)

err := handleOpenAPIGeneration()
assert.NoError(t, err)
handleOpenAPIGeneration(&config.Config{Log: config.Log{Level: "info"}})

mockGen.AssertExpectations(t)
}
Expand All @@ -145,8 +144,7 @@ func TestHandleOpenAPIGeneration_GenerateFails(t *testing.T) {

mockGen.On("GenerateSpec").Return([]byte(nil), assert.AnError)

err := handleOpenAPIGeneration()
assert.Error(t, err)
handleOpenAPIGeneration(&config.Config{Log: config.Log{Level: "info"}})

mockGen.AssertExpectations(t)
}
Loading