From babcfb6b39e1276d15cca373e84644ff5a70a806 Mon Sep 17 00:00:00 2001
From: John Hart <john.hart@vertexinc.com>
Date: Fri, 11 Jan 2019 19:24:21 -0500
Subject: [PATCH] improvement: support Markdown in header descriptions (via
 #5120)

* Added markdown for header descriptions as per specifications:

https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#header-object
which subclasses:
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameterObject

https://swagger.io/specification/#headerObject
which subclasses
https://swagger.io/specification/#parameterObject

* update headers.jsx

* Update headers.jsx

Fixing test error due to the `description` variable having been removed

* Update headers.jsx
---
 src/core/components/headers.jsx | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/src/core/components/headers.jsx b/src/core/components/headers.jsx
index 721ccdf2..6d630de9 100644
--- a/src/core/components/headers.jsx
+++ b/src/core/components/headers.jsx
@@ -5,16 +5,16 @@ import Im from "immutable"
 const propStyle = { color: "#999", fontStyle: "italic" }
 
 export default class Headers extends React.Component {
-
   static propTypes = {
     headers: PropTypes.object.isRequired,
     getComponent: PropTypes.func.isRequired
   };
 
   render() {
-
     let { headers, getComponent } = this.props
+
     const Property = getComponent("Property")
+    const Markdown = getComponent("Markdown")
 
     if ( !headers || !headers.size )
       return null
@@ -36,12 +36,16 @@ export default class Headers extends React.Component {
               if(!Im.Map.isMap(header)) {
                 return null
               }
+              
+              const description = header.get("description")
               const type = header.getIn(["schema"]) ? header.getIn(["schema", "type"]) : header.getIn(["type"])
               const schemaExample = header.getIn(["schema", "example"])
 
               return (<tr key={ key }>
                 <td className="header-col">{ key }</td>
-                <td className="header-col">{ header.get( "description" ) }</td>
+                <td className="header-col">{
+                  !description ? null : <Markdown source={ description } />
+                }</td>
                 <td className="header-col">{ type } { schemaExample ? <Property propKey={ "Example" } propVal={ schemaExample } propStyle={ propStyle } /> : null }</td>
               </tr>)
             }).toArray()