Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typo in Data Types documentation #352

Open
arvind-kumar-avinash opened this issue Aug 10, 2024 · 1 comment
Open

Typo in Data Types documentation #352

arvind-kumar-avinash opened this issue Aug 10, 2024 · 1 comment
Labels
triaged Issue has been reviewd

Comments

@arvind-kumar-avinash
Copy link

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.

@frankkilcommins frankkilcommins added the triaged Issue has been reviewd label Dec 9, 2024
@frankkilcommins
Copy link
Collaborator

This would be best served by removing the word null to avoid confusion. The context is that description can be omitted or contain no value. Both situations are perfectly valid. An explicit description: null however is invalid as the value (if provided) MUST be a string.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triaged Issue has been reviewd
Projects
None yet
Development

No branches or pull requests

2 participants