Fix display of parameter's description in OpenAPI block (#2258)

GitbookIO · Apr 1, 2024 · c1ef7f2 · c1ef7f2
1 parent f26ab0c
commit c1ef7f2
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/packages/react-openapi/src/OpenAPISpec.tsx b/packages/react-openapi/src/OpenAPISpec.tsx
@@ -44,7 +44,12 @@ export function OpenAPISpec(props: { rawData: any; context: OpenAPIClientContext
                     <OpenAPISchemaProperties
                         properties={group.parameters.map((parameter) => ({
                             propertyName: parameter.name,
-                            schema: noReference(parameter.schema) ?? {},
+                            schema: {
+                                // Description of the parameter is defined at the parameter level
+                                // we use display it if the schema doesn't override it
+                                description: parameter.description,
+                                ...(noReference(parameter.schema) ?? {}),
+                            },
                             required: parameter.required,
                         }))}
                         context={context}