From 4c91a1fbdb2aef2570e5a8928ba0a735929d740e Mon Sep 17 00:00:00 2001 From: nmaguiar Date: Sun, 31 Dec 2023 01:18:39 +0000 Subject: [PATCH] Update YAML files with string values in examples --- formats/fromRes.yaml | 2 +- oaf/parseCron.yaml | 18 +++++++++--------- unix/hvscs.yaml | 6 +++--- unix/parseCPUStats.yaml | 4 ++-- unix/parseIOStats.yaml | 4 ++-- 5 files changed, 17 insertions(+), 17 deletions(-) diff --git a/formats/fromRes.yaml b/formats/fromRes.yaml index 7b3f533..82fce74 100644 --- a/formats/fromRes.yaml +++ b/formats/fromRes.yaml @@ -12,7 +12,7 @@ help: mandatory: false - name : wait desc : If browser=true the time, in ms, to wait for the browser to open - example : 5000 + example : "5000" mandatory: false todo: diff --git a/oaf/parseCron.yaml b/oaf/parseCron.yaml index 630ab80..8ab20b0 100644 --- a/oaf/parseCron.yaml +++ b/oaf/parseCron.yaml @@ -2,17 +2,17 @@ help: text : Test the provided cron expression a provides a list of dates of occurrence. expects: - - name : cron - desc : The cron expression to evaluate - example: "*/5 * * * *" + - name : cron + desc : The cron expression to evaluate + example : "*/5 * * * *" mandatory: false - - name : next - desc : How many occurrences in the future to provide (default to 5) - example: 5 + - name : next + desc : How many occurrences in the future to provide (default to 5) + example : "5" mandatory: false - - name : prev - desc : How many occurrences in the past to provide (default to 0) - example: 0 + - name : prev + desc : How many occurrences in the past to provide (default to 0) + example : "0" mandatory: false todo: diff --git a/unix/hvscs.yaml b/unix/hvscs.yaml index 2df7cde..04f7dd8 100644 --- a/unix/hvscs.yaml +++ b/unix/hvscs.yaml @@ -9,14 +9,14 @@ help: - name : name desc : When creating or deleting the hVSCs name example : test - mandatory: false + mandatory: false - name : image desc : The hVSCs image to use (defaults to nmaguiar/hvscs) - example : false + example : "false" mandatory: false - name : mac desc : If mac=true the host is a Mac OS server - example : true + example : "true" mandatory: false - name : volume desc : If defined a container volume to mount as /workspace on op=create diff --git a/unix/parseCPUStats.yaml b/unix/parseCPUStats.yaml index 8a18612..c890748 100644 --- a/unix/parseCPUStats.yaml +++ b/unix/parseCPUStats.yaml @@ -6,9 +6,9 @@ help: desc : Command to obtain the result of /proc/stat (defaults to "cat /proc/stat") example : cat /proc/stat mandatory: false - - name : interval + - name : interval desc : Interval of sampling of /proc/stat in ms - example : 1000 + example : "1000" mandatory: false - name : dontShowFirst desc : Boolean to indicate that the first line should not be shown until a previous sample if collected to properly calculate the difference diff --git a/unix/parseIOStats.yaml b/unix/parseIOStats.yaml index 2d08ed0..343780b 100644 --- a/unix/parseIOStats.yaml +++ b/unix/parseIOStats.yaml @@ -6,9 +6,9 @@ help: desc : Command to obtain the result of /proc/stat (defaults to "cat /proc/diskstats") example : cat /proc/diskstats mandatory: false - - name : interval + - name : interval desc : Interval of sampling of /proc/diskstats in ms - example : 1000 + example : "1000" mandatory: false - name : dontShowFirst desc : Boolean to indicate that the first line should not be shown until a previous sample if collected to properly calculate the difference