Use more json schema annotations in the basic form #5532
Merged
Conversation
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
Signed-off-by: Antonio Gamez Diaz <[email protected]>
Signed-off-by: Antonio Gamez Diaz <[email protected]>
Signed-off-by: Antonio Gamez Diaz <[email protected]> Conflicts: dashboard/src/shared/schema.ts
| </div> | ||
| </> | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| export function renderConfigType(value: IBasicFormParam) { | ||
| return renderCellWithTooltip(value, "type", "italics"); | ||
| const stringType = | ||
| value?.type === "array" ? `${value?.type}<${value?.items?.type}>` : value?.type; |
There was a problem hiding this comment.
Suggested change
| value?.type === "array" ? `${value?.type}<${value?.items?.type}>` : value?.type; | |
| value?.type === "array" ? `array of ${value?.items?.type}` : value?.type; |
Minor suggestion, as it is for human reading.
There was a problem hiding this comment.
Ok, done (in a follow-up PR)
After:
Before:
Base automatically changed from
2-5519-yamlDecodingFix
to
1-3535-customSchema
October 21, 2022 16:31
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of the change
As pointed out by @jl-beast at #5512, we could leverage more JSON Schema built-in annotations to enrich the UX.
This PR (and the stacked ones) is adding support for
examples,readOnly,deprecated,maxItems,multipleOfamongst others (following http://json-schema.org/draft/2020-12/json-schema-validation.html#name-a-vocabulary-for-structural)Benefits
Richer UX in the basic form for complex schemas
Possible drawbacks
N/A
Applicable issues
Additional information