Skip to content

Automate enum descriptions#451

Merged
codeboten merged 3 commits intoopen-telemetry:mainfrom
jack-berg:automate-enum-descriptions
Dec 5, 2025
Merged

Automate enum descriptions#451
codeboten merged 3 commits intoopen-telemetry:mainfrom
jack-berg:automate-enum-descriptions

Conversation

@jack-berg
Copy link
Copy Markdown
Member

We currently include manually maintained lists of enum values in various property descriptions. This is error prone. Also, it omits valuable enum value descriptions which we now track.

In this PR:

  • Enrich the descriptions of enum properties in the compiled schema with lists of enum values and their descriptions
  • Exclude these descriptions from schema-docs.md, since the links make it trivial to navigate to the enum type definition and see all the values and their descriptions

@jack-berg jack-berg requested a review from a team as a code owner December 4, 2025 02:55
@codeboten codeboten merged commit 95851c7 into open-telemetry:main Dec 5, 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