From 92ec5d9d06367bb35389cf89eb6cc98c2e3b7500 Mon Sep 17 00:00:00 2001
From: Freek van Rijt <freek.vanrijt@myparcel.nl>
Date: Tue, 16 Apr 2024 12:29:30 +0200
Subject: [PATCH] feat(open-api): add servers display if set

INT-407
---
 src/.vuepress/plugins/openApi.ts              |  3 +++
 .../components/global/OpenApiServers.vue      | 23 +++++++++++++++++++
 .../theme/client/components/global/index.ts   |  2 ++
 3 files changed, 28 insertions(+)
 create mode 100644 src/.vuepress/theme/client/components/global/OpenApiServers.vue

diff --git a/src/.vuepress/plugins/openApi.ts b/src/.vuepress/plugins/openApi.ts
index 4e8ac495..c507b63a 100644
--- a/src/.vuepress/plugins/openApi.ts
+++ b/src/.vuepress/plugins/openApi.ts
@@ -42,6 +42,9 @@ ${document.security ? '## Authorization' : ''}
 :security='${JSON.stringify(document.security ?? [])}'
 :security-schemes='${JSON.stringify(document.components?.securitySchemes ?? [])}' />
 
+${document.servers?.length ? '## Servers' : ''}
+<OpenApiServers :servers='${JSON.stringify(document.servers ?? [])}' />
+
 ${renderPaths(document, document.paths, 'Endpoints')}
 
 ${renderPaths(document, document.webhooks, 'Webhooks')}
diff --git a/src/.vuepress/theme/client/components/global/OpenApiServers.vue b/src/.vuepress/theme/client/components/global/OpenApiServers.vue
new file mode 100644
index 00000000..a383c95b
--- /dev/null
+++ b/src/.vuepress/theme/client/components/global/OpenApiServers.vue
@@ -0,0 +1,23 @@
+<template>
+  <ul
+    v-if="servers?.length"
+    class="open-api-servers">
+    <li
+      v-for="(server, index) in servers"
+      :key="index">
+      <code>{{ server.url }}</code>
+      <Markdown
+        v-if="server.description"
+        :content="server.description" />
+    </li>
+  </ul>
+</template>
+
+<script setup lang="ts">
+import {type OpenAPIV3_1 as OpenApiType} from 'openapi-types';
+import Markdown from './Markdown.vue';
+
+defineProps<{
+  servers: OpenApiType.Document['servers'];
+}>();
+</script>
diff --git a/src/.vuepress/theme/client/components/global/index.ts b/src/.vuepress/theme/client/components/global/index.ts
index a7cc79f6..13b4a70c 100644
--- a/src/.vuepress/theme/client/components/global/index.ts
+++ b/src/.vuepress/theme/client/components/global/index.ts
@@ -84,3 +84,5 @@ export {default as OpenApiSchemaInfo} from './OpenApiSchemaInfo.vue';
 export {default as OpenApiSecurityRequirements} from './OpenApiSecurityRequirements.vue';
 
 export {default as OpenApiSecurityScheme} from './OpenApiSecurityScheme.vue';
+
+export {default as OpenApiServers} from './OpenApiServers.vue';