Skip to content

Commit ff3b708

Browse files
authored
Remove read-only properties from codesample (#2965)
1 parent e996904 commit ff3b708

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

.changeset/silly-kings-look.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+
Remove read-only properties from codesample

packages/react-openapi/src/OpenAPICodeSample.tsx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,17 @@ export function OpenAPICodeSample(props: {
2626
}
2727

2828
if (param.in === 'header' && param.required) {
29-
const example = param.schema ? generateSchemaExample(param.schema) : undefined;
29+
const example = param.schema
30+
? generateSchemaExample(param.schema, { mode: 'write' })
31+
: undefined;
3032
if (example !== undefined && param.name) {
3133
headersObject[param.name] =
3234
typeof example !== 'string' ? stringifyOpenAPI(example) : example;
3335
}
3436
} else if (param.in === 'query' && param.required) {
35-
const example = param.schema ? generateSchemaExample(param.schema) : undefined;
37+
const example = param.schema
38+
? generateSchemaExample(param.schema, { mode: 'write' })
39+
: undefined;
3640
if (example !== undefined && param.name) {
3741
searchParams.append(
3842
param.name,

0 commit comments

Comments
 (0)