From d74a8c844c987d29ccd390a429374fc292401d3d Mon Sep 17 00:00:00 2001 From: Pablo Baeyens Date: Tue, 2 Apr 2024 17:36:37 +0200 Subject: [PATCH 1/4] [configuration] Specify YAML schema that configuration files should follow --- specification/configuration/file-configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/configuration/file-configuration.md b/specification/configuration/file-configuration.md index 6e75166befc..8c66bc77274 100644 --- a/specification/configuration/file-configuration.md +++ b/specification/configuration/file-configuration.md @@ -60,7 +60,7 @@ Configuration files SHOULD use one the following serialization formats: ### YAML file format [YAML](https://yaml.org/spec/1.2.2/) configuration files SHOULD follow YAML spec -revision >= 1.2. +revision >= 1.2 and SHOULD use the [v1.2 YAML core schema](https://yaml.org/spec/1.2.2/#103-core-schema). YAML configuration files MUST use file extensions `.yaml` or `.yml`. From d382d24d31428f7a930d3f9310cd4b6014a8d039 Mon Sep 17 00:00:00 2001 From: Pablo Baeyens Date: Tue, 2 Apr 2024 17:50:39 +0200 Subject: [PATCH 2/4] Add changelog note --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a254eb0a637..65ecdf352a9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -46,6 +46,8 @@ release. - Clarify environment variable substitution is not recursive ([#3913](https://github.com/open-telemetry/opentelemetry-specification/pull/3913)) +- Clarify the schema for YAML configuration files + ([#3973](https://github.com/open-telemetry/opentelemetry-specification/pull/3973)) ### Common From 34e94bc157c33ae0f82c8ad8224a91562a58783a Mon Sep 17 00:00:00 2001 From: Pablo Baeyens Date: Wed, 17 Apr 2024 13:10:12 +0200 Subject: [PATCH 3/4] Fix lint --- CHANGELOG.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 24dc414766d..69ce9603937 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -97,7 +97,6 @@ release. - Add simple scope configuration to Tracer, Meter, Logger (experimental). ([#3877](https://github.com/open-telemetry/opentelemetry-specification/pull/3877)) - ### Common - No changes. From 2c87f0d8b0b71c147ccaf494eafb56be82fc37fe Mon Sep 17 00:00:00 2001 From: Pablo Baeyens Date: Tue, 7 May 2024 16:18:42 +0200 Subject: [PATCH 4/4] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Pająk --- specification/configuration/file-configuration.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/specification/configuration/file-configuration.md b/specification/configuration/file-configuration.md index 8c3f5c7e82a..d9fd4986ff2 100644 --- a/specification/configuration/file-configuration.md +++ b/specification/configuration/file-configuration.md @@ -63,7 +63,9 @@ Configuration files SHOULD use one the following serialization formats: ### YAML file format [YAML](https://yaml.org/spec/1.2.2/) configuration files SHOULD follow YAML spec -revision >= 1.2 and SHOULD use the [v1.2 YAML core schema](https://yaml.org/spec/1.2.2/#103-core-schema). +revision >= 1.2. + +YAML configuration files SHOULD be parsed using [v1.2 YAML core schema](https://yaml.org/spec/1.2.2/#103-core-schema). YAML configuration files MUST use file extensions `.yaml` or `.yml`.