ftp.json

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$id": "https://asserest.github.io/schema/ftp.json",
    "description": "FTP exclusive configuration of Asserest configuration",
    "type": "object",
    "properties": {
        "username": {
            "description": "Username of FTP server that you want to test. ('anonymous' if this field omitted).",
            "type": "string"
        },
        "security": {
            "description": "Specify which security is used for connecting FTP server.",
            "type": "string",
            "enum": [
                "FTP",
                "FTPS",
                "FTPES"
            ],
            "default": "FTP"
        }
    },
    "required": [
        "security"
    ],
    "allOf": [
        {
            "if": {
                "required": [
                    "username"
                ]
            },
            "then": {
                "properties": {
                    "password": {
                        "description": "User's password of accessing FTP server. Please ensure the username IS USES FOR TESTING PURPOSE ONLY. Asserest is not liable for causing data leak with exposing actual account in this configuration script.",
                        "type": "string"
                    }
                }
            }
        },
        {
            "if": {
                "properties": {
                    "accessible": {
                        "enum": [
                            true
                        ]
                    }
                }
            },
            "then": {
                "properties": {
                    "access": {
                        "type": "array",
                        "minItems": 1,
                        "description": "Try access the given paths and determine can be accessible (granted list permission).",
                        "items": {
                            "type": "object",
                            "properties": {
                                "target_path": {
                                    "description": "Target path in FTP server in absolute form.",
                                    "type": "string",
                                    "format": "iri-reference",
                                    "pattern": "^/"
                                },
                                "success": {
                                    "description": "Determine the given path(s) can be opreated successfully.",
                                    "type": "boolean"
                                }
                            },
                            "required": [
                                "target_path",
                                "success"
                            ],
                            "additionalProperties": false
                        },
                        "additionalItems": false
                    }
                }
            }
        }
    ]
}