JSON schema contribution guide #2248
Open
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
Zash
reviewed
Sep 4, 2024
Zash
reviewed
Sep 12, 2024
aarnq
changed the title
aarnq
force-pushed
the
aarnq/jsonschema-contribution-guide
branch
from
eb2615f
to
3c0d091
Compare
Ajarmar
reviewed
Oct 21, 2024
Comment on lines
+206
to
+210
| Compositions and conditions here refers to the use of `allOf`, `anyOf`, and `oneOf`, etc. to define schema compositions and conditions. | ||
|
|
||
| - Schemas with compositions and conditions must set defaults because otherwise they cannot be fully resolved. | ||
| - Schemas with compositions and conditions should set examples because otherwise they cannot be fully resolved. | ||
| - Should not use `if` `then` `else` as it has less support in tooling, and has a semantic that is generally different from other schema constructs. |
There was a problem hiding this comment.
Do you think it might be good to include some examples in this section? I think conditionals can get kind of advanced, and there aren't that many examples to look at in our existing schemas.
|
|
||
| ### Metadata | ||
|
|
||
| These guidelines aims to help to create better quality reference documentation. |
There was a problem hiding this comment.
Suggested change
| These guidelines aims to help to create better quality reference documentation. | |
| These guidelines aim to help in creating better quality reference documentation. |
Minor wording nit.
|
|
||
| ### Structural | ||
|
|
||
| These guidelines aims to help to create schemas that are easier to read and write. |
There was a problem hiding this comment.
Suggested change
| These guidelines aims to help to create schemas that are easier to read and write. | |
| These guidelines aim to help in creating schemas that are easier to read and write. |
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.
Warning
This is a public repository, ensure not to disclose:
What kind of PR is this?
Required: Mark one of the following that is applicable:
Optional: Mark one or more of the following that are applicable:
Important
Breaking changes should be marked
kind/admin-changeorkind/dev-changedepending on typeCritical security fixes should be marked with
kind/securityWhat does this PR do / why do we need this PR?
This adds guidelines on how to write schema.
Closes https://github.com/elastisys/ck8s-issue-tracker/issues/282
Information to reviewers
Checklist
NetworkPolicy Dashboard