Update YAML schema validaion documentation

pull/656/head
Buddhika Chathuranga 2020-08-25 18:42:33 +05:30
parent 0450cb177d
commit 6a767b4ea7
2 changed files with 6 additions and 5 deletions

View File

@ -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

View File

@ -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": {