Provide guidance on required and null properties #141
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
jack-berg
commented
Nov 25, 2024
| @@ -2,7 +2,7 @@ | |||
| "$id": "https://opentelemetry.io/otelconfig/meter_provider.json", | |||
| "$schema": "https://json-schema.org/draft/2020-12/schema", | |||
| "title": "MeterProvider", | |||
| "type": ["object", "null"], | |||
| "type": "object", | |||
There was a problem hiding this comment.
Setting meter_provider: is not a sensible thing to do. If you want a noop meter_provider, omit meter_provider altogether.
This same logic applies to all the other places which changed from "type": ["object", "null"] to "type":"object".
jack-berg
commented
Nov 25, 2024
| @@ -26,9 +26,12 @@ | |||
| ] | |||
| } | |||
| }, | |||
| "required": [ | |||
| "readers" | |||
There was a problem hiding this comment.
A meter_provider without readers isn't sensible.
jack-berg
commented
Nov 25, 2024
| @@ -211,9 +214,6 @@ | |||
| "minimum": 0 | |||
| } | |||
| }, | |||
| "required": [ | |||
| "endpoint" | |||
There was a problem hiding this comment.
Endpoint is not actually required for zipkin since there's a well defined default value.
marcalff
reviewed
Nov 28, 2024
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.
I analyzed JSON schema's
requiredandtype: ["null"]concepts and have provided guidance on when and how to use them in schema modeling. Also, I've carefully applied this guidance to existing types.I've been thinking we've needed this for a while, but this conversation was the impetus: #140 (comment)