Schema for metadata.yml for Realm Tomes

metadata.schema.json

{
	"$schema": "http://json-schema.org/draft-07/schema",
	"type": "object",
	"required": [
		"name",
		"description",
		"author",
		"tactic"
	],
	"properties": {
		"name": {
			"type": "string",
			"description": "Display name of your Tome."
		},
		"description": {
			"type": "string",
			"description": "Provide a helpful description of functionality for users of your Tome."
		},
		"author": {
			"type": "string",
			"description": "Your name/handle, so you can get credit for your amazing work!"
		},
		"support_model": {
			"type": "string",
			"description": "Information about the tome's support model.",
			"enum": [
				"UNSPECIFIED",
				"FIRST_PARTY",
				"COMMUNITY"
			],
			"default": "UNSPECIFIED"
		},
		"tactic": {
			"type": "string",
			"description": "The relevant MITRE ATT&CK tactic that best describes this Tome.",
			"enum": [
				"UNSPECIFIED",
				"RECON",
				"RESOURCE_DEVELOPMENT",
				"INITIAL_ACCESS",
				"EXECUTION",
				"PERSISTENCE",
				"PRIVILEGE_ESCALATION",
				"DEFENSE_EVASION",
				"CREDENTIAL_ACCESS",
				"DISCOVERY",
				"LATERAL_MOVEMENT",
				"COLLECTION",
				"COMMAND_AND_CONTROL",
				"EXFILTRATION",
				"IMPACT"
			]
		},
		"paramdefs": {
			"type": "array",
			"description": "A list of parameters that users may provide to your Tome when it is run.",
			"items": {
				"type": "object",
				"required": [
					"name",
					"label",
					"type",
					"placeholder"
				],
				"properties": {
					"name": {
						"type": "string",
						"description": "Identifier used to access the parameter via the `input_params` global."
					},
					"label": {
						"type": "string",
						"description": "Display name of the parameter for users of the Tome."
					},
					"type": {
						"type": "string",
						"description": "Type of the parameter in Eldritch.",
						"enum": [
							"string",
							"bool",
							"int",
							"list"
						]
					},
					"placeholder": {
						"type": "string",
						"description": "An example value displayed to users to help explain the parameter's purpose."
					}
				},
				"additionalProperties": false
			}
		},
		"additionalProperties": false
	},
	"additionalProperties": false
}