Include apiKey example in CodeSample security headers (#2804)

GitbookIO · Feb 4, 2025 · d9029c7 · d9029c7
1 parent fe8acc9
commit d9029c7
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/.changeset/blue-vans-marry.md b/.changeset/blue-vans-marry.md
@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Support apiKey in CodeSample security headers
diff --git a/packages/react-openapi/src/OpenAPICodeSample.tsx b/packages/react-openapi/src/OpenAPICodeSample.tsx
@@ -153,6 +153,28 @@ function getSecurityHeaders(securities: OpenAPIOperationData['securities']): {
                 Authorization: scheme + ' ' + (security[1].bearerFormat ?? '<token>'),
             };
         }
+        case 'apiKey': {
+            if (security[1].in !== 'header') return {};
+
+            const name = security[1].name ?? 'Authorization';
+            let scheme = security[0];
+
+            switch (scheme) {
+                case 'bearerAuth':
+                    scheme = 'Bearer';
+                    break;
+                case 'token':
+                    scheme = 'Token';
+                    break;
+                case 'basic':
+                    scheme = 'Basic';
+                    break;
+            }
+
+            return {
+                [name]: scheme + ' ' + '<apiKey>',
+            };
+        }
         default: {
             return {};
         }