feat: output header descriptions as comments

aspida · Jul 20, 2023 · 67995e9 · 67995e9
1 parent a960262
commit 67995e9
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/samples/headers/@types/index.ts b/samples/headers/@types/index.ts
@@ -1,6 +1,7 @@
 /* eslint-disable */
 export type X_Simple = string
 
+/** This header has a description. */
 export type X_Description = number
 
 export type X_Ref = X_Simple
diff --git a/src/buildV3.ts b/src/buildV3.ts
@@ -402,7 +402,7 @@ export default (openapi: OpenAPIV3.Document) => {
           })),
           ...headers.map(h => ({
             name: h.name,
-            description: null,
+            description: typeof h.value === 'string' ? null : h.value.description,
             text:
               typeof h.value === 'string'
                 ? h.value

diff --git a/src/builderUtils/headers2Props.ts b/src/builderUtils/headers2Props.ts
@@ -16,7 +16,7 @@ export default (headers: OpenAPIV3.ComponentsObject['headers']) =>
       } else {
         const result = schema2value(target.schema, false)
         if (!result) return null
-        value = result
+        value = { ...result, description: target.description ?? null }
       }
 
       return { name: defKey2defName(defKey), value }