feat: Support for sample data

svrooij · Feb 13, 2024 · 4b6c121 · 4b6c121
1 parent 9a2956d
commit 4b6c121
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 11 deletions.
diff --git a/docs/documentation.json b/docs/documentation.json
@@ -20,6 +20,19 @@
             "Volume": "Volume between 0 and 100",
             "IncludeLinkedZones": "Should grouped players also play the alarm?",
             "AssignedID": "The ID of the new alarm"
+          },
+          "sample": {
+            "StartLocalTime": "07:00:00",
+            "Duration": "00:30:00",
+            "Recurrence": "DAILY",
+            "Enabled": "1",
+            "RoomUUID": "RINCON_000E58FE3AEA01400",
+            "ProgramURI": "x-rincon-buzzer:0",
+            "ProgramMetaData": "",
+            "PlayMode": "NORMAL",
+            "Volume": "20",
+            "IncludeLinkedZones": "1",
+            "AssignedID": "1"
           }
         },
         "DestroyAlarm": {

diff --git a/docs/schema/documentation.json b/docs/schema/documentation.json
@@ -51,6 +51,16 @@
           },
           "type": "object"
         },
+        "sample": {
+          "title": "Sample values",
+          "description": "Sample values for the parameters",
+          "additionalProperties": {
+            "title": "Value",
+            "description": "Working value, by it name as key",
+            "type": "string"
+          },
+          "type": "object"
+        },
         "remarks": {
           "title": "Action remarks",
           "description": "Remarks about this action",

diff --git a/docs/services/alarm-clock.md b/docs/services/alarm-clock.md
@@ -55,16 +55,16 @@ Action body:
 
 ```xml
 <u:CreateAlarm xmlns:u="urn:schemas-upnp-org:service:AlarmClock:1">
-  <StartLocalTime>string</StartLocalTime>
-  <Duration>string</Duration>
-  <Recurrence>string</Recurrence>
-  <Enabled>boolean</Enabled>
-  <RoomUUID>string</RoomUUID>
-  <ProgramURI>string</ProgramURI>
+  <StartLocalTime>07:00:00</StartLocalTime>
+  <Duration>00:30:00</Duration>
+  <Recurrence>DAILY</Recurrence>
+  <Enabled>1</Enabled>
+  <RoomUUID>RINCON_000E58FE3AEA01400</RoomUUID>
+  <ProgramURI>x-rincon-buzzer:0</ProgramURI>
   <ProgramMetaData>string</ProgramMetaData>
-  <PlayMode>string</PlayMode>
-  <Volume>ui2</Volume>
-  <IncludeLinkedZones>boolean</IncludeLinkedZones>
+  <PlayMode>NORMAL</PlayMode>
+  <Volume>20</Volume>
+  <IncludeLinkedZones>1</IncludeLinkedZones>
 </u:CreateAlarm>
 ```
 

diff --git a/generator/sonos-docs/src/commands/combine.ts b/generator/sonos-docs/src/commands/combine.ts
@@ -29,7 +29,7 @@ export default class Combine extends Command {
     }),
     docsFile: flags.string({
       exclusive: ['docsUrl'],
-      description: 'File location of documenation, instead of url.',
+      description: 'File location of documentation, instead of url.',
     }),
     models: flags.string({
       default: 'S1-2,S3-2,S6-2,S9-2,S13-2,S14-2,S18-2,S21-2,S27-2,S33-2,S38-2,Sub-2',
@@ -216,12 +216,15 @@ export default class Combine extends Command {
               a.description = action?.description
               a.remarks = action?.remarks
               const actionArguments = action?.params ?? {}
+              const sampleData = action?.sample ?? {}
               if (actionArguments) {
                 a.inputs?.forEach(i => {
                   i.description = actionArguments[i.name] ?? (i.name === 'InstanceID' ? 'InstanceID should always be `0`' : undefined)
+                  i.sample = sampleData[i.name]
                 })
                 a.outputs?.forEach(o => {
                   o.description = actionArguments[o.name]
+                  o.sample = sampleData[o.name]
                 })
               }
             }

diff --git a/generator/sonos-docs/src/models/sonos-service-action.ts b/generator/sonos-docs/src/models/sonos-service-action.ts
@@ -15,4 +15,5 @@ export interface SonosServiceActionArgument {
   relatedStateVariableName: string;
   relatedStateVariable?: SonosStateVariable; 
   description?: string;
+  sample?: unknown;
 }
diff --git a/generator/sonos-docs/src/models/sonos-service-documentation.ts b/generator/sonos-docs/src/models/sonos-service-documentation.ts
@@ -19,4 +19,5 @@ export interface SonosServiceDocumentationAction {
   description?: string;
   remarks?: string;
   params?: { [key: string]: string };
+  sample?: { [key: string]: string };
 }
diff --git a/generator/sonos-docs/templates/docs/service.hbs b/generator/sonos-docs/templates/docs/service.hbs
@@ -63,7 +63,7 @@ Action body:
 ```xml
 <u:{{name}} xmlns:u="{{../serviceType}}">
 {{#each inputs}}
-  <{{name}}>{{relatedStateVariable.dataType}}</{{name}}>
+  <{{name}}>{{#if sample}}{{sample}}{{else}}{{relatedStateVariable.dataType}}{{/if}}</{{name}}>
 {{/each}}
 </u:{{name}}>
 ```