gsadmin/gitbook
1
0
Fork 0
mirror of https://github.com/GitbookIO/gitbook.git synced 2026-09-16 15:45:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Optional label in OpenAPI x-codeSamples (#3376)

Browse Source
This commit is contained in:
Nolann B.
2025-06-23 13:54:15 +02:00
committed by GitHub
parent f033734308
commit 1e013cd87c
3 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/spotty-apples-crash.md
+6
View File
@@ -0,0 +1,6 @@
---
'@gitbook/openapi-parser': patch
'@gitbook/react-openapi': patch
---
Optional label in OpenAPI x-codeSamples
packages/openapi-parser/src/types.ts
+1 -1
View File
@@ -79,7 +79,7 @@ export type OpenAPIStability = 'experimental' | 'alpha' | 'beta';
*/ */
export interface OpenAPICustomCodeSample { export interface OpenAPICustomCodeSample {
lang: string; lang: string;
label: string; label?: string;
source: string; source: string;
} }
packages/react-openapi/src/OpenAPICodeSample.tsx
+2 -6
View File
@@ -253,15 +253,11 @@ function getCustomCodeSamples(props: {
if (customSamples && Array.isArray(customSamples)) { if (customSamples && Array.isArray(customSamples)) {
customCodeSamples = customSamples customCodeSamples = customSamples
.filter((sample) => { .filter((sample) => {
return ( return typeof sample.source === 'string' && typeof sample.lang === 'string';
typeof sample.label === 'string' &&
typeof sample.source === 'string' &&
typeof sample.lang === 'string'
);
}) })
.map((sample, index) => ({ .map((sample, index) => ({
key: `custom-sample-${sample.lang}-${index}`, key: `custom-sample-${sample.lang}-${index}`,
label: sample.label, label: sample.label || sample.lang,
body: context.renderCodeBlock({ body: context.renderCodeBlock({
code: sample.source, code: sample.source,
syntax: sample.lang, syntax: sample.lang,