swagger-api / swagger-api/swagger.io-docs
Typo in Data Types documentation
Open
Beginner friendly
Nobody has claimed this yet.
triaged
- Dominant language
- Astro
- Stars
- 1.6k
- Forks
- 407
- Avg merge
- 2m
- Merged PRs (30d)
- 2
Description
There is a typo in the Data Types documentation at https://swagger.io/docs/specification/data-models/data-types/
The last line reads:
description: Can be any value, including null.
It should be
description: Can be any value, including null.
i.e. null should not be inside backtick quotation.
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 Data Types documentation at https://swagger.io/docs/specification/data-models/data-types/ and locate the final description line for the null type. Remove the backtick formatting around null, then verify the rendered page shows null as plain text.
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
- 68/100