Switch to structured deprecated enums

Author: thompson-tomo

docs/registry/attributes/os.md

@@ -12,7 +12,7 @@ The operating system (OS) on which the process represented by this resource is r
 | <a id="os-build-id" href="#os-build-id">`os.build_id`</a> | string | Unique identifier for a particular build or compilation of the operating system. | `TQ3C.230805.001.B2`; `20E247`; `22621` | ![Development](https://img.shields.io/badge/-development-blue) |
 | <a id="os-description" href="#os-description">`os.description`</a> | string | Human readable (not intended to be parsed) OS version information, like e.g. reported by `ver` or `lsb_release -a` commands. | `Microsoft Windows [Version 10.0.18363.778]`; `Ubuntu 18.04.1 LTS` | ![Development](https://img.shields.io/badge/-development-blue) |
 | <a id="os-name" href="#os-name">`os.name`</a> | string | Human readable operating system name. | `iOS`; `Android`; `Ubuntu` | ![Development](https://img.shields.io/badge/-development-blue) |
-| <a id="os-type" href="#os-type">`os.type`</a> | string | The operating system type. | `windowsnt`; `windows`; `linux` | ![Development](https://img.shields.io/badge/-development-blue) |
+| <a id="os-type" href="#os-type">`os.type`</a> | string | The operating system type. | `windows_nt`; `windows`; `linux` | ![Development](https://img.shields.io/badge/-development-blue) |
 | <a id="os-version" href="#os-version">`os.version`</a> | string | The version string of the operating system as defined in [Version Attributes](/docs/resource/README.md#version-attributes). | `14.2.1`; `18.04.1` | ![Development](https://img.shields.io/badge/-development-blue) |
 
 ---
@@ -22,4 +22,4 @@ The operating system (OS) on which the process represented by this resource is r
 | Value  | Description | Stability |
 |---|---|---|
 | `unix` | Unix | ![Development](https://img.shields.io/badge/-development-blue) |
-| `windowsnt` | Microsoft Windows NT based OS | ![Development](https://img.shields.io/badge/-development-blue) |
+| `windows_nt` | Microsoft Windows NT based OS | ![Development](https://img.shields.io/badge/-development-blue) |

docs/registry/entities/os.md

@@ -20,7 +20,7 @@
 
 | Attribute  | Type | Description  | Examples  | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
 |---|---|---|---|---|---|
-| [`os.type`](/docs/registry/attributes/os.md) | string | The operating system type. | `windowsnt`; `windows`; `linux` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| [`os.type`](/docs/registry/attributes/os.md) | string | The operating system type. | `windows_nt`; `windows`; `linux` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 | [`os.build_id`](/docs/registry/attributes/os.md) | string | Unique identifier for a particular build or compilation of the operating system. [1] | `TQ3C.230805.001.B2`; `20E247`; `22621` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
 | [`os.description`](/docs/registry/attributes/os.md) | string | Human readable (not intended to be parsed) OS version information, like e.g. reported by `ver` or `lsb_release -a` commands. | `Microsoft Windows [Version 10.0.18363.778]`; `Ubuntu 18.04.1 LTS` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
 | [`os.name`](/docs/registry/attributes/os.md) | string | Human readable operating system name. | `iOS`; `Android`; `Ubuntu` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
@@ -41,7 +41,7 @@
 | Value  | Description | Stability |
 |---|---|---|
 | `unix` | Unix | ![Development](https://img.shields.io/badge/-development-blue) |
-| `windowsnt` | Microsoft Windows NT based OS | ![Development](https://img.shields.io/badge/-development-blue) |
+| `windows_nt` | Microsoft Windows NT based OS | ![Development](https://img.shields.io/badge/-development-blue) |
 
 
 <!-- markdownlint-restore -->

docs/resource/os.md

@@ -18,7 +18,7 @@ In case of virtualized environments, this is the operating system as it is obser
 
 | Attribute  | Type | Description  | Examples  | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
 |---|---|---|---|---|---|
-| [`os.type`](/docs/registry/attributes/os.md) | string | The operating system type. | `windowsnt`; `windows`; `linux` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| [`os.type`](/docs/registry/attributes/os.md) | string | The operating system type. | `windows_nt`; `windows`; `linux` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 | [`os.build_id`](/docs/registry/attributes/os.md) | string | Unique identifier for a particular build or compilation of the operating system. [1] | `TQ3C.230805.001.B2`; `20E247`; `22621` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
 | [`os.description`](/docs/registry/attributes/os.md) | string | Human readable (not intended to be parsed) OS version information, like e.g. reported by `ver` or `lsb_release -a` commands. | `Microsoft Windows [Version 10.0.18363.778]`; `Ubuntu 18.04.1 LTS` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
 | [`os.name`](/docs/registry/attributes/os.md) | string | Human readable operating system name. | `iOS`; `Android`; `Ubuntu` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
@@ -39,7 +39,7 @@ In case of virtualized environments, this is the operating system as it is obser
 | Value  | Description | Stability |
 |---|---|---|
 | `unix` | Unix | ![Development](https://img.shields.io/badge/-development-blue) |
-| `windowsnt` | Microsoft Windows NT based OS | ![Development](https://img.shields.io/badge/-development-blue) |
+| `windows_nt` | Microsoft Windows NT based OS | ![Development](https://img.shields.io/badge/-development-blue) |
 
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->

docs/resource/zos.md

@@ -88,7 +88,7 @@ The following table describes how to populate the operating system attributes on
 | Value  | Description | Stability |
 |---|---|---|
 | `unix` | Unix | ![Development](https://img.shields.io/badge/-development-blue) |
-| `windowsnt` | Microsoft Windows NT based OS | ![Development](https://img.shields.io/badge/-development-blue) |
+| `windows_nt` | Microsoft Windows NT based OS | ![Development](https://img.shields.io/badge/-development-blue) |
 
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->

model/os/registry.yaml

@@ -11,19 +11,23 @@ groups:
       - id: os.type
         type:
           members:
-            - id: windowsnt
-              value: 'windowsnt'
+            - id: windows_nt
+              value: 'windows_nt'
               brief: "Microsoft Windows NT based OS"
               stability: development
             - id: windows
               value: 'windows'
               brief: "Microsoft Windows"
-              deprecated: Should use `windowsnt` instead'
+              deprecated:
+                reason: renamed
+                renamed_to: windows_nt
               stability: development
             - id: linux
               value: 'linux'
               brief: "Linux"
-              deprecated: Should use `unix` instead'
+              deprecated:
+                reason: renamed
+                renamed_to: unix
               stability: development
             - id: unix
               value: 'unix'
@@ -32,54 +36,82 @@ groups:
             - id: darwin
               value: 'darwin'
               brief: "Apple Darwin"
-              deprecated: Should be set as the `os.family` instead.
+              deprecated:
+                reason: renamed
+                renamed_to: unix
+                note: Darwin should be set as a `os.family` member instead.
               stability: development
             - id: freebsd
               value: 'freebsd'
               brief: "FreeBSD"
-              deprecated: "Use `os.name` instead"
+              deprecated:
+                reason: renamed
+                renamed_to: unix
+                note: FreeBSD should be set as the "Use `os.name` instead.
               stability: development
             - id: netbsd
               value: 'netbsd'
               brief: "NetBSD"
-              deprecated: "Use `os.name` instead"
+              deprecated:
+                reason: renamed
+                renamed_to: unix
+                note: NetBSD should be set as the "Use `os.name` instead.
               stability: development
             - id: openbsd
               value: 'openbsd'
               brief: "OpenBSD"
-              deprecated: "Use `os.name` instead"
+              deprecated:
+                reason: renamed
+                renamed_to: unix
+                note: OpenBSD should be set as the "Use `os.name` instead.
               stability: development
             - id: dragonflybsd
               value: 'dragonflybsd'
               brief: "DragonFly BSD"
-              deprecated: "Use `os.name` instead"
+              deprecated:
+                reason: renamed
+                renamed_to: unix
+                note: DragonFly BSD should be set as the "Use `os.name` instead.
               stability: development
             - id: hpux
               value: 'hpux'
               brief: "HP-UX (Hewlett Packard Unix)"
-              deprecated: "Use `os.name` instead"
+              deprecated:
+                reason: renamed
+                renamed_to: unix
+                note: HP-UX should be set as the "Use `os.name` instead.
               stability: development
             - id: aix
               value: 'aix'
               brief: "AIX (Advanced Interactive eXecutive)"
-              deprecated: "Use `os.name` instead"
+              deprecated:
+                reason: renamed
+                renamed_to: unix
+                note: AIX should be set as the "Use `os.name` instead.
               stability: development
             - id: solaris
               value: 'solaris'
               brief: "SunOS, Oracle Solaris"
-              deprecated: "Use `os.name` instead"
+              deprecated:
+                reason: renamed
+                renamed_to: unix
+                note: Solaris should be set as the "Use `os.name` instead.
               stability: development
             - id: z_os
               value: 'z_os'
               brief: "Deprecated. Use `zos` instead."
               deprecated:
                 reason: renamed
-                renamed_to: "zos"
+                renamed_to: unix
+                note: zos should be set as the "Use `os.name` instead.
               stability: development
             - id: zos
               value: 'zos'
               brief: "IBM z/OS"
-              deprecated: "Use `os.name` instead"
+              deprecated:
+                reason: renamed
+                renamed_to: unix
+                note: zos should be set as the "Use `os.name` instead.
               stability: development
         brief: >
           The operating system type.