Skip to content

Commit d9029c7

Browse files
authored
Include apiKey example in CodeSample security headers (#2804)
1 parent fe8acc9 commit d9029c7

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

.changeset/blue-vans-marry.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@gitbook/react-openapi': patch
3+
---
4+
5+
Support apiKey in CodeSample security headers

packages/react-openapi/src/OpenAPICodeSample.tsx

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,28 @@ function getSecurityHeaders(securities: OpenAPIOperationData['securities']): {
153153
Authorization: scheme + ' ' + (security[1].bearerFormat ?? '<token>'),
154154
};
155155
}
156+
case 'apiKey': {
157+
if (security[1].in !== 'header') return {};
158+
159+
const name = security[1].name ?? 'Authorization';
160+
let scheme = security[0];
161+
162+
switch (scheme) {
163+
case 'bearerAuth':
164+
scheme = 'Bearer';
165+
break;
166+
case 'token':
167+
scheme = 'Token';
168+
break;
169+
case 'basic':
170+
scheme = 'Basic';
171+
break;
172+
}
173+
174+
return {
175+
[name]: scheme + ' ' + '<apiKey>',
176+
};
177+
}
156178
default: {
157179
return {};
158180
}

0 commit comments

Comments
 (0)