-
-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
16 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Annotations from comments | ||
|
||
JSON schema is partially implemented in this tool. It uses line comments to add annotations for the schema because head comments are frequently used by humans and tools like helm-docs. The following annotations are supported: | ||
* [Validation Keywords for Any Instance Type](#strings) | ||
* [Numbers](#numbers) | ||
* [Booleans](#booleans) | ||
* [Arrays](#arrays) | ||
* [Objects](#objects) | ||
* [Nulls](#nulls) | ||
* [Required](#required) | ||
* [Enum](#enum) | ||
|
||
## Validation Keywords for Any Instance Type |