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

Fix x-codeSamples: false not working at the single operation level (#2408)

Browse Source
This commit is contained in:
Samy Pessé
2024-07-25 14:59:30 +02:00
committed by GitHub
parent 709f1a1ccb
commit ede2335fb3
3 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/lemon-walls-eat.md
+5
View File
@@ -0,0 +1,5 @@
---
'@gitbook/react-openapi': patch
---
Fix x-codeSamples: false not working at the single operation level
packages/react-openapi/src/OpenAPICodeSample.tsx
+6 -2
View File
@@ -52,7 +52,7 @@ export function OpenAPICodeSample(props: {
}> = null; }> = null;
(['x-custom-examples', 'x-code-samples', 'x-codeSamples'] as const).forEach((key) => { (['x-custom-examples', 'x-code-samples', 'x-codeSamples'] as const).forEach((key) => {
const customSamples = data.operation[key]; const customSamples = data.operation[key];
if (customSamples) { if (customSamples && Array.isArray(customSamples)) {
customCodeSamples = customSamples.map((sample) => ({ customCodeSamples = customSamples.map((sample) => ({
key: `redocly-${sample.lang}`, key: `redocly-${sample.lang}`,
label: sample.label, label: sample.label,
@@ -61,7 +61,11 @@ export function OpenAPICodeSample(props: {
} }
}); });
const samples = customCodeSamples ?? (data['x-codeSamples'] !== false ? autoCodeSamples : []); // Code samples can be disabled at the top-level or at the operation level
// If code samples are defined at the operation level, it will override the top-level setting
const codeSamplesDisabled =
data['x-codeSamples'] === false || data.operation['x-codeSamples'] === false;
const samples = customCodeSamples ?? (!codeSamplesDisabled ? autoCodeSamples : []);
if (samples.length === 0) { if (samples.length === 0) {
return null; return null;
} }
packages/react-openapi/src/fetchOpenAPIOperation.ts
+1 -1
View File
@@ -43,7 +43,7 @@ export interface OpenAPICustomSpecProperties {
*/ */
export interface OpenAPICustomOperationProperties { export interface OpenAPICustomOperationProperties {
'x-code-samples'?: OpenAPICustomCodeSample[]; 'x-code-samples'?: OpenAPICustomCodeSample[];
'x-codeSamples'?: OpenAPICustomCodeSample[]; 'x-codeSamples'?: OpenAPICustomCodeSample[] | false;
'x-custom-examples'?: OpenAPICustomCodeSample[]; 'x-custom-examples'?: OpenAPICustomCodeSample[];
/** /**