From 5fb350ff66fac165b27f8bfc605667e2aa5210d8 Mon Sep 17 00:00:00 2001 From: jack-berg <34418638+jack-berg@users.noreply.github.com> Date: Wed, 18 Sep 2024 10:42:14 -0500 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Alex Boten <223565+codeboten@users.noreply.github.com> --- README.md | 2 +- examples/kitchen-sink.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d6588d7..8922968 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ In instances where there is a type mismatch between the JSON schema and equivale ### Name-value pairs -When a type requires a configurable list of name-value pairs (i.e. resource attributes, HTTP headers), model using an array of objects, each with `name` and `value` properties. While an arrays of name-value objects is slightly more verbose an object where each key-value is an entry, it is preferred because: +When a type requires a configurable list of name-value pairs (i.e. resource attributes, HTTP headers), model using an array of objects, each with `name` and `value` properties. While an array of name-value objects is slightly more verbose than an object where each key-value is an entry, the latter is preferred because: * Avoids user input as keys, which ensures conformity with the [snake_case properties](#property-name-case) rule. * Allows both the names and the values to be targets for [env var substitution]. For example: diff --git a/examples/kitchen-sink.yaml b/examples/kitchen-sink.yaml index 5611b94..732f657 100644 --- a/examples/kitchen-sink.yaml +++ b/examples/kitchen-sink.yaml @@ -421,7 +421,7 @@ resource: # Configure `service.name` resource attribute # # Environment variable: OTEL_SERVICE_NAME - - name: service-name + - name: service.name value: unknown_service # Configure other resource attributes with explicit types. - name: string_key