Schema for standard CI code checks output

code-check-general.schema.json

{
	"$schema": "http://json-schema.org/draft-07/schema#",
	"type": "object",
	"properties": {
		"name": {
			"type": "string",
			"description": "Name of code check"
		},
		"description": {
			"type": "string",
			"description": "Description of code check"
		},
		"summary": {
			"type": "string",
			"description": "Summary of results of code check"
		},
		"counts": {
			"description": "Overall counts of different categories of messages",
			"type": "object",
			"properties": {
				"notice": {
					"type": "number",
					"description": "Number of notice/successful messages"
				},
				"warning": {
					"type": "number",
					"description": "Number of warning messages"
				},
				"failure": {
					"type": "number",
					"description": "Number of failure message"
				}
			},
			"additionalProperties": false,
			"required": [
				"failure"
			]
		},
		"byFile": {
			"type": "object",
			"description": "Check results per each code file",
			"additionalProperties": {
				"type": "object",
				"required": [
					"counts",
					"details"
				],
				"properties": {
					"summary": {
						"type": "string"
					},
					"counts": {
						"properties": {
							"notice": {
								"type": "number",
								"description": "Number of notice/successful messages"
							},
							"warning": {
								"type": "number",
								"description": "Number of warning messages"
							},
							"failure": {
								"type": "number",
								"description": "Number of failure message"
							}
						},
						"additionalProperties": false,
						"required": [
							"failure"
						],
						"type": "object",
						"description": "Counts of different categories of messages for a specific code file"
					},
					"details": {
						"type": "array",
						"items": {
							"type": "object",
							"properties": {
								"Id": {
									"type": "string",
									"description": "Id of message"
								},
								"title": {
									"type": "string",
									"description": "Title of message"
								},
								"message": {
									"type": "string",
									"description": "Message content"
								},
								"category": {
									"type": "string",
									"description": "Message category",
									"enum": [
										"notice",
										"warning",
										"failure"
									]
								},
								"startLine": {
									"type": "integer"
								},
								"startColumn": {
									"type": "integer"
								},
								"endLine": {
									"type": "integer"
								},
								"endColumn": {
									"type": "integer"
								}
							},
							"additionalProperties": false,
							"required": [
								"message",
								"category"
							]
						}
					}
				},
				"additionalProperties": false
			}
		}
	},
	"additionalProperties": false,
	"required": [
		"byFile",
		"counts"
	]
}