Define or recommend YAML schema supported #3962
Labels
Comments
4 tasks
|
cc @open-telemetry/configuration-maintainers |
1 task
|
#3973 proposes to follow the core schema |
jack-berg
added a commit
that referenced
this issue
May 7, 2024
…ollow (#3973) Fixes #3962 ## Changes Specifies the YAML schema to follow. A schema is a set of YAML tags (i.e. types) and a way to assign types. YAML 1.2 recommends the 'Core schema': the types are those of JSON. Scalars are resolved as one would expect, see [here](https://yaml.org/spec/1.2.2/#103-core-schema) for the details. One important difference with the way that YAML 1.1 used to work is that integer scalars starting with a `0` are interpreted as being written in decimal notation; e.g. `0123` parses to the integer 123 instead of the integer 83 (you can still use octal notation in YAML 1.2 by using `0o123`). Some YAML parsers deviate from the core schema in how this works, for example, both of the more commonly used YAML parsing libraries in Golang parse `0123` as 83 ([go-yaml/yaml](https://github.com/go-yaml/yaml?tab=readme-ov-file#compatibility) and [goccy/go-yaml](https://github.com/goccy/go-yaml/blob/4653a1bb5c0047bb37280ac341e2f091cb44352f/ast/ast.go#L326)). **This may make it a bit difficult to strictly follow this requirement in some languages**. For non-trivial changes, follow the [change proposal process](https://github.com/open-telemetry/opentelemetry-specification/blob/main/CONTRIBUTING.md#proposing-a-change). * [x] Related issues #3962, part of #3963 --------- Co-authored-by: Robert Pająk <pellared@hotmail.com> Co-authored-by: jack-berg <34418638+jack-berg@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Current spec wording says that:
This leaves some ambiguity as YAML supports several 'schemas' (ways of interpreting the values that are not explicitly marked with a type tag). The YAML spec recommends the Core schema (although, IIUC, this recommendation is not normative).
To give a concrete example, in Go, the main YAML parsing libraries (1, 2), both support the YAML 1.1
0leading octal syntax notation, where0123is equivalent to0o123or83, while the YAML 1.2 core schema does not. If this is not the case in other languages, differences when interpreting integer literals could lead to hard-to-debug and unintuitive results.The SDK configuration spec should recommend what YAML schema to use, and if possible explicitly define the recommended behavior with
0leading integer literals.The text was updated successfully, but these errors were encountered: