core/api
8
0
Fork 0
Code Issues 4 Pull requests Projects Releases Packages Wiki Activity Actions

fix(cmd/api): trim spec metadata inputs

Browse source
This commit is contained in:
Virgil 2026-04-02 14:25:59 +00:00
parent d7290c55ec
commit 5971951c87
2 changed files with 73 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
cmd/api/cmd_test.go
View file

@ -234,6 +234,67 @@ func TestAPISpecCmd_Good_SummaryPopulatesSpecInfo(t *testing.T) {
}
}
func TestNewSpecBuilder_Good_TrimsMetadata(t *testing.T) {
builder, err := newSpecBuilder(specBuilderConfig{
title: " API Title ",
summary: " API Summary ",
description: " API Description ",
version: " 1.2.3 ",
termsURL: " https://example.com/terms ",
contactName: " API Support ",
contactURL: " https://example.com/support ",
contactEmail: " support@example.com ",
licenseName: " EUPL-1.2 ",
licenseURL: " https://eupl.eu/1.2/en/ ",
externalDocsDescription: " Developer guide ",
externalDocsURL: " https://example.com/docs ",
servers: " https://api.example.com , / ",
})
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if builder.Title != "API Title" {
t.Fatalf("expected trimmed title, got %q", builder.Title)
}
if builder.Summary != "API Summary" {
t.Fatalf("expected trimmed summary, got %q", builder.Summary)
}
if builder.Description != "API Description" {
t.Fatalf("expected trimmed description, got %q", builder.Description)
}
if builder.Version != "1.2.3" {
t.Fatalf("expected trimmed version, got %q", builder.Version)
}
if builder.TermsOfService != "https://example.com/terms" {
t.Fatalf("expected trimmed terms URL, got %q", builder.TermsOfService)
}
if builder.ContactName != "API Support" {
t.Fatalf("expected trimmed contact name, got %q", builder.ContactName)
}
if builder.ContactURL != "https://example.com/support" {
t.Fatalf("expected trimmed contact URL, got %q", builder.ContactURL)
}
if builder.ContactEmail != "support@example.com" {
t.Fatalf("expected trimmed contact email, got %q", builder.ContactEmail)
}
if builder.LicenseName != "EUPL-1.2" {
t.Fatalf("expected trimmed licence name, got %q", builder.LicenseName)
}
if builder.LicenseURL != "https://eupl.eu/1.2/en/" {
t.Fatalf("expected trimmed licence URL, got %q", builder.LicenseURL)
}
if builder.ExternalDocsDescription != "Developer guide" {
t.Fatalf("expected trimmed external docs description, got %q", builder.ExternalDocsDescription)
}
if builder.ExternalDocsURL != "https://example.com/docs" {
t.Fatalf("expected trimmed external docs URL, got %q", builder.ExternalDocsURL)
}
if len(builder.Servers) != 2 || builder.Servers[0] != "https://api.example.com" || builder.Servers[1] != "/" {
t.Fatalf("expected trimmed servers, got %v", builder.Servers)
}
}
func TestAPISpecCmd_Good_CacheAndI18nFlagsPopulateSpec(t *testing.T) {
root := &cli.Command{Use: "root"}
AddAPICommands(root)

24
cmd/api/spec_builder.go
View file

@ -52,10 +52,10 @@ func newSpecBuilder(cfg specBuilderConfig) (*goapi.SpecBuilder, error) {
cacheTTLValid := parsePositiveDuration(cacheTTL)
builder := &goapi.SpecBuilder{
Title: cfg.title,
Summary: cfg.summary,
Description: cfg.description,
Version: cfg.version,
Title: strings.TrimSpace(cfg.title),
Summary: strings.TrimSpace(cfg.summary),
Description: strings.TrimSpace(cfg.description),
Version: strings.TrimSpace(cfg.version),
SwaggerEnabled: swaggerPath != "",
SwaggerPath: swaggerPath,
GraphQLEnabled: graphqlPath != "" || cfg.graphqlPlayground,
@ -72,15 +72,15 @@ func newSpecBuilder(cfg specBuilderConfig) (*goapi.SpecBuilder, error) {
CacheMaxEntries: cfg.cacheMaxEntries,
CacheMaxBytes: cfg.cacheMaxBytes,
I18nDefaultLocale: strings.TrimSpace(cfg.i18nDefaultLocale),
TermsOfService: cfg.termsURL,
ContactName: cfg.contactName,
ContactURL: cfg.contactURL,
ContactEmail: cfg.contactEmail,
TermsOfService: strings.TrimSpace(cfg.termsURL),
ContactName: strings.TrimSpace(cfg.contactName),
ContactURL: strings.TrimSpace(cfg.contactURL),
ContactEmail: strings.TrimSpace(cfg.contactEmail),
Servers: parseServers(cfg.servers),
LicenseName: cfg.licenseName,
LicenseURL: cfg.licenseURL,
ExternalDocsDescription: cfg.externalDocsDescription,
ExternalDocsURL: cfg.externalDocsURL,
LicenseName: strings.TrimSpace(cfg.licenseName),
LicenseURL: strings.TrimSpace(cfg.licenseURL),
ExternalDocsDescription: strings.TrimSpace(cfg.externalDocsDescription),
ExternalDocsURL: strings.TrimSpace(cfg.externalDocsURL),
AuthentikIssuer: strings.TrimSpace(cfg.authentikIssuer),
AuthentikClientID: strings.TrimSpace(cfg.authentikClientID),
AuthentikTrustedProxy: cfg.authentikTrustedProxy,