Skip to content

Commit 8d1d1ed

Browse files
committed
fix(oas3): show request body description for file upload content types
When a request body uses a content type like application/octet-stream that triggers file upload mode, the description from the requestBody object was not being displayed. Instead, only the "Example values are not available" message was shown (in non-execute mode) or just the file input (in execute mode). This renders the requestBody description above the file input or the example-not-available message, consistent with how descriptions are shown for other content types. Fixes #5637
1 parent 3608eaa commit 8d1d1ed

1 file changed

Lines changed: 14 additions & 4 deletions

File tree

src/core/plugins/oas3/components/request-body.jsx

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,12 +114,22 @@ const RequestBody = ({
114114
const Input = getComponent("Input")
115115

116116
if(!isExecute) {
117-
return <i>
118-
Example values are not available for <code>{contentType}</code> media types.
119-
</i>
117+
return <div>
118+
{ requestBodyDescription &&
119+
<Markdown source={requestBodyDescription} />
120+
}
121+
<i>
122+
Example values are not available for <code>{contentType}</code> media types.
123+
</i>
124+
</div>
120125
}
121126

122-
return <Input type={"file"} onChange={handleFile} />
127+
return <div>
128+
{ requestBodyDescription &&
129+
<Markdown source={requestBodyDescription} />
130+
}
131+
<Input type={"file"} onChange={handleFile} />
132+
</div>
123133
}
124134

125135

0 commit comments

Comments
 (0)