Include apiKey example in CodeSample security headers (#2804)

This commit is contained in:
Nolann B.
2025-02-04 17:19:39 +01:00
committed by GitHub
parent fe8acc986e
commit d9029c7e1e
2 changed files with 27 additions and 0 deletions
+5
View File
@@ -0,0 +1,5 @@
---
'@gitbook/react-openapi': patch
---
Support apiKey in CodeSample security headers
@@ -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 {};
}