Skip to content

Automatically call out experimental types and properties#359

Merged
jack-berg merged 3 commits intoopen-telemetry:mainfrom
jack-berg:meta-schema-experimental-types
Nov 1, 2025
Merged

Automatically call out experimental types and properties#359
jack-berg merged 3 commits intoopen-telemetry:mainfrom
jack-berg:meta-schema-experimental-types

Conversation

@jack-berg
Copy link
Copy Markdown
Member

We currently rely on convention to add a warning to a property's description in meta_schema_types.yaml if it is experimental.

This is imprecise and error prone.

In this PR, I automatically flag properties and types as experimental based stability definition:

  • Experimental types start with Experimental
  • Experimental properties end with /development

schema-docs.md calls out experimental types (example) and properties (example).

The descriptive comments added to examples automatically call out experimental properties.

@jack-berg jack-berg requested a review from a team as a code owner October 31, 2025 18:37
Copy link
Copy Markdown
Member

@marcalff marcalff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea.

LGTM.

@jack-berg jack-berg merged commit 909a787 into open-telemetry:main Nov 1, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants