From 2887600aa06533c227ea39bf7bdc3af01ae300a8 Mon Sep 17 00:00:00 2001
From: FoxxMD <FoxxMD@users.noreply.github.com>
Date: Tue, 28 Jul 2026 01:40:22 +0000
Subject: [PATCH] docs: Clarify language around id/name

---
 src/backend/common/infrastructure/config/client/index.ts | 6 +++---
 src/backend/common/infrastructure/config/common.ts       | 7 ++++---
 src/backend/common/infrastructure/config/source/index.ts | 5 +++--
 3 files changed, 10 insertions(+), 8 deletions(-)

diff --git a/src/backend/common/infrastructure/config/client/index.ts b/src/backend/common/infrastructure/config/client/index.ts
index 85ee1a5d..4e1a1d32 100644
--- a/src/backend/common/infrastructure/config/client/index.ts
+++ b/src/backend/common/infrastructure/config/client/index.ts
@@ -171,13 +171,13 @@ export type CommonClientOptions = z.infer<typeof commonClientOptionsSchema>;
 export const commonClientConfigSchema = z.object({
     ...commonConfigSchema.shape,
     /**
-     * Unique identifier for this client. Used with sources to restrict where scrobbles are sent.
+     * Vanity name for this client
      *
      * @examples ["MyConfig"]
      * */
     name: z.string().meta({
-        description: "Unique identifier for this client.",
-        examples: ["MyConfig"]
+        description: "Vanity name for this client.",
+        examples: ["Foxx's Cool Client"]
     }),
     /**
      * Specific data required to configure this client
diff --git a/src/backend/common/infrastructure/config/common.ts b/src/backend/common/infrastructure/config/common.ts
index 86ff3825..3f3ed479 100644
--- a/src/backend/common/infrastructure/config/common.ts
+++ b/src/backend/common/infrastructure/config/common.ts
@@ -22,17 +22,18 @@ export const commonConfigSchema = z.object({
      * If no id is given the name of this component will be used.
      */
     id: z.string().optional().meta({
-        description: "A UNIQUE identifier for this Source/Client"
+        description: "A UNIQUE identifier for this Source/Client",
+        examples: ["fooGlobalA"]
     }),
     data: commonDataSchema.optional(),
     /**
-     * Should MS use this client/source? Defaults to true
+     * Should MS parse this config and create a client/source from it?
      *
      * @default true
      * @examples [true]
      * */
     enable: z.boolean().optional().meta({
-        description: "Should MS use this client/source?",
+        description: "Should MS parse this config and create a client/source from it?",
         default: true,
         examples: [true]
     })
diff --git a/src/backend/common/infrastructure/config/source/index.ts b/src/backend/common/infrastructure/config/source/index.ts
index 77695a5b..848390be 100644
--- a/src/backend/common/infrastructure/config/source/index.ts
+++ b/src/backend/common/infrastructure/config/source/index.ts
@@ -194,10 +194,11 @@ export type CommonSourceData = {};
 export const commonSourceConfigSchema = z.object({
     ...commonConfigSchema.shape,
     /**
-     * Unique identifier for this source.
+     * Vanity anme for this source.
      * */
     name: z.string().optional().meta({
-        description: "Unique identifier for this source."
+        description: "Vanity Name for this source.",
+        examples: ["Foxx's Cool Source"]
     }),
     /**
      * Restrict scrobbling tracks played from this source to Clients with names from this list. If list is empty is not present Source scrobbles to all configured Clients.
-- 
2.51.2