Skip to content

docs: Fix multiple discrepancies in v2 syntax specification #1121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jsuereth merged 4 commits into from
Jan 21, 2026
Merged

docs: Fix multiple discrepancies in v2 syntax specification #1121

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ef1dfb1
Initial plan
Copilot Jan 7, 2026
2bb5775
Fix: Add missing 'value' property to enum member documentation
Copilot Jan 7, 2026
fc381b7
docs: Fix additional discrepancies in v2 syntax documentation
Copilot Jan 7, 2026
d06298d
Revert: Enum member stability should be Required, not Optional
Copilot Jan 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions schemas/semconv-syntax.v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,13 +169,14 @@ and another example of an int enum attribute:
Enum members have the following properties:

- `id` - Required. Identifies the enum member within this enum.
- `value` - Required. String, int, or boolean value of the enum entry.
- `brief` - Optional. A short description of what this enum member represents.
- `note` - Optional. A more elaborate description of the member.
- `stability` - Required. Specifies the [stability](#stability-levels) of the enum member.
- `deprecated` - Optional. When present, marks the member as deprecated. See [deprecated](#deprecated-structure) for details.
- `annotations` - Optional. Annotations are key-value pairs that provide additional information about the attribute. See [annotations](#annotations) for details.

Enum attributes can only be of type `int` and `string`, the type is deduced from the value.
Enum attributes can be of type `int`, `string`, or `boolean`, the type is deduced from the value.

##### Template type

Expand Down Expand Up @@ -468,7 +469,7 @@ An internal attribute group definition consists of the following properties:

- `id` - Required. Uniquely identifies the attribute group.
- `visibility` - Required. Must be set to `"internal"`.
- `attributes` - Required. List of [attribute references](#attribute-reference) that belong to this group.
- `attributes` - Optional. List of [attribute references](#attribute-reference) that belong to this group.

Example:

Expand All @@ -494,7 +495,7 @@ A public attribute group definition consists of the following properties:
- `brief` - Required. A short description of what this attribute group represents.
- `note` - Optional. A more elaborate description of the attribute group.
- `stability` - Required. Specifies the [stability](#stability-levels) of the attribute group definition.
- `attributes` - List of [attribute references](#attribute-reference) that belong to this group.
- `attributes` - Optional. List of [attribute references](#attribute-reference) that belong to this group.
- `deprecated` - Optional. When present, marks the attribute group as deprecated. See [deprecated](#deprecated-structure) for details.
- `annotations` - Optional. Map of annotations. Annotations are key-value pairs that provide additional information about the attribute group. See [annotations](#annotations) for details.

Expand Down Expand Up @@ -543,9 +544,20 @@ The following stability levels are supported: `stable`, `development`, `alpha`,

The `deprecated` field indicates that a component (attribute, metric, event, etc.) should no longer be used. It supports several deprecation reasons:

All deprecation reasons have the following required properties:

- `reason` - Required. The type of deprecation. Must be one of: `renamed`, `obsoleted`, `uncategorized`, or `unspecified`.
- `note` - Required. Provides context about the deprecation.

Additional properties depending on the reason:

#### Rename

Used when a component has been renamed, for example:
Used when a component has been renamed. Requires an additional property:

- `renamed_to` - Required. The new name of the telemetry object.

Example:

```yaml
attributes:
Expand Down