swagger-api / swagger-api/swagger.io-docs
Incorrect format specified for type string.
Open
Nobody has claimed this yet.
- Dominant language
- Astro
- Stars
- 1.6k
- Forks
- 407
- Avg merge
- 2m
- Merged PRs (30d)
- 2
Description
This is from the following page:
https://swagger.io/docs/specification/describing-responses/
Description above mentions type:string with format: binary or format: base64.
The latter probably should be format: byte; i was not able to find format: base64 in the section around Data Types: https://swagger.io/specification/#dataTypes
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
Open the response documentation page linked in the issue and compare its use of format: base64 with the OpenAPI Data Types section. Update the wording to use the documented format, then verify that the rendered page and surrounding example remain accurate.
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
- Mostly clear
- Newbie friendliness
- 45/100