danger-outgoing-process-schema.json

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "definitions": {
        "Violation": {
            "description": "The result of user doing warn, message or fail, built this way for\nexpansion later.",
            "properties": {
                "file": {
                    "description": "Optional path to the file",
                    "type": "string"
                },
                "icon": {
                    "description": "Optional icon for table (Only valid for messages)",
                    "type": "string"
                },
                "line": {
                    "description": "Optional line in the file",
                    "type": "number"
                },
                "message": {
                    "description": "The string representation",
                    "type": "string"
                }
            },
            "type": "object"
        }
    },
    "description": "The representation of what running a Dangerfile generates.\nThis needs to be passed between processes, so data only please.",
    "properties": {
        "fails": {
            "description": "Failed messages",
            "items": {
                "$ref": "#/definitions/Violation"
            },
            "type": "array"
        },
        "github": {
            "properties": {
                "stepSummary": {
                    "description": "Markdown text which gets added as a summary in the first\npage which you see when you click through to the PR results.\n\nhttps://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/",
                    "type": "string"
                }
            },
            "type": "object"
        },
        "markdowns": {
            "description": "Markdown messages to attach at the bottom of the comment",
            "items": {
                "$ref": "#/definitions/Violation"
            },
            "type": "array"
        },
        "messages": {
            "description": "A set of messages to show inline",
            "items": {
                "$ref": "#/definitions/Violation"
            },
            "type": "array"
        },
        "meta": {
            "description": "Meta information about the runtime evaluation",
            "properties": {
                "runtimeHref": {
                    "description": "e.g. \"https://danger.systems/js\"",
                    "type": "string"
                },
                "runtimeName": {
                    "description": "E.g. \"dangerJS\", or \"Danger Swift\"",
                    "type": "string"
                }
            },
            "type": "object"
        },
        "warnings": {
            "description": "Messages for info",
            "items": {
                "$ref": "#/definitions/Violation"
            },
            "type": "array"
        }
    },
    "type": "object"
}