swagger-api / swagger-api/swagger.io-docs
missing file object in yaml spec for upload file specs
Open
Nobody has claimed this yet.
- Dominant language
- Astro
- Stars
- 1.6k
- Forks
- 407
- Avg merge
- 2m
- Merged PRs (30d)
- 2
Description
In the upload file documentation there is a missing property for the multipart request example
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
orderId:
type: integer
userId:
type: integer
fileName:
type: string
+ file:
+ type: string
+ format: binary
Link to the doc:
https://swagger.io/docs/specification/describing-request-body/file-upload/
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
Locate the source for the linked upload-file documentation page and find its multipart/form-data YAML example. Compare it with the issue's diff, then verify that the rendered page includes the file property with string and binary format.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100