swagger-api / swagger-api/swagger-ui
`Example.externalValue` is not displayed
Open
Nobody has claimed this yet.
cat: rendering
specification: 3.x
type: feature
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Example Swagger/OpenAPI definition
openapi: 3.0.0
paths:
/:
post:
requestBody:
content:
image/png:
schema:
type: string
format: binary
examples:
KittenImage:
externalValue: "https://placekitten.com/200/300"
responses:
"200":
description: OK!
Current behavior
Expected behavior
I should be able to use the externally-referenced image as an example value for my endpoint (provided that Swagger UI is able to reach the resource).
Additional context or thoughts
#5427.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The report names no source file or test; start by reproducing the supplied OpenAPI 3.0 YAML example in Swagger UI and review the related discussion in issue #5427. Done means the reachable external image is displayed as the endpoint's example value, with coverage for this behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100