Add note about schema url and schema version #605
Merged
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.
It wasn't obvious to me that
schema_url
requires that the last part of the URL path is the schema version number.From the spec:
This PR extends the comment for each schema_url to make this crucial piece of information clear. Note there are still other relevant bits of information about schema_url that readers need to follow the link to
https://opentelemetry.io/docs/specs/otel/schemas/#schema-url
in order to understand. E.g. that the version follows the formatMAJOR.MINOR.PATCH
and more.