From 7cd4a3c790051555833d399f3b244ccec89d3da7 Mon Sep 17 00:00:00 2001
From: Freek van Rijt <freek.vanrijt@myparcel.nl>
Date: Tue, 16 Apr 2024 12:49:27 +0200
Subject: [PATCH] fix(open-api): render all description fields as markdown

INT-407
---
 .../theme/client/components/global/OpenApiInfo.vue     |  5 ++++-
 .../theme/client/components/global/OpenApiPath.vue     |  4 +++-
 .../client/components/global/OpenApiRequestParam.vue   |  7 +++----
 .../client/components/global/OpenApiResponses.vue      | 10 +++++-----
 4 files changed, 15 insertions(+), 11 deletions(-)

diff --git a/src/.vuepress/theme/client/components/global/OpenApiInfo.vue b/src/.vuepress/theme/client/components/global/OpenApiInfo.vue
index 419e98b0..fb2ca7e6 100644
--- a/src/.vuepress/theme/client/components/global/OpenApiInfo.vue
+++ b/src/.vuepress/theme/client/components/global/OpenApiInfo.vue
@@ -3,13 +3,16 @@
     <hgroup>
       <h2>{{ info.title }}</h2>
       <p>(v{{ info.version }})</p>
-      <p v-if="info.description">{{ info.description }}</p>
+      <Markdown
+        v-if="info.description"
+        :content="info.description" />
     </hgroup>
   </section>
 </template>
 
 <script setup lang="ts">
 import {type OpenAPIV3_1 as OpenApiType} from 'openapi-types';
+import Markdown from './Markdown.vue';
 
 defineProps<{
   info: OpenApiType.Document['info'];
diff --git a/src/.vuepress/theme/client/components/global/OpenApiPath.vue b/src/.vuepress/theme/client/components/global/OpenApiPath.vue
index 0815483f..cba1933b 100644
--- a/src/.vuepress/theme/client/components/global/OpenApiPath.vue
+++ b/src/.vuepress/theme/client/components/global/OpenApiPath.vue
@@ -16,7 +16,9 @@
           :security-schemes="components?.securitySchemes as Record<string, OpenApiType.SecuritySchemeObject>"
           :security-requirements="'security' in operation ? operation.security : undefined" />
 
-        <p v-if="'description' in operation">{{ operation.description }}</p>
+        <Markdown
+          v-if="'description' in operation && operation.description?.length"
+          :content="operation.description" />
 
         <template v-if="'parameters' in operation">
           <h4>Request parameters</h4>
diff --git a/src/.vuepress/theme/client/components/global/OpenApiRequestParam.vue b/src/.vuepress/theme/client/components/global/OpenApiRequestParam.vue
index d7a22e9b..b517fe4a 100644
--- a/src/.vuepress/theme/client/components/global/OpenApiRequestParam.vue
+++ b/src/.vuepress/theme/client/components/global/OpenApiRequestParam.vue
@@ -19,13 +19,13 @@
       v-if="parameter.schema"
       :schema="parameter.schema" />
 
-    <div
+    <Markdown
       v-if="
         parameter.description &&
         !(parameter.schema && 'description' in parameter.schema && parameter.schema.description?.length)
       "
       class="text-gray-500 text-sm"
-      v-html="parameter.description" />
+      :content="parameter.description" />
 
     <OpenApiExample
       v-if="parameter.example"
@@ -56,9 +56,8 @@
 import {computed, defineProps} from 'vue';
 import {type OpenAPIV3_1 as OpenApiType} from 'openapi-types';
 import OpenApiSchema from './OpenApiSchema.vue';
-// import OpenApiObjectModel from './OpenApiObjectModel.vue';
-// import OpenApiMediaTypes from './OpenApiMediaTypes.vue';
 import OpenApiExample from './OpenApiExample.vue';
+import Markdown from './Markdown.vue';
 
 const props = defineProps<{
   parameter: OpenApiType.ParameterObject;
diff --git a/src/.vuepress/theme/client/components/global/OpenApiResponses.vue b/src/.vuepress/theme/client/components/global/OpenApiResponses.vue
index 0570c252..dd5590e6 100644
--- a/src/.vuepress/theme/client/components/global/OpenApiResponses.vue
+++ b/src/.vuepress/theme/client/components/global/OpenApiResponses.vue
@@ -7,11 +7,11 @@
         :key="code"
         class="m-0 p-0">
         <Http :code="code" />
-        <p
+
+        <Markdown
           v-if="response.description"
-          class="text-gray-500 text-sm">
-          {{ response.description }}
-        </p>
+          class="text-gray-500 text-sm"
+          :content="response.description" />
 
         <template v-for="(item, type) in response.content">
           <DetailsExpand
@@ -54,9 +54,9 @@ import {type OpenAPIV3_1 as OpenApiType} from 'openapi-types';
 import {isReponseObject} from '@mptheme/client/utils/openApiGuards';
 import OpenApiSchema from './OpenApiSchema.vue';
 import OpenApiExample from './OpenApiExample.vue';
+import Markdown from './Markdown.vue';
 import Http from './Http.vue';
 import DetailsExpand from './DetailsExpand.vue';
-import CodeGroup from './CodeGroup.vue';
 
 const props = defineProps<{
   responses: OpenApiType.ResponsesObject;