diff --git a/semantic-conventions/src/opentelemetry/semconv/templating/markdown/__init__.py b/semantic-conventions/src/opentelemetry/semconv/templating/markdown/__init__.py index a2511276..bb9faa2d 100644 --- a/semantic-conventions/src/opentelemetry/semconv/templating/markdown/__init__.py +++ b/semantic-conventions/src/opentelemetry/semconv/templating/markdown/__init__.py @@ -243,7 +243,10 @@ def to_markdown_metric_table( "| -------- | --------------- | ----------- | -------------- |\n" ) - description = self._description_with_badge(semconv.stability, semconv.deprecated) + semconv.brief + description = ( + self._description_with_badge(semconv.stability, semconv.deprecated) + + semconv.brief + ) if semconv.note: self.render_ctx.add_note(semconv.note) description += f" [{len(self.render_ctx.notes)}]" diff --git a/semantic-conventions/src/tests/data/compat/enum_type_changed/vnext.yaml b/semantic-conventions/src/tests/data/compat/enum_type_changed/vnext.yaml index 8732618e..362cfa36 100644 --- a/semantic-conventions/src/tests/data/compat/enum_type_changed/vnext.yaml +++ b/semantic-conventions/src/tests/data/compat/enum_type_changed/vnext.yaml @@ -12,7 +12,6 @@ groups: brief: "enum one" stability: stable value: 1 - stability: experimental brief: "third attribute" note: "third attribute note" examples: [3] diff --git a/semantic-conventions/src/tests/data/compat/enum_value_changed/vnext.yaml b/semantic-conventions/src/tests/data/compat/enum_value_changed/vnext.yaml index 73f7b688..c04605b5 100644 --- a/semantic-conventions/src/tests/data/compat/enum_value_changed/vnext.yaml +++ b/semantic-conventions/src/tests/data/compat/enum_value_changed/vnext.yaml @@ -12,7 +12,6 @@ groups: brief: "enum one" stability: stable value: "1" - stability: experimental - id: enum_two brief: "enum two" stability: experimental diff --git a/semantic-conventions/src/tests/data/markdown/stability/all_badges_expected.md b/semantic-conventions/src/tests/data/markdown/stability/all_badges_expected.md index 856f8a0c..21578858 100644 --- a/semantic-conventions/src/tests/data/markdown/stability/all_badges_expected.md +++ b/semantic-conventions/src/tests/data/markdown/stability/all_badges_expected.md @@ -5,6 +5,16 @@ | [`test.deprecated_stable_attr`](stable_badges_expected.md) | boolean | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
| | `Required` | | [`test.exp_attr`](stable_badges_expected.md) | boolean | ![Experimental](https://img.shields.io/badge/-experimental-blue)
| | `Required` | | [`test.stable_attr`](stable_badges_expected.md) | boolean | ![Stable](https://img.shields.io/badge/-stable-lightgreen)
| | `Required` | +| [`test.stable_enum_attr`](stable_badges_expected.md) | string | ![Stable](https://img.shields.io/badge/-stable-lightgreen)
| `one` | `Recommended` | + +`test.stable_enum_attr` MUST be one of the following: + +| Value | Description | +|---|---| +| `one` | ![Stable](https://img.shields.io/badge/-stable-lightgreen)
member one | +| `two` | ![Experimental](https://img.shields.io/badge/-experimental-blue)
member two | +| `three` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
member three | +| `four` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
member four | @@ -14,6 +24,7 @@ | [`test.deprecated_stable_attr`](stable_badges_expected.md) | boolean | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
| | `Required` | | [`test.exp_attr`](stable_badges_expected.md) | boolean | ![Experimental](https://img.shields.io/badge/-experimental-blue)
| | `Required` | | [`test.stable_attr`](stable_badges_expected.md) | boolean | ![Stable](https://img.shields.io/badge/-stable-lightgreen)
| | `Required` | +| [`test.stable_enum_attr`](stable_badges_expected.md) | string | ![Stable](https://img.shields.io/badge/-stable-lightgreen)
| `one` | `Recommended` | @@ -23,6 +34,16 @@ | [`test.deprecated_stable_attr`](stable_badges_expected.md) | boolean | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
| | `Required` | | [`test.exp_attr`](stable_badges_expected.md) | boolean | ![Experimental](https://img.shields.io/badge/-experimental-blue)
| | `Required` | | [`test.stable_attr`](stable_badges_expected.md) | boolean | ![Stable](https://img.shields.io/badge/-stable-lightgreen)
| | `Required` | +| [`test.stable_enum_attr`](stable_badges_expected.md) | string | ![Stable](https://img.shields.io/badge/-stable-lightgreen)
| `one` | `Recommended` | + +`test.stable_enum_attr` MUST be one of the following: + +| Value | Description | +|---|---| +| `one` | ![Stable](https://img.shields.io/badge/-stable-lightgreen)
member one | +| `two` | ![Experimental](https://img.shields.io/badge/-experimental-blue)
member two | +| `three` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
member three | +| `four` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
member four | diff --git a/semantic-conventions/src/tests/data/markdown/stability/stability.yaml b/semantic-conventions/src/tests/data/markdown/stability/stability.yaml index 0364c64e..357f09f2 100644 --- a/semantic-conventions/src/tests/data/markdown/stability/stability.yaml +++ b/semantic-conventions/src/tests/data/markdown/stability/stability.yaml @@ -56,6 +56,7 @@ groups: - ref: test.stable_attr - ref: test.deprecated_stable_attr - ref: test.deprecated_experimental_attr + - ref: test.stable_enum_attr - id: extends_test brief: 'extends_test' extends: test diff --git a/semantic-conventions/src/tests/data/markdown/stability/stable_badges_expected.md b/semantic-conventions/src/tests/data/markdown/stability/stable_badges_expected.md index b1e779ad..42717ce6 100644 --- a/semantic-conventions/src/tests/data/markdown/stability/stable_badges_expected.md +++ b/semantic-conventions/src/tests/data/markdown/stability/stable_badges_expected.md @@ -5,6 +5,16 @@ | [`test.deprecated_stable_attr`](stable_badges_expected.md) | boolean | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
| | `Required` | | [`test.exp_attr`](stable_badges_expected.md) | boolean | | | `Required` | | [`test.stable_attr`](stable_badges_expected.md) | boolean | ![Stable](https://img.shields.io/badge/-stable-lightgreen)
| | `Required` | +| [`test.stable_enum_attr`](stable_badges_expected.md) | string | ![Stable](https://img.shields.io/badge/-stable-lightgreen)
| `one` | `Recommended` | + +`test.stable_enum_attr` MUST be one of the following: + +| Value | Description | +|---|---| +| `one` | ![Stable](https://img.shields.io/badge/-stable-lightgreen)
member one | +| `two` | member two | +| `three` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
member three | +| `four` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
member four | @@ -14,6 +24,7 @@ | [`test.deprecated_stable_attr`](stable_badges_expected.md) | boolean | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
| | `Required` | | [`test.exp_attr`](stable_badges_expected.md) | boolean | | | `Required` | | [`test.stable_attr`](stable_badges_expected.md) | boolean | ![Stable](https://img.shields.io/badge/-stable-lightgreen)
| | `Required` | +| [`test.stable_enum_attr`](stable_badges_expected.md) | string | ![Stable](https://img.shields.io/badge/-stable-lightgreen)
| `one` | `Recommended` | @@ -23,6 +34,16 @@ | [`test.deprecated_stable_attr`](stable_badges_expected.md) | boolean | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
| | `Required` | | [`test.exp_attr`](stable_badges_expected.md) | boolean | | | `Required` | | [`test.stable_attr`](stable_badges_expected.md) | boolean | ![Stable](https://img.shields.io/badge/-stable-lightgreen)
| | `Required` | +| [`test.stable_enum_attr`](stable_badges_expected.md) | string | ![Stable](https://img.shields.io/badge/-stable-lightgreen)
| `one` | `Recommended` | + +`test.stable_enum_attr` MUST be one of the following: + +| Value | Description | +|---|---| +| `one` | ![Stable](https://img.shields.io/badge/-stable-lightgreen)
member one | +| `two` | member two | +| `three` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
member three | +| `four` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
member four | diff --git a/semantic-conventions/src/tests/data/yaml/errors/stability/missing_stability_on_enum_member.yaml b/semantic-conventions/src/tests/data/yaml/errors/stability/missing_stability_on_enum_member.yaml index fe9300be..79801692 100644 --- a/semantic-conventions/src/tests/data/yaml/errors/stability/missing_stability_on_enum_member.yaml +++ b/semantic-conventions/src/tests/data/yaml/errors/stability/missing_stability_on_enum_member.yaml @@ -10,3 +10,4 @@ groups: - id: one value: "one" brief: 'member one' + stability: experimental \ No newline at end of file diff --git a/semantic-conventions/src/tests/data/yaml/errors/stability/wrong_stability_value_on_enum_member.yaml b/semantic-conventions/src/tests/data/yaml/errors/stability/wrong_stability_value_on_enum_member.yaml index 9d7df545..acf36479 100644 --- a/semantic-conventions/src/tests/data/yaml/errors/stability/wrong_stability_value_on_enum_member.yaml +++ b/semantic-conventions/src/tests/data/yaml/errors/stability/wrong_stability_value_on_enum_member.yaml @@ -11,3 +11,4 @@ groups: value: "one" brief: 'member one' stability: will_fail + stability: experimental \ No newline at end of file