schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
goss-json-schema.json | ca-file | CA root certs pem file, ex: /etc/ssl/cert.pem
| {"default": "", "type": "string"} |
goss-json-schema.json | username | username for basic auth | {"type": "string", "default": ""} |
goss-json-schema.json | password | password for basic auth | {"default": "", "type": "string"} |
goss-json-schema.json | title | title attribute is persisted when adding other resources with goss add | {"type": "string", "default": "UID must be between 50-100, GID doesn't matter. home is flexible"} |
goss-json-schema.json | mount | Validates mount point attributes. | {"type": "object", "additionalProperties": {}} |
goss-json-schema.json | service | Validates the state of a service. | {"additionalProperties": {}, "type": "object"} |
goss-json-schema.json | user | Validates the state of a user"
NOTE: This check is inspecting the contents of local passwd file /etc/passwd, this does not validate remote users (e.g. LDAP).
| {"additionalProperties": {}, "type": "object"} |
goss-json-schema.json | addr | Validates if a remote address:port are accessible. | {"type": "object", "examples": [{"tcp://ip-address-or-domain-name:80": {"reachable": "1", "timeout": "500", "local-address": "127.0.0.1"}}], "additionalProperties": {}} |
goss-json-schema.json | file | Validates the state of a file, directory, or symbolic link | {"type": "object", "additionalProperties": {}} |
goss-json-schema.json | group | Validates the state of a group | {"additionalProperties": {}, "type": "object"} |
goss-json-schema.json | gossfile | Import other gossfiles from this one. This is the best way to maintain a large number of tests, and/or create profiles. See render for more examples. Glob patterns can be also be used to specify matching gossfiles.
You can specify the gossfile(s) either as the resource key, or using the 'file' attribute.
If the 'skip' attribute is true, then the file is not processed. If the filename is a glob pattern, then none of the matching files are processed. Note that this is not the same as skipping the contained resources; any overrides in the referenced gossfile will not be processed, and the resource count will not be incremented. Skipping a gossfile include is the same as omitting the gossfile resource entirely.
| {"x-intellij-html-description": "Import other gossfiles from this one. This is the best way to maintain a large number of tests, and/or create profiles. See <a href=\"#render-r---render-gossfile-after-importing-all-referenced-gossfiles\">render</a> for more examples. Glob patterns can be also be used to specify matching gossfiles.</p>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">gossfile</span>:\n <span class=\"pl-ent\">myapplication</span>:\n <span class=\"pl-ent\">file</span>: <span class=\"pl-s\">myapp_gossfile.yaml</span>\n <span class=\"pl-ent\">skip</span>: <span class=\"pl-c1\">false</span>\n <span class=\"pl-s\">*.yaml:</span>\n <span class=\"pl-ent\">skip</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-ent\">goss_httpd.yaml</span>: <span class=\"pl-s\">{}</span>\n <span class=\"pl-ent\">/etc/goss.d/*.yaml</span>: <span class=\"pl-s\">{}</span></pre><div class=\"zeroclipboard-container position-absolute right-0 top-0\">\n <clipboard-copy aria-label=\"Copy\" class=\"ClipboardButton btn js-clipboard-copy m-2 p-0 tooltipped-no-delay\" data-copy-feedback=\"Copied!\" data-tooltip-direction=\"w\" value=\"gossfile:\n myapplication:\n file: myapp_gossfile.yaml\n skip: false\n *.yaml:\n skip: true\n goss_httpd.yaml: {}\n /etc/goss.d/*.yaml: {}\" tabindex=\"0\" role=\"button\" style=\"display: none;\">\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-copy js-clipboard-copy-icon m-2\">\n <path fill-rule=\"evenodd\" d=\"M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z\"></path><path fill-rule=\"evenodd\" d=\"M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z\"></path>\n</svg>\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-check js-clipboard-check-icon color-fg-success d-none m-2\">\n <path fill-rule=\"evenodd\" d=\"M13.78 4.22a.75.75 0 010 1.06l-7.25 7.25a.75.75 0 01-1.06 0L2.22 9.28a.75.75 0 011.06-1.06L6 10.94l6.72-6.72a.75.75 0 011.06 0z\"></path>\n</svg>\n </clipboard-copy>\n </div></div>\n<p dir=\"auto\">You can specify the gossfile(s) either as the resource key, or using the 'file' attribute.</p>\n<p dir=\"auto\">If the 'skip' attribute is true, then the file is not processed. If the filename is a glob pattern, then none of the matching files are processed. Note that this is not the same as skipping the contained resources; any overrides in the referenced gossfile will not be processed, and the resource count will not be incremented. Skipping a gossfile include is the same as omitting the gossfile resource entirely.</p>\n", "type": "object", "additionalProperties": {}} |
goss-json-schema.json | process | Validates if a process is running. | {"additionalProperties": {}, "type": "object"} |
goss-json-schema.json | http | description: Validates network interface values | {"additionalProperties": {}, "type": "object"} |
goss-json-schema.json | command | test executing a command | {"type": "object", "additionalProperties": {}} |
goss-json-schema.json | package | Validates the state of a package"
NOTE: this check uses the --package <format> parameter passed on the command line.
| {"type": "object", "additionalProperties": {}} |
goss-json-schema.json | kernel-param | test | {"type": "object", "additionalProperties": {}} |
goss-json-schema.json | interface | test | {"additionalProperties": {}, "type": "object"} |
goss-json-schema.json | matching | Validates specified content against a matcher. Best used with Templates. | {"type": "object", "x-intellij-html-description": "<p dir=\"auto\">Validates specified content against a matcher. Best used with <a href=\"#templates\">Templates</a>.</p>\n<h4 dir=\"auto\"><a id=\"user-content-with-templates\" class=\"anchor\" aria-hidden=\"true\" href=\"#with-templates\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>With <a href=\"#templates\">Templates</a>:</h4>\n<p dir=\"auto\">Let's say we have a <code>data.json</code> file that gets generated as part of some testing pipeline:</p>\n<div class=\"highlight highlight-source-json notranslate position-relative overflow-auto\" dir=\"auto\"><pre>{\n <span class=\"pl-ent\">\"instance_count\"</span>: <span class=\"pl-c1\">14</span>,\n <span class=\"pl-ent\">\"failures\"</span>: <span class=\"pl-c1\">3</span>,\n <span class=\"pl-ent\">\"status\"</span>: <span class=\"pl-s\"><span class=\"pl-pds\">\"</span>FAIL<span class=\"pl-pds\">\"</span></span>\n}</pre><div class=\"zeroclipboard-container position-absolute right-0 top-0\">\n <clipboard-copy aria-label=\"Copy\" class=\"ClipboardButton btn js-clipboard-copy m-2 p-0 tooltipped-no-delay\" data-copy-feedback=\"Copied!\" data-tooltip-direction=\"w\" value=\"{\n "instance_count": 14,\n "failures": 3,\n "status": "FAIL"\n}\" tabindex=\"0\" role=\"button\">\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-copy js-clipboard-copy-icon m-2\">\n <path fill-rule=\"evenodd\" d=\"M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z\"></path><path fill-rule=\"evenodd\" d=\"M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z\"></path>\n</svg>\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-check js-clipboard-check-icon color-fg-success d-none m-2\">\n <path fill-rule=\"evenodd\" d=\"M13.78 4.22a.75.75 0 010 1.06l-7.25 7.25a.75.75 0 01-1.06 0L2.22 9.28a.75.75 0 011.06-1.06L6 10.94l6.72-6.72a.75.75 0 011.06 0z\"></path>\n</svg>\n </clipboard-copy>\n </div></div>\n<p dir=\"auto\">This could then be passed into goss: <code>goss --vars data.json validate</code></p>\n<p dir=\"auto\">And then validated against:</p>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">matching</span>:\n <span class=\"pl-ent\">check_instance_count</span>: <span class=\"pl-c\"><span class=\"pl-c\">#</span> Make sure there is at least one instance</span>\n <span class=\"pl-ent\">content</span>: <span class=\"pl-s\">{{ .Vars.instance_count }}</span>\n <span class=\"pl-ent\">matches</span>:\n <span class=\"pl-ent\">gt</span>: <span class=\"pl-c1\">0</span>\n\n <span class=\"pl-ent\">check_failure_count_from_all_instance</span>: <span class=\"pl-c\"><span class=\"pl-c\">#</span> expect no failures</span>\n <span class=\"pl-ent\">content</span>: <span class=\"pl-s\">{{ .Vars.failures }}</span>\n <span class=\"pl-ent\">matches</span>: <span class=\"pl-c1\">0</span>\n\n <span class=\"pl-ent\">check_status</span>:\n <span class=\"pl-ent\">content</span>: <span class=\"pl-s\">{{ .Vars.status }}</span>\n <span class=\"pl-ent\">matches</span>:\n - <span class=\"pl-ent\">not</span>: <span class=\"pl-s\">FAIL</span></pre><div class=\"zeroclipboard-container position-absolute right-0 top-0\">\n <clipboard-copy aria-label=\"Copy\" class=\"ClipboardButton btn js-clipboard-copy m-2 p-0 tooltipped-no-delay\" data-copy-feedback=\"Copied!\" data-tooltip-direction=\"w\" value=\"matching:\n check_instance_count: # Make sure there is at least one instance\n content: {{ .Vars.instance_count }}\n matches:\n gt: 0\n\n check_failure_count_from_all_instance: # expect no failures\n content: {{ .Vars.failures }}\n matches: 0\n\n check_status:\n content: {{ .Vars.status }}\n matches:\n - not: FAIL\" tabindex=\"0\" role=\"button\" style=\"display: none;\">\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-copy js-clipboard-copy-icon m-2\">\n <path fill-rule=\"evenodd\" d=\"M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z\"></path><path fill-rule=\"evenodd\" d=\"M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z\"></path>\n</svg>\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-check js-clipboard-check-icon color-fg-success d-none m-2\">\n <path fill-rule=\"evenodd\" d=\"M13.78 4.22a.75.75 0 010 1.06l-7.25 7.25a.75.75 0 01-1.06 0L2.22 9.28a.75.75 0 011.06-1.06L6 10.94l6.72-6.72a.75.75 0 011.06 0z\"></path>\n</svg>\n </clipboard-copy>\n </div></div>\n<h4 dir=\"auto\"><a id=\"user-content-without-templates\" class=\"anchor\" aria-hidden=\"true\" href=\"#without-templates\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Without <a href=\"#templates\">Templates</a>:</h4>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">matching</span>:\n <span class=\"pl-ent\">has_substr</span>: <span class=\"pl-c\"><span class=\"pl-c\">#</span> friendly test name</span>\n <span class=\"pl-ent\">content</span>: <span class=\"pl-s\">some string</span>\n <span class=\"pl-ent\">matches</span>:\n <span class=\"pl-ent\">match-regexp</span>: <span class=\"pl-s\">some str</span>\n <span class=\"pl-ent\">has_2</span>:\n <span class=\"pl-ent\">content</span>:\n - <span class=\"pl-c1\">2</span>\n <span class=\"pl-ent\">matches</span>:\n <span class=\"pl-ent\">contain-element</span>: <span class=\"pl-c1\">2</span>\n <span class=\"pl-ent\">has_foo_bar_and_baz</span>:\n <span class=\"pl-ent\">content</span>:\n <span class=\"pl-ent\">foo</span>: <span class=\"pl-s\">bar</span>\n <span class=\"pl-ent\">baz</span>: <span class=\"pl-s\">bing</span>\n <span class=\"pl-ent\">matches</span>:\n <span class=\"pl-ent\">and</span>:\n - <span class=\"pl-ent\">have-key-with-value</span>:\n <span class=\"pl-ent\">foo</span>: <span class=\"pl-s\">bar</span>\n - <span class=\"pl-ent\">have-key</span>: <span class=\"pl-s\">baz</span></pre><div class=\"zeroclipboard-container position-absolute right-0 top-0\">\n <clipboard-copy aria-label=\"Copy\" class=\"ClipboardButton btn js-clipboard-copy m-2 p-0 tooltipped-no-delay\" data-copy-feedback=\"Copied!\" data-tooltip-direction=\"w\" value=\"matching:\n has_substr: # friendly test name\n content: some string\n matches:\n match-regexp: some str\n has_2:\n content:\n - 2\n matches:\n contain-element: 2\n has_foo_bar_and_baz:\n content:\n foo: bar\n baz: bing\n matches:\n and:\n - have-key-with-value:\n foo: bar\n - have-key: baz\" tabindex=\"0\" role=\"button\" style=\"display: none;\">\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-copy js-clipboard-copy-icon m-2\">\n <path fill-rule=\"evenodd\" d=\"M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z\"></path><path fill-rule=\"evenodd\" d=\"M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z\"></path>\n</svg>\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-check js-clipboard-check-icon color-fg-success d-none m-2\">\n <path fill-rule=\"evenodd\" d=\"M13.78 4.22a.75.75 0 010 1.06l-7.25 7.25a.75.75 0 01-1.06 0L2.22 9.28a.75.75 0 011.06-1.06L6 10.94l6.72-6.72a.75.75 0 011.06 0z\"></path>\n</svg>\n </clipboard-copy>\n </div></div>\n\nadditionalProperties:\n$ref: \"#/definitions/matchTest\"\n"} |
goss-json-schema.json | dns | Validates that the provided address is resolvable and the addrs it resolves to. | {"x-intellij-html-description": "<p dir=\"auto\">Validates that the provided address is resolvable and the addrs it resolves to.</p>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">dns</span>:\n <span class=\"pl-ent\">localhost</span>:\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> required attributes</span>\n <span class=\"pl-ent\">resolvable</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> optional attributes</span>\n <span class=\"pl-ent\">addrs</span>:\n - <span class=\"pl-s\">127.0.0.1</span>\n - <span class=\"pl-s\">::1</span>\n <span class=\"pl-ent\">server</span>: <span class=\"pl-s\">8.8.8.8 </span><span class=\"pl-c\"><span class=\"pl-c\">#</span> Also supports server:port</span>\n <span class=\"pl-ent\">timeout</span>: <span class=\"pl-c1\">500</span> <span class=\"pl-c\"><span class=\"pl-c\">#</span> in milliseconds (Only used when server attribute is provided)</span></pre><div class=\"zeroclipboard-container position-absolute right-0 top-0\">\n <clipboard-copy aria-label=\"Copy\" class=\"ClipboardButton btn js-clipboard-copy m-2 p-0 tooltipped-no-delay\" data-copy-feedback=\"Copied!\" data-tooltip-direction=\"w\" value=\"dns:\n localhost:\n # required attributes\n resolvable: true\n # optional attributes\n addrs:\n - 127.0.0.1\n - ::1\n server: 8.8.8.8 # Also supports server:port\n timeout: 500 # in milliseconds (Only used when server attribute is provided)\" tabindex=\"0\" role=\"button\" style=\"display: none;\">\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-copy js-clipboard-copy-icon m-2\">\n <path fill-rule=\"evenodd\" d=\"M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z\"></path><path fill-rule=\"evenodd\" d=\"M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z\"></path>\n</svg>\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-check js-clipboard-check-icon color-fg-success d-none m-2\">\n <path fill-rule=\"evenodd\" d=\"M13.78 4.22a.75.75 0 010 1.06l-7.25 7.25a.75.75 0 01-1.06 0L2.22 9.28a.75.75 0 011.06-1.06L6 10.94l6.72-6.72a.75.75 0 011.06 0z\"></path>\n</svg>\n </clipboard-copy>\n </div></div>\n<p dir=\"auto\">It is possible to validate the following types of DNS records, but requires the <code>server</code> attribute be set:</p>\n<ul dir=\"auto\">\n<li>A</li>\n<li>AAAA</li>\n<li>CAA</li>\n<li>CNAME</li>\n<li>MX</li>\n<li>NS</li>\n<li>PTR</li>\n<li>SRV</li>\n<li>TXT</li>\n</ul>\n<p dir=\"auto\">To validate specific DNS address types, prepend the hostname with the type and a colon, a few examples:</p>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">dns</span>:\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> Validate a CNAME record</span>\n <span class=\"pl-ent\">CNAME:c.dnstest.io</span>:\n <span class=\"pl-ent\">resolvable</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-ent\">server</span>: <span class=\"pl-s\">208.67.222.222</span>\n <span class=\"pl-ent\">addrs</span>:\n - <span class=\"pl-s\"><span class=\"pl-pds\">\"</span>a.dnstest.io.<span class=\"pl-pds\">\"</span></span>\n\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> Validate a PTR record</span>\n <span class=\"pl-ent\">PTR:8.8.8.8</span>:\n <span class=\"pl-ent\">resolvable</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-ent\">server</span>: <span class=\"pl-s\">8.8.8.8</span>\n <span class=\"pl-ent\">addrs</span>:\n - <span class=\"pl-s\"><span class=\"pl-pds\">\"</span>dns.google.<span class=\"pl-pds\">\"</span></span>\n\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> Validate and SRV record</span>\n <span class=\"pl-ent\">SRV:_https._tcp.dnstest.io</span>:\n <span class=\"pl-ent\">resolvable</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-ent\">server</span>: <span class=\"pl-s\">208.67.222.222</span>\n <span class=\"pl-ent\">addrs</span>:\n - <span class=\"pl-s\"><span class=\"pl-pds\">\"</span>0 5 443 a.dnstest.io.<span class=\"pl-pds\">\"</span></span>\n - <span class=\"pl-s\"><span class=\"pl-pds\">\"</span>10 10 443 b.dnstest.io.<span class=\"pl-pds\">\"</span></span></pre><div class=\"zeroclipboard-container position-absolute right-0 top-0\">\n <clipboard-copy aria-label=\"Copy\" class=\"ClipboardButton btn js-clipboard-copy m-2 p-0 tooltipped-no-delay\" data-copy-feedback=\"Copied!\" data-tooltip-direction=\"w\" value=\"dns:\n # Validate a CNAME record\n CNAME:c.dnstest.io:\n resolvable: true\n server: 208.67.222.222\n addrs:\n - "a.dnstest.io."\n\n # Validate a PTR record\n PTR:8.8.8.8:\n resolvable: true\n server: 8.8.8.8\n addrs:\n - "dns.google."\n\n # Validate and SRV record\n SRV:_https._tcp.dnstest.io:\n resolvable: true\n server: 208.67.222.222\n addrs:\n - "0 5 443 a.dnstest.io."\n - "10 10 443 b.dnstest.io."\" tabindex=\"0\" role=\"button\">\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-copy js-clipboard-copy-icon m-2\">\n <path fill-rule=\"evenodd\" d=\"M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z\"></path><path fill-rule=\"evenodd\" d=\"M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z\"></path>\n</svg>\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-check js-clipboard-check-icon color-fg-success d-none m-2\">\n <path fill-rule=\"evenodd\" d=\"M13.78 4.22a.75.75 0 010 1.06l-7.25 7.25a.75.75 0 01-1.06 0L2.22 9.28a.75.75 0 011.06-1.06L6 10.94l6.72-6.72a.75.75 0 011.06 0z\"></path>\n</svg>\n </clipboard-copy>\n </div></div>\n<p dir=\"auto\">Please note that if you want <code>localhost</code> to <strong>only</strong> resolve <code>127.0.0.1</code> you'll need to use <a href=\"#advanced-matchers\">Advanced Matchers</a></p>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">dns</span>:\n <span class=\"pl-ent\">localhost</span>:\n <span class=\"pl-ent\">resolvable</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-ent\">addrs</span>:\n <span class=\"pl-ent\">consist-of</span>: <span class=\"pl-s\">[127.0.0.1]</span>\n <span class=\"pl-ent\">timeout</span>: <span class=\"pl-c1\">500</span> <span class=\"pl-c\"><span class=\"pl-c\">#</span> in milliseconds</span>\n", "type": "object", "additionalProperties": {}} |
goss-json-schema.json | port | Validates the state of a local port.
Note: Goss might consider your port to be listening on tcp6 rather than tcp, try running goss add port .. to see how goss detects it. (explanation)
| {"x-intellij-html-description": "<p dir=\"auto\">Validates the state of a local port.</p>\n<p dir=\"auto\"><strong>Note:</strong> Goss might consider your port to be listening on <code>tcp6</code> rather than <code>tcp</code>, try running <code>goss add port ..</code> to see how goss detects it. (<a href=\"https://github.com/goss-org/goss/issues/149\" data-hovercard-type=\"issue\" data-hovercard-url=\"/goss-org/goss/issues/149/hovercard\">explanation</a>)</p>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">port</span>:\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> {tcp,tcp6,udp,udp6}:port_num</span>\n <span class=\"pl-ent\">tcp:22</span>:\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> required attributes</span>\n <span class=\"pl-ent\">listening</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> optional attributes</span>\n <span class=\"pl-ent\">ip</span>: <span class=\"pl-c\"><span class=\"pl-c\">#</span> what IP(s) is it listening on</span>\n - <span class=\"pl-s\">0.0.0.0</span>\n <span class=\"pl-ent\">skip</span>: <span class=\"pl-c1\">false</span>\n", "type": "object", "additionalProperties": {}} |
sarif-external-property-file-2.1.0.json | $schema | The URI of the JSON schema corresponding to the version of the external property file format. | {"type": "string", "format": "uri"} |
sarif-external-property-file-2.1.0.json | version | The SARIF format version of this external properties object. | {"enum": ["2.1.0"]} |
sarif-external-property-file-2.1.0.json | guid | A stable, unique identifer for this external properties object, in the form of a GUID. | {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"} |
sarif-external-property-file-2.1.0.json | runGuid | A stable, unique identifer for the run associated with this external properties object, in the form of a GUID. | {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"} |
sarif-external-property-file-2.1.0.json | conversion | A conversion object that will be merged with an external run. | {} |
sarif-external-property-file-2.1.0.json | graphs | An array of graph objects that will be merged with an external run. | {"type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": {}} |
sarif-external-property-file-2.1.0.json | externalizedProperties | Key/value pairs that provide additional information that will be merged with an external run. | {} |
sarif-external-property-file-2.1.0.json | artifacts | An array of artifact objects that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "items": {}} |
sarif-external-property-file-2.1.0.json | invocations | Describes the invocation of the analysis tool that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}} |
sarif-external-property-file-2.1.0.json | logicalLocations | An array of logical locations such as namespaces, types or functions that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0.json | threadFlowLocations | An array of threadFlowLocation objects that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0.json | results | An array of result objects that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}} |
sarif-external-property-file-2.1.0.json | taxonomies | Tool taxonomies that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0.json | driver | The analysis tool object that will be merged with an external run. | {} |
sarif-external-property-file-2.1.0.json | extensions | Tool extensions that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0.json | policies | Tool policies that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0.json | translations | Tool translations that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0.json | addresses | Addresses that will be merged with with an external run. | {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}} |
sarif-external-property-file-2.1.0.json | webRequests | Requests that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0.json | webResponses | Responses that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0.json | properties | Key/value pairs that provide additional information about the external properties. | {} |
putout.json | rule | 🐊Putout rule
"off" means rule is off
"on" means it is a on
| {"enum": ["on", "off"]} |
putout.json | rules | 🐊Putout comes with a large number of rules. You can modify which rules your project uses. | {"type": "object", "properties": {"add-return-await": {}, "apply-at": {}, "apply-await-import": {}, "apply-destructuring": {}, "apply-early-return": {}, "apply-montag": {}, "apply-nullish-coalescing": {}, "apply-numeric-separators": {}, "apply-optional-chaining": {}, "apply-shorthand-properties": {}, "apply-try-catch": {}, "apply-utility-types": {}, "browserlist": {}, "cloudcmd": {}, "conditions": {}, "conditions/apply-comparison-order": {}, "conditions/apply-if": {}, "conditions/convert-comparison-to-boolean": {}, "conditions/convert-equal-to-strict-equal": {}, "conditions/evaluate": {}, "conditions/simplify": {}, "conditions/remove-constant": {}, "conditions/remove-boolean": {}, "convert-apply-to-spread": {}, "convert-arguments-to-rest": {}, "convert-array-copy-to-slice": {}, "convert-assignment-to-arrow-function": {}, "convert-assignment-to-comparison": {}, "convert-bitwise-to-logical": {}, "convert-commonjs-to-esm": {}, "convert-concat-to-flat": {}, "convert-esm-to-commonjs": {}, "convert-index-of-to-includes": {}, "convert-is-nan-to-number-is-nan": {}, "convert-math-pow": {}, "convert-mock-require-to-mock-import": {}, "convert-object-assign-to-merge-spread": {}, "convert-quotes-to-backticks": {}, "convert-spread-to-array-from": {}, "convert-template-to-string": {}, "convert-throw": {}, "convert-to-arrow-function": {}, "declare": {}, "eslint": {}, "extract-object-properties": {}, "extract-sequence-expressions": {}, "for-of/for": {}, "for-of/for-each": {}, "for-of/for-in": {}, "for-of/map": {}, "for-of/remove-useless": {}, "for-of/remove-unused-variables": {}, "for-of/remove-useless-array-from": {}, "github": {}, "gitignore": {}, "jest": {}, "madrun": {}, "maybe": {}, "merge-destructuring-properties": {}, "merge-duplicate-imports": {}, "merge-if-statements": {}, "nodejs": {}, "nodejs/convert-dirname-to-url": {}, "nodejs/convert-fs-promises": {}, "nodejs/convert-promisify-to-fs-promises": {}, "nodejs/convert-top-level-return": {}, "nodejs/remove-process-exit": {}, "npmignore": {}, "package-json": {}, "postcss": {}, "promises": {}, "promises/add-missing-await": {}, "promises/apply-top-level-await": {}, "promises/convert-new-promise-to-async": {}, "promises/convert-reject-to-throw": {}, "promises/remove-useless-async": {}, "promises/remove-useless-await": {}, "promises/remove-useless-resolve": {}, "putout": {}, "putout-config": {}, "react-hooks": {}, "regexp": {}, "remove-boolean-from-assertions": {}, "remove-boolean-from-logical-expressions": {}, "remove-console": {}, "remove-debugger": {}, "remove-duplicate-case": {}, "remove-duplicate-interface-keys": {}, "remove-duplicate-keys": {}, "remove-duplicates-from-logical-expressions": {}, "remove-duplicates-from-union": {}, "remove-empty": {}, "remove-empty/argument": {}, "remove-empty/block": {}, "remove-empty/export": {}, "remove-empty/import": {}, "remove-empty/pattern": {}, "remove-iife": {}, "remove-nested-blocks": {}, "remove-unreachable-code": {}, "remove-unreferenced-variables": {}, "remove-unused-expressions": {}, "remove-unused-private-fields": {}, "remove-unused-types": {}, "remove-unused-variables": {}, "remove-useless-arguments": {}, "remove-useless-array-constructor": {}, "remove-useless-array-entries": {}, "remove-useless-constructor": {}, "remove-useless-continue": {}, "remove-useless-escape": {}, "remove-useless-functions": {}, "remove-useless-map": {}, "remove-useless-new": {}, "remove-useless-operand": {}, "remove-useless-return": {}, "remove-useless-spread": {}, "remove-useless-template-expressions": {}, "remove-useless-templates": {}, "remove-useless-type-conversion": {}, "remove-useless-types-from-constants": {}, "remove-useless-variables": {}, "reuse-duplicate-init": {}, "simplify-assignment": {}, "simplify-logical-expressions": {}, "simplify-ternary": {}, "split-nested-destructuring": {}, "split-variable-declarations": {}, "strict-mode": {}, "tape": {}, "tape/remove-only": {}, "tape/remove-skip": {}, "travis": {}, "types": {}, "types/convert-typeof-to-is-type": {}, "types/remove-useless-conversion": {}, "types/remove-double-negations": {}, "types/remove-useless-typeof": {}, "types/apply-is-array": {}, "typescript": {}, "typescript/apply-as-type-assertion": {}, "typescript/apply-utility-types": {}, "typescript/convert-generic-to-shorthand": {}, "typescript/remove-duplicate-interface-keys": {}, "typescript/remove-duplicates-from-union": {}, "typescript/remove-unused-types": {}, "typescript/remove-useless-mapped-types": {}, "typescript/remove-useless-mapping-modifiers": {}, "typescript/remove-useless-types": {}, "typescript/remove-useless-types-from-constants": {}, "webpack": {}}} |
putout.json | printer | Tell 🐊Putout which printer to use | {"oneOf": [{"type": "string"}, {"type": "array", "minItems": 2, "maxItems": 2, "items": [{"type": "string"}, {"type": "object"}]}]} |
putout.json | parser | Tell 🐊Putout which parser to use | {"type": "string"} |
putout.json | formatter | Choose the way to show information about errors found | {"type": ["string", "array"]} |
putout.json | processors | Tell 🐊Putout which processors to use to support file types other then JavaScript | {"type": "array", "uniqueItems": true, "items": {"type": "string"}} |
putout.json | ignore | Tell 🐊Putout to ignore specific files and directories. | {"type": "array", "uniqueItems": true, "items": {"type": "string"}} |
putout.json | match | Allows to match rules for files and folders, specified by glob patterns. | {"type": "object", "patternProperties": {"^.*$": {}, "additionalProperties": false}} |
putout.json | plugins | Tell 🐊Putout which plugins to load | {"type": "array", "uniqueItems": true} |
sarif-2.0.0.json | Static Analysis Results Format (SARIF) Version 2.0.0 JSON Schema: a standard format for the output of static analysis tools. | {"$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": {"attachment": {"type": "object", "additionalProperties": false, "properties": {"fileLocation": {}, "regions": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "rectangles": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}}, "required": ["fileLocation"]}, "codeFlow": {"additionalProperties": false, "type": "object", "properties": {"message": {}, "threadFlows": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["threadFlows"]}, "conversion": {"additionalProperties": false, "type": "object", "properties": {"tool": {}, "invocation": {}, "analysisToolLogFiles": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}}, "required": ["tool"]}, "edge": {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "label": {}, "sourceNodeId": {"type": "string"}, "targetNodeId": {"type": "string"}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["id", "sourceNodeId", "targetNodeId"]}, "edgeTraversal": {"type": "object", "additionalProperties": false, "properties": {"edgeId": {"type": "string"}, "message": {}, "finalState": {"type": "object", "additionalProperties": {"type": "string"}}, "stepOverEdgeCount": {"type": "integer"}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["edgeId"]}, "exception": {"type": "object", "properties": {"kind": {"type": "string"}, "message": {"type": "string"}, "stack": {}, "innerExceptions": {"type": "array", "items": {}}}}, "externalFiles": {"additionalProperties": false, "type": "object", "properties": {"conversion": {}, "files": {}, "graphs": {}, "invocations": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "logicalLocations": {}, "resources": {}, "results": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}}}, "file": {"additionalProperties": false, "type": "object", "properties": {"fileLocation": {}, "parentKey": {"type": "string"}, "offset": {"type": "integer"}, "length": {"type": "integer"}, "roles": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {"enum": ["analysisTarget", "attachment", "responseFile", "resultFile", "standardStream", "traceFile", "unmodifiedFile", "modifiedFile", "addedFile", "deletedFile", "renamedFile", "uncontrolledFile"]}}, "mimeType": {"type": "string", "pattern": "[^/]+/.+"}, "contents": {}, "encoding": {"type": "string"}, "hashes": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "lastModifiedTime": {"type": "string", "format": "date-time"}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}}, "fileChange": {"additionalProperties": false, "type": "object", "properties": {"fileLocation": {}, "replacements": {"type": "array", "minItems": 1, "items": {}}}, "required": ["fileLocation", "replacements"]}, "fileContent": {"type": "object", "additionalProperties": false, "properties": {"text": {"type": "string"}, "binary": {"type": "string"}}}, "fileLocation": {"additionalProperties": false, "type": "object", "properties": {"uri": {"type": "string", "format": "uri-reference"}, "uriBaseId": {"type": "string"}}, "required": ["uri"]}, "fix": {"additionalProperties": false, "type": "object", "properties": {"fileChanges": {"type": "array", "items": {}}}, "required": ["fileChanges"]}, "graph": {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "nodes": {"type": "array", "items": {}}, "edges": {"type": "array", "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["id", "nodes", "edges"]}, "graphTraversal": {"type": "object", "additionalProperties": false, "properties": {"graphId": {"type": "string"}, "initialState": {"type": "object", "additionalProperties": {"type": "string"}}, "edgeTraversals": {"type": "array", "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["graphId", "edgeTraversals"]}, "hash": {"additionalProperties": false, "type": "object", "properties": {"value": {"type": "string"}, "algorithm": {"type": "string"}}, "required": ["value", "algorithm"]}, "invocation": {"additionalProperties": false, "type": "object", "properties": {"commandLine": {"type": "string"}, "arguments": {"type": "array", "items": {"type": "string"}}, "responseFiles": {"type": "array", "items": {}}, "attachments": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "startTime": {"type": "string", "format": "date-time"}, "endTime": {"type": "string", "format": "date-time"}, "exitCode": {"type": "integer"}, "toolNotifications": {"type": "array", "items": {}}, "configurationNotifications": {"type": "array", "items": {}}, "exitCodeDescription": {"type": "string"}, "exitSignalName": {"type": "string"}, "exitSignalNumber": {"type": "integer"}, "processStartFailureMessage": {"type": "string"}, "toolExecutionSuccessful": {"type": "boolean"}, "machine": {"type": "string"}, "account": {"type": "string"}, "processId": {"type": "integer"}, "executableLocation": {}, "workingDirectory": {}, "environmentVariables": {"type": "object", "additionalProperties": true, "default": {}}, "stdin": {}, "stdout": {}, "stderr": {}, "stdoutStderr": {}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}}, "location": {"additionalProperties": false, "type": "object", "properties": {"physicalLocation": {}, "fullyQualifiedLogicalName": {"type": "string"}, "message": {}, "annotations": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}}, "logicalLocation": {"additionalProperties": false, "type": "object", "properties": {"name": {"type": "string"}, "fullyQualifiedName": {"type": "string"}, "decoratedName": {"type": "string"}, "parentKey": {"type": "string"}, "kind": {"type": "string"}}}, "message": {"type": "object", "additionalProperties": false, "properties": {"text": {"type": "string"}, "messageId": {"type": "string"}, "richText": {"type": "string"}, "richMessageId": {"type": "string"}, "arguments": {"type": "array", "items": {"type": "string"}}}}, "node": {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "label": {}, "location": {}, "children": {"type": "array", "uniqueItems": true, "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["id"]}, "notification": {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "ruleId": {"type": "string"}, "physicalLocation": {}, "message": {}, "level": {"default": "warning", "enum": ["note", "warning", "error"]}, "threadId": {"type": "integer"}, "time": {"type": "string", "format": "date-time"}, "exception": {}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["message"]}, "physicalLocation": {"additionalProperties": false, "type": "object", "properties": {"id": {"type": "integer"}, "fileLocation": {}, "region": {}, "contextRegion": {}}, "required": ["fileLocation"]}, "rectangle": {"additionalProperties": false, "type": "object", "properties": {"top": {"type": "number"}, "left": {"type": "number"}, "bottom": {"type": "number"}, "right": {"type": "number"}, "message": {}}}, "region": {"additionalProperties": false, "type": "object", "properties": {"startLine": {"type": "integer", "minimum": 1}, "startColumn": {"type": "integer", "minimum": 1}, "endLine": {"type": "integer", "minimum": 1}, "endColumn": {"type": "integer", "minimum": 1}, "charOffset": {"type": "integer", "minimum": 0}, "charLength": {"type": "integer", "minimum": 0}, "byteOffset": {"type": "integer", "minimum": 0}, "byteLength": {"type": "integer", "minimum": 0}, "snippet": {}, "message": {}}}, "replacement": {"additionalProperties": false, "type": "object", "properties": {"deletedRegion": {}, "insertedContent": {}}, "required": ["deletedRegion"]}, "resources": {"type": "object", "properties": {"messageStrings": {"type": "object", "additionalProperties": {"type": "string"}}, "rules": {"type": "object", "additionalProperties": {}}}}, "result": {"additionalProperties": false, "type": "object", "properties": {"ruleId": {"type": "string"}, "level": {"enum": ["notApplicable", "pass", "note", "warning", "error", "open"]}, "message": {}, "analysisTarget": {}, "locations": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "instanceGuid": {"type": "string"}, "correlationGuid": {"type": "string"}, "partialFingerprints": {"type": "object", "additionalProperties": {"type": "string"}}, "fingerprints": {"type": "object", "additionalProperties": {"type": "string"}}, "stacks": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "codeFlows": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "graphs": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "graphTraversals": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "relatedLocations": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "suppressionStates": {"type": "array", "items": {"enum": ["suppressedInSource", "suppressedExternally"]}}, "baselineState": {"enum": ["new", "existing", "absent"]}, "attachments": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "workItemUris": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {"type": "string", "format": "uri"}}, "conversionProvenance": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "fixes": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}}, "rule": {"additionalProperties": false, "type": "object", "properties": {"id": {"type": "string"}, "name": {}, "shortDescription": {}, "fullDescription": {}, "messageStrings": {"type": "object", "additionalProperties": {"type": "string"}}, "richMessageStrings": {"type": "object", "additionalProperties": {"type": "string"}}, "configuration": {}, "helpUri": {"type": "string", "format": "uri"}, "help": {}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["id"]}, "ruleConfiguration": {"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean"}, "defaultLevel": {"default": "warning", "enum": ["note", "warning", "error", "open"]}, "parameters": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}}, "run": {"additionalProperties": false, "type": "object", "properties": {"tool": {}, "invocations": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "conversion": {}, "versionControlProvenance": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "originalUriBaseIds": {"type": "object", "additionalProperties": {"type": "string", "format": "uri"}}, "files": {"type": "object", "additionalProperties": {}}, "logicalLocations": {"type": "object", "additionalProperties": {}}, "graphs": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "results": {"type": "array", "minItems": 0, "items": {}}, "resources": {}, "instanceGuid": {"type": "string"}, "correlationGuid": {"type": "string"}, "logicalId": {"type": "string"}, "automationLogicalId": {"type": "string"}, "baselineInstanceGuid": {"type": "string"}, "architecture": {"type": "string"}, "richMessageMimeType": {"type": "string", "default": "text/markdown;variant=GFM"}, "redactionToken": {"type": "string"}, "defaultFileEncoding": {"type": "string"}, "columnKind": {"enum": ["utf16CodeUnits", "unicodeCodePoints"]}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["tool"]}, "stack": {"additionalProperties": false, "type": "object", "properties": {"message": {}, "frames": {"type": "array", "minItems": 1, "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["frames"]}, "stackFrame": {"additionalProperties": false, "type": "object", "properties": {"location": {}, "module": {"type": "string"}, "threadId": {"type": "integer"}, "address": {"type": "integer"}, "offset": {"type": "integer"}, "parameters": {"type": "array", "items": {"type": "string", "default": []}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}}, "threadFlow": {"type": "object", "properties": {"id": {"type": "string"}, "message": {}, "locations": {"type": "array", "minItems": 1, "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["locations"]}, "threadFlowLocation": {"additionalProperties": false, "type": "object", "properties": {"step": {"type": "integer", "minimum": 0}, "location": {}, "stack": {}, "kind": {"type": "string"}, "module": {"type": "string"}, "state": {"type": "object"}, "nestingLevel": {"type": "integer"}, "executionOrder": {"type": "integer"}, "timestamp": {"type": "string", "format": "date-time"}, "importance": {"enum": ["important", "essential", "unimportant"]}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}}, "tool": {"additionalProperties": false, "type": "object", "properties": {"name": {"type": "string"}, "fullName": {"type": "string"}, "version": {"type": "string"}, "semanticVersion": {"type": "string"}, "fileVersion": {"type": "string", "pattern": "[0-9]+(\\.[0-9]+){3}"}, "downloadUri": {"type": "string", "format": "uri"}, "sarifLoggerVersion": {"type": "string"}, "language": {"type": "string", "default": "en-US"}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["name"]}, "versionControlDetails": {"type": "object", "additionalProperties": false, "properties": {"uri": {"type": "string", "format": "uri"}, "revisionId": {"type": "string"}, "branch": {"type": "string"}, "tag": {"type": "string"}, "timestamp": {"type": "string", "format": "date-time"}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["uri"]}}, "id": "https://json.schemastore.org/sarif-2.0.0.json", "properties": {"$schema": {"type": "string", "format": "uri"}, "version": {"enum": ["2.0.0"]}, "runs": {"type": "array", "minItems": 1, "items": {}}}, "required": ["version", "runs"], "type": "object"} |
|
sarif-2.0.0.json | attachment | A file relevant to a tool invocation or to a result. | {"type": "object", "additionalProperties": false, "properties": {"fileLocation": {}, "regions": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "rectangles": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}}, "required": ["fileLocation"]} |
sarif-2.0.0.json | description | A message describing the role played by the attachment. | {} |
sarif-2.0.0.json | fileLocation | The location of the attachment. | {} |
sarif-2.0.0.json | regions | An array of regions of interest within the attachment. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}} |
sarif-2.0.0.json | rectangles | An array of rectangles specifying areas of interest within the image. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}} |
sarif-2.0.0.json | codeFlow | A set of threadFlows which together describe a pattern of code execution relevant to detecting a result. | {"additionalProperties": false, "type": "object", "properties": {"message": {}, "threadFlows": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["threadFlows"]} |
sarif-2.0.0.json | message | A message relevant to the code flow. | {} |
sarif-2.0.0.json | threadFlows | An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}} |
sarif-2.0.0.json | properties | Key/value pairs that provide additional information about the code flow. | {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}} |
sarif-2.0.0.json | tags | A set of distinct strings that provide additional information. | {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}} |
sarif-2.0.0.json | conversion | Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format. | {"additionalProperties": false, "type": "object", "properties": {"tool": {}, "invocation": {}, "analysisToolLogFiles": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}}, "required": ["tool"]} |
sarif-2.0.0.json | tool | A tool object that describes the converter. | {} |
sarif-2.0.0.json | invocation | An invocation object that describes the invocation of the converter. | {} |
sarif-2.0.0.json | analysisToolLogFiles | The locations of the analysis tool's per-run log files. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}} |
sarif-2.0.0.json | edge | Represents a directed edge in a graph. | {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "label": {}, "sourceNodeId": {"type": "string"}, "targetNodeId": {"type": "string"}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["id", "sourceNodeId", "targetNodeId"]} |
sarif-2.0.0.json | id | A string that uniquely identifies the edge within its graph. | {"type": "string"} |
sarif-2.0.0.json | label | A short description of the edge. | {} |
sarif-2.0.0.json | sourceNodeId | Identifies the source node (the node at which the edge starts). | {"type": "string"} |
sarif-2.0.0.json | targetNodeId | Identifies the target node (the node at which the edge ends). | {"type": "string"} |
sarif-2.0.0.json | properties | Key/value pairs that provide additional information about the edge. | {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}} |
sarif-2.0.0.json | tags | A set of distinct strings that provide additional information. | {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}} |
sarif-2.0.0.json | edgeTraversal | Represents the traversal of a single edge during a graph traversal. | {"type": "object", "additionalProperties": false, "properties": {"edgeId": {"type": "string"}, "message": {}, "finalState": {"type": "object", "additionalProperties": {"type": "string"}}, "stepOverEdgeCount": {"type": "integer"}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["edgeId"]} |
sarif-2.0.0.json | edgeId | Identifies the edge being traversed. | {"type": "string"} |
sarif-2.0.0.json | message | A message to display to the user as the edge is traversed. | {} |
sarif-2.0.0.json | finalState | The values of relevant expressions after the edge has been traversed. | {"type": "object", "additionalProperties": {"type": "string"}} |
sarif-2.0.0.json | stepOverEdgeCount | The number of edge traversals necessary to return from a nested graph. | {"type": "integer"} |
sarif-2.0.0.json | properties | Key/value pairs that provide additional information about the edge traversal. | {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}} |
sarif-2.0.0.json | tags | A set of distinct strings that provide additional information. | {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}} |
sarif-2.0.0.json | kind | A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal. | {"type": "string"} |
sarif-2.0.0.json | message | A plain text message that describes the exception. | {"type": "string"} |
sarif-2.0.0.json | stack | The sequence of function calls leading to the exception. | {} |
sarif-2.0.0.json | innerExceptions | An array of exception objects each of which is considered a cause of this exception. | {"type": "array", "items": {}} |
sarif-2.0.0.json | externalFiles | References to external files that should be inlined with the content of a root log file. | {"additionalProperties": false, "type": "object", "properties": {"conversion": {}, "files": {}, "graphs": {}, "invocations": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "logicalLocations": {}, "resources": {}, "results": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}}} |
sarif-2.0.0.json | conversion | The location of a file containing a run.conversion object to be merged with the root log file. | {} |
sarif-2.0.0.json | files | The location of a file containing a run.files object to be merged with the root log file. | {} |
sarif-2.0.0.json | graphs | The location of a file containing a run.graphs object to be merged with the root log file. | {} |
sarif-2.0.0.json | invocations | An array of locations of files containing arrays of run.invocation objects to be merged with the root log file. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}} |
sarif-2.0.0.json | logicalLocations | The location of a file containing a run.logicalLocations object to be merged with the root log file. | {} |
sarif-2.0.0.json | resources | The location of a file containing a run.resources object to be merged with the root log file. | {} |
sarif-2.0.0.json | results | An array of locations of files containing arrays of run.result objects to be merged with the root log file. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}} |
sarif-2.0.0.json | file | A single file. In some cases, this file might be nested within another file. | {"additionalProperties": false, "type": "object", "properties": {"fileLocation": {}, "parentKey": {"type": "string"}, "offset": {"type": "integer"}, "length": {"type": "integer"}, "roles": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {"enum": ["analysisTarget", "attachment", "responseFile", "resultFile", "standardStream", "traceFile", "unmodifiedFile", "modifiedFile", "addedFile", "deletedFile", "renamedFile", "uncontrolledFile"]}}, "mimeType": {"type": "string", "pattern": "[^/]+/.+"}, "contents": {}, "encoding": {"type": "string"}, "hashes": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "lastModifiedTime": {"type": "string", "format": "date-time"}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}} |
sarif-2.0.0.json | fileLocation | The location of the file. | {} |
sarif-2.0.0.json | parentKey | Identifies the key of the immediate parent of the file, if this file is nested. | {"type": "string"} |
sarif-2.0.0.json | offset | The offset in bytes of the file within its containing file. | {"type": "integer"} |
sarif-2.0.0.json | length | The length of the file in bytes. | {"type": "integer"} |
sarif-2.0.0.json | roles | The role or roles played by the file in the analysis. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {"enum": ["analysisTarget", "attachment", "responseFile", "resultFile", "standardStream", "traceFile", "unmodifiedFile", "modifiedFile", "addedFile", "deletedFile", "renamedFile", "uncontrolledFile"]}} |
sarif-2.0.0.json | mimeType | The MIME type (RFC 2045) of the file. | {"type": "string", "pattern": "[^/]+/.+"} |
sarif-2.0.0.json | contents | The contents of the file. | {} |
sarif-2.0.0.json | encoding | Specifies the encoding for a file object that refers to a text file. | {"type": "string"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.