From 6a767b4ea75b1e62bb72b41a9d73d338ff638512 Mon Sep 17 00:00:00 2001 From: Buddhika Chathuranga Date: Tue, 25 Aug 2020 18:42:33 +0530 Subject: [PATCH] Update YAML schema validaion documentation --- doc/yamlConfigFile.md | 6 +++--- doc/yamlConfigurationSchema.json | 5 +++-- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/yamlConfigFile.md b/doc/yamlConfigFile.md index 78f4800..ad0a717 100644 --- a/doc/yamlConfigFile.md +++ b/doc/yamlConfigFile.md @@ -31,9 +31,9 @@ log: ## YAML configuration schema validation Users can validate YAML configurations file against JSON schema. -First you should convert YAML file into JSON and then you can -validate the JSON file against JSON schema. -[Find the JSON schema in this link.](yamlConfigurationSchema.json) +You can use YAML utility tool for VSCode to validate your +YAML configurations file with this JSON schema. +[Download YAML utility tool for VSCode from Visual Studio Marketplace.](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) ## Environment variable expansion diff --git a/doc/yamlConfigurationSchema.json b/doc/yamlConfigurationSchema.json index ce6c760..d549a91 100644 --- a/doc/yamlConfigurationSchema.json +++ b/doc/yamlConfigurationSchema.json @@ -2,7 +2,7 @@ "$schema": "http://json-schema.org/draft-07/schema", "type": "object", "title": "Windows Service Wrapper. YAML configuration schema", - "description": "This JSON schema validate the YAML configuaration file.", + "description": "This JSON schema validate the YAML configuaration file. You can find more details about YAML configurations from https://github.com/winsw/winsw/blob/master/doc/yamlConfigFile.md", "required": [ "id", "name", @@ -151,8 +151,8 @@ } }, "arguments": { - "description": "Specifies the arguments to be passed to the executable. User can specify all the commands as a single line.", "$id": "#/properties/arguments", + "description": "Specifies the arguments to be passed to the executable. User can specify all the commands as a single line.", "type": "string" }, "startArguments": { @@ -177,6 +177,7 @@ }, "resetFailureAfter": { "$id": "#/properties/resetFailureAfter", + "description": "This optional element controls the timing in which Windows SCM resets the failure count.", "type": "string" }, "stopTimeout": {