Merge pull request #648 from michaeltlombardi/gh-642/main/schema-casing-canonicalization

(GH-642) Ensure camelCase for items in `dsc_lib`

Author: SteveL-MSFT

.github/ISSUE_TEMPLATE/Bug_Report.yml

@@ -35,7 +35,7 @@ body:
 
          ```yaml
          # repro.dsc.config.yaml
-         $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/config/document.json
+         $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
          resources:
          - name: repro
            type: Test/Echo

.vscode/docs.code-snippets

@@ -42,7 +42,7 @@
 			"",
 			"```yaml",
 			"# ${1:name}.example.1.dsc.config.yaml",
-			"\\$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/10/config/document.json",
+			"\\$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json",
 			"resources:",
 			"- name: ${7:descriptive resource name}",
 			"  type: Test/Echo",
@@ -101,7 +101,7 @@
 			"",
 			"```yaml",
 			"# $TM_FILENAME_BASE.example.$1.dsc.config.yaml",
-			"\\$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/10/config/document.json",
+			"\\$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json",
 			"resources:",
 			"- name: ${4:descriptive resource name}",
 			"  type: Test/Echo",

archive/registry/registry.dsc.resource.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/bundled/resource/manifest.json",
+  "$schema": "https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.json",
   "type": "Microsoft.Windows/Registry",
   "description": "Manage Windows Registry keys and values",
   "tags": [

configurations/windows/windows_baseline.dsc.yaml

@@ -1,13 +1,13 @@
 # This configuration validates a Windows system against a security baseline configuration
-$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
+$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 metadata:
   Microsoft.DSC:
-    securityContext: Elevated
+    securityContext: elevated
 resources:
 - name: Validate the OS is Windows
   type: Microsoft.DSC/Assertion
   properties:
-    $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
+    $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
     resources:
     - name: os
       type: Microsoft/OSInfo
@@ -18,7 +18,7 @@ resources:
   dependsOn: 
     - "[resourceId('Microsoft.DSC/Assertion','Validate the OS is Windows')]"
   properties:
-    $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
+    $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
     resources:
       - name: Default RDP port
         type: Microsoft.Windows/Registry

configurations/windows/windows_inventory.dsc.yaml

@@ -1,9 +1,9 @@
-$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
+$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
 - name: Validate the OS is Windows
   type: Microsoft.DSC/Assertion
   properties:
-    $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
+    $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
     resources:
     - name: os
       type: Microsoft/OSInfo

docs/reference/cli/config/get.md

@@ -1,6 +1,6 @@
 ---
 description: Command line reference for the 'dsc config get' command
-ms.date:     06/24/2024
+ms.date:     02/28/2025
 ms.topic:    reference
 title:       dsc config get
 ---
@@ -49,12 +49,12 @@ document saved as `example.dsc.config.yaml`.
 
 ```yaml
 # example.dsc.config.yaml
-$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
+$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
 - name: Windows only
   type: Microsoft.DSC/Assertion
   properties:
-    $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
+    $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
     resources:
     - name: os
       type: Microsoft/OSInfo

docs/reference/cli/config/set.md

@@ -1,6 +1,6 @@
 ---
 description: Command line reference for the 'dsc config set' command
-ms.date:     06/24/2024
+ms.date:     02/28/2025
 ms.topic:    reference
 title:       dsc config set
 ---
@@ -50,12 +50,12 @@ The command inspects the resource instances defined in the configuration documen
 
 ```yaml
 # example.dsc.config.yaml
-$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
+$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
 - name: Windows only
   type: Microsoft.DSC/Assertion
   properties:
-    $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
+    $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
     resources:
     - name: os
       type: Microsoft/OSInfo

docs/reference/cli/config/test.md

@@ -1,6 +1,6 @@
 ---
 description: Command line reference for the 'dsc config test' command
-ms.date:     06/24/2024
+ms.date:     02/28/2025
 ms.topic:    reference
 title:       dsc config test
 ---
@@ -49,12 +49,12 @@ resource instances defined in the configuration document saved as `example.dsc.c
 
 ```yaml
 # example.dsc.config.yaml
-$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
+$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
 - name: Windows only
   type: Microsoft.DSC/Assertion
   properties:
-    $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
+    $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
     resources:
     - name: os
       type: Microsoft/OSInfo

docs/reference/cli/resource/list.md

@@ -1,6 +1,6 @@
 ---
 description: Command line reference for the 'dsc resource list' command
-ms.date:     06/24/2024
+ms.date:     02/28/2025
 ms.topic:    reference
 title:       dsc resource list
 ---
@@ -309,24 +309,24 @@ a summary table for the returned resources. The summary table includes the follo
 displayed in the listed order:
 
 - **Type** - The fully qualified type name of the resource.
-- **Kind** - Whether the resource is an `Adapter`, `Group`, or typical `Resource`. For more
-  information, see [DSC Resource kind schema reference][03].
+- **Kind** - Whether the resource is an `adapter`, `group`, `importer`, or typical `Resource`. For
+  more information, see [DSC Resource kind schema reference][03].
 - **Version** - The semantic version of the resource.
 - **Caps** - A display of the resource's [capabilities][04] as flags. The capabilities are
   displayed in the following order, using a `-` instead of the appropriate letter if the resource
   doesn't have a specific capability:
 
-  - `g` indicates that the resource has the [Get capability][05].
-  - `s` indicates that the resource has the [Set capability][06]
-  - `x` indicates that the resource has the [SetHandlesExist capability][07]
-  - `w` indicates that the resource has the [WhatIf capability][08]
-  - `t` indicates that the resource has the [Test capability][09]
-  - `d` indicates that the resource has the [Delete capability][10]
-  - `e` indicates that the resource has the [Export capability][11]
-  - `r` indicates that the resource has the [Resolve capability][12]
+  - `g` indicates that the resource has the [get capability][05].
+  - `s` indicates that the resource has the [set capability][06]
+  - `x` indicates that the resource has the [setHandlesExist capability][07]
+  - `w` indicates that the resource has the [whatIf capability][08]
+  - `t` indicates that the resource has the [test capability][09]
+  - `d` indicates that the resource has the [delete capability][10]
+  - `e` indicates that the resource has the [export capability][11]
+  - `r` indicates that the resource has the [resolve capability][12]
 
   For example, the `Microsoft.Windows/Registry` resource has the following capabilities: `gs--d-`,
-  indicating it has the `Get`, `Set`, and `Delete` capabilities.
+  indicating it has the `get`, `set`, and `delete` capabilities.
 - **RequireAdapter** - The fully qualified type name of the adapter resource that DSC uses to
   invoke the returned resource.
 - **Description** - The short description of the resource's purpose and usage.

docs/reference/cli/schema/command.md

@@ -1,6 +1,6 @@
 ---
 description: Command line reference for the 'dsc schema' command
-ms.date:     06/24/2024
+ms.date:     02/28/2025
 ms.topic:    reference
 title:       dsc schema
 ---
@@ -26,6 +26,22 @@ integrating tool.
 The application uses these schemas to validate data internally when it's received or represent the
 output for one of the application's commands.
 
+> [!NOTE]
+> Currently, the schemas returned by the `dsc schema` command and those published to GitHub are
+> not the same. The published schemas more fully describe and validate the data than the schemas
+> emitted by the command. The DSC team is working to canonicalize the schemas returned from the
+> command.
+>
+> Both the published schemas and those returned from this command correctly validate the data. The
+> schemas returned from this command are less strict than the published schemas. Even though data
+> validates against the schemas returned by this command, DSC may raise errors when processing the
+> data. For example, the returned schema for versions indicates that the valid value is a string -
+> but if you specify a string that isn't a semantic version, DSC raises an error. In that case, the
+> data passed the schema validation but was incorrect.
+>
+> Until the schemas are canonicalized, consider using the published schemas when indpendently
+> testing your configuration documents and resource manifests with a JSON Schema validation tool.
+
 ## Examples
 
 ### Example 1 - Retrieve the schema for the dsc resource get command result