From 59e9e6d341ef648506d6eb041ced774c0a1b13d9 Mon Sep 17 00:00:00 2001
From: Freek van Rijt <freek.vanrijt@myparcel.nl>
Date: Fri, 5 Apr 2024 12:57:00 +0200
Subject: [PATCH] feat(open-api): add basic $ref resolution support for openapi
 documents

adds support to resolve $ref references to paths within the document

INT-407
---
 .../client/components/global/OpenApi.vue      | 36 +++++++++++++++++--
 .../components/global/OpenApiResponses.vue    | 13 +++++--
 2 files changed, 44 insertions(+), 5 deletions(-)

diff --git a/src/.vuepress/theme/client/components/global/OpenApi.vue b/src/.vuepress/theme/client/components/global/OpenApi.vue
index 20c9cc6c..fed8f5a5 100644
--- a/src/.vuepress/theme/client/components/global/OpenApi.vue
+++ b/src/.vuepress/theme/client/components/global/OpenApi.vue
@@ -1,9 +1,9 @@
 <template>
   <section class="open-api">
-    <OpenApiInfo :info="document.info" />
+    <OpenApiInfo :info="resolvedDocument.info" />
 
     <article
-      v-for="(item, path) in document.paths"
+      v-for="(item, path) in resolvedDocument.paths"
       :key="path">
       <OpenApiPath
         v-if="item"
@@ -14,11 +14,41 @@
 </template>
 
 <script setup lang="ts">
+import {computed} from 'vue';
 import {type OpenAPIV3_1 as OpenApiType} from 'openapi-types';
+import {get} from 'lodash-es';
 import OpenApiPath from './OpenApiPath.vue';
 import OpenApiInfo from './OpenApiInfo.vue';
 
-defineProps<{
+const props = defineProps<{
   document: OpenApiType.Document;
 }>();
+
+const resolvedDocument = computed(() => resolveRefs(props.document));
+
+// Recursively loop through the entire document and replace any $ref keys with their corresponding values
+function resolveRefs(document: OpenApiType.Document): OpenApiType.Document {
+  const resolvedDocument = {...document};
+
+  function resolveRefsRecursive(obj: object | (string | number | object)[]) {
+    for (const key in obj) {
+      if (key === '$ref') {
+        const lookup = (obj as {$ref: string})[key];
+        // Lookup is a string that defines the path to the referenced object like '#/components/schemas/Example'
+        const path = lookup.split('/').slice(1);
+        // Find the referenced object in the document using lodash's get function
+        const referencedObject = get(resolvedDocument, path);
+        // Remove the $ref: '...' key from the object and replace it with the referenced object itself
+        obj = Object.assign(obj, referencedObject);
+      } else if (typeof obj[key] === 'object' || Array.isArray(obj[key])) {
+        // If the value is an object or an array, recursively call this function
+        resolveRefsRecursive(obj[key]);
+      }
+    }
+  }
+
+  resolveRefsRecursive(resolvedDocument);
+
+  return resolvedDocument;
+}
 </script>
diff --git a/src/.vuepress/theme/client/components/global/OpenApiResponses.vue b/src/.vuepress/theme/client/components/global/OpenApiResponses.vue
index aafc9127..e4a2fa6b 100644
--- a/src/.vuepress/theme/client/components/global/OpenApiResponses.vue
+++ b/src/.vuepress/theme/client/components/global/OpenApiResponses.vue
@@ -46,10 +46,19 @@ const responseObjects: ComputedRef<Record<string, OpenApiType.ResponseObject>> =
 // Maps the response content to a CodeGroupItem array.
 const mapToCodegroup = (content: Record<string, OpenApiType.MediaTypeObject>) => {
   return Object.entries(content).map(([responseType, item]) => {
-    // @TODO support component references here, too
+    let code = {};
+
+    if (item.schema) {
+      code = item.schema;
+    } else if (item.example) {
+      code = item.example;
+    } else if (item.examples) {
+      code = item.examples;
+    }
+
     return {
       title: responseType,
-      code: item.examples ?? item.examples ?? item.example,
+      code,
       language: responseType,
     };
   });