Hide x-gitbook-* symbols in OpenAPI blocks (#2863)

.changeset/happy-plants-grab.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Hide x-gitbook-\* symbols in OpenAPI blocks

packages/react-openapi/src/OpenAPIResponseExample.tsx

@@ -5,6 +5,7 @@ import { checkIsReference, createStateKey, resolveDescription } from './utils';
 import { OpenAPITabs, OpenAPITabsList, OpenAPITabsPanels } from './OpenAPITabs';
 import { InteractiveSection } from './InteractiveSection';
 import { json2xml } from './json2xml';
+import { stringifyOpenAPI } from './stringifyOpenAPI';
 
 /**
  * Display an example of the response content.
@@ -226,7 +227,7 @@ function stringifyExample(args: { example: OpenAPIV3.ExampleObject; xml: boolean
         return json2xml(example.value);
     }
 
-    return JSON.stringify(example.value, null, 2);
+    return stringifyOpenAPI(example.value, null, 2);
 }
 
 /**

packages/react-openapi/src/stringifyOpenAPI.ts

@@ -1,6 +1,17 @@
 /**
  * Stringify an OpenAPI object. Same API as JSON.stringify.
  */
-export function stringifyOpenAPI(body: unknown, transformer?: null, indent?: number): string {
+export function stringifyOpenAPI(body: unknown, _?: null, indent?: number): string {
-    return JSON.stringify(body, transformer, indent);
+    return JSON.stringify(
+        body,
+        (key, value) => {
+            // Ignore internal keys
+            if (key.startsWith('x-gitbook-')) {
+                return undefined;
+            }
+
+            return value;
+        },
+        indent,
+    );
 }