fix: api description

Author: kai687

pkg/cmd/generate/clients/clients.go

@@ -158,7 +158,7 @@ func getAPIData(
 				return nil, err
 			}
 
-			short, long := splitDescription(op.Description)
+			short, long := utils.SplitDescription(op.Description)
 
 			data := OperationData{
 				ACL:              utils.AclToString(acl),
@@ -223,36 +223,6 @@ func writeAPIData(data []OperationData, template *template.Template) error {
 	return nil
 }
 
-func splitDescription(p string) (string, string) {
-	p = strings.TrimSpace(p)
-
-	// Split by empty line
-	parts := strings.SplitN(p, "\n\n", 2)
-	if len(parts) > 1 && strings.TrimSpace(parts[0]) != "" {
-		short := strings.TrimSpace(parts[0])
-		long := strings.TrimSpace(parts[1])
-
-		// No extra newline characters in between
-		short = strings.ReplaceAll(short, "\n", "")
-
-		return short, long
-	}
-
-	// No empty line: find first period
-	if idx := strings.Index(p, "."); idx != -1 {
-		short := strings.TrimSpace(p[:idx+1])
-		long := strings.TrimSpace(p[idx+1:])
-
-		// No extra newline characters in between
-		short = strings.ReplaceAll(short, "\n", "")
-
-		return short, long
-	}
-
-	// No period: entire paragraph is the shortDescription
-	return p, ""
-}
-
 func getCodeSamples(op *v3.Operation) []CodeSample {
 	node, ok := op.Extensions.Get("x-codeSamples")
 	// Operations can be without code samples

pkg/cmd/generate/openapi/openapi.go

@@ -31,9 +31,11 @@ type ExternalDocs struct {
 
 // OverviewData holds relevant data for the entire spec.
 type OverviewData struct {
-	OutputFilename string
-	OutputPath     string
-	Title          string
+	Description      string
+	OutputFilename   string
+	OutputPath       string
+	ShortDescription string
+	Title            string
 }
 
 // OperationData holds data relevant to a single API operation stub file.
@@ -134,10 +136,14 @@ func getAPIOverviewData(
 	doc *libopenapi.DocumentModel[v3.Document],
 	opts *Options,
 ) (OverviewData, error) {
+	short, long := utils.SplitDescription(doc.Model.Info.Description)
+
 	result := OverviewData{
-		OutputFilename: fmt.Sprintf("%s.mdx", opts.APIName),
-		OutputPath:     opts.OutputDirectory,
-		Title:          doc.Model.Info.Title,
+		OutputFilename:   fmt.Sprintf("%s.mdx", opts.APIName),
+		OutputPath:       opts.OutputDirectory,
+		Title:            doc.Model.Info.Title,
+		ShortDescription: short,
+		Description:      long,
 	}
 
 	return result, nil

pkg/cmd/generate/openapi/overview.mdx.tmpl

@@ -1,6 +1,7 @@
 ---
 title: {{ .Title }}
 sidebarTitle: Overview
+description: {{ .ShortDescription }}
 ---
 
-Placeholder.
+{{ .Description }}

pkg/cmd/generate/utils/utils.go

@@ -122,3 +122,34 @@ func GetLanguageName(lang string) string {
 
 	return Capitalize(lang)
 }
+
+// SplitDescription splits a description into the first sentence and the rest.
+func SplitDescription(p string) (string, string) {
+	p = strings.TrimSpace(p)
+
+	// Split by empty line
+	parts := strings.SplitN(p, "\n\n", 2)
+	if len(parts) > 1 && strings.TrimSpace(parts[0]) != "" {
+		short := strings.TrimSpace(parts[0])
+		long := strings.TrimSpace(parts[1])
+
+		// No extra newline characters in between
+		short = strings.ReplaceAll(short, "\n", "")
+
+		return short, long
+	}
+
+	// No empty line: find first period
+	if idx := strings.Index(p, "."); idx != -1 {
+		short := strings.TrimSpace(p[:idx+1])
+		long := strings.TrimSpace(p[idx+1:])
+
+		// No extra newline characters in between
+		short = strings.ReplaceAll(short, "\n", "")
+
+		return short, long
+	}
+
+	// No period: entire paragraph is the shortDescription
+	return p, ""
+}