syspkg/docs/meta_schema.json

{
    "$schema": "http://json-schema.org/draft/2020-12/schema",
    "title": "Package Meta",
    "description": "meta information of a package",
    "type": "object",
    "properties": {
        "id": {
            "description": "unix name of the package",
            "type": "string",
            "minLength": 3,
            "maxLength": 63,
            "pattern": "^[a-zA-Z_][a-zA-Z0-9_\\-\\.]+"
        },
        "description": {
            "description": "translated names and descriptions of the package",
            "type": "array",
            "minItems": 1,
            "uniqueItems": true,
            "items": {
                "type": "object",
                "properties": {
                    "0": {
                        "description": "language code of the record",
                        "type": "string",
                        "minLength": 2,
                        "maxLength": 5,
                        "pattern": "^[a-z][a-z][_]?[A-Z]?[A-Z]?$"
                    },
                    "1": {
                        "description": "translated name of your package",
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 63
                    },
                    "2": {
                        "description": "translated description of your package",
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 511
                    }
                }
            }
        },
        "version": {
            "description": "canonical version",
            "type": "string",
            "minLength": 5,
            "maxLength": 15,
            "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$"
        },
        "release": {
            "description": "free form textual version",
            "type": "string",
            "minLength": 0,
            "maxLength": 31
        },
        "url": {
            "description": "download URL mask with $VERSION, $RELEASE and $ARCH",
            "type": "string",
            "minLength": 12,
            "maxLength": 255,
            "pattern": "^https://.*",
            "contentMediaType": "application/zip"
        },
        "category": {
            "description": "unix category name where the package belongs",
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "pattern": "[a-zA-Z0-9_]"
        },
        "depends": {
            "description": "mandatory dependencies of the package",
            "type": "array",
            "uniqueItems": true,
            "items": {
                "type": "string",
                "minLength": 3,
                "maxLength": 79,
                "pattern": "^[a-zA-Z0-9_\\-\\.]+[\\ ]?[0-9]*[\\.]?[0-9]*[\\.]?[0-9]*$"
            }
        },
        "suggests": {
            "description": "optional dependencies of the package",
            "type": "array",
            "uniqueItems": true,
            "items": {
                "type": "string",
                "minLength": 3,
                "maxLength": 79,
                "pattern": "^[a-zA-Z0-9_\\-\\.]+[\\ ]?[0-9]*[\\.]?[0-9]*[\\.]?[0-9]*$"
            }
        },
        "conflicts": {
            "description": "packages that this package conflicts with",
            "type": "array",
            "uniqueItems": true,
            "items": {
                "type": "string",
                "minLength": 3,
                "maxLength": 79,
                "pattern": "^[a-zA-Z0-9_\\-\\.]+[\\ ]?[0-9]*[\\.]?[0-9]*[\\.]?[0-9]*$"
            }
        },
        "license": {
            "description": "package's license",
            "type": "string",
            "minLength": 2,
            "maxLength": 15,
            "pattern": "^[A-Z][A-Z0-9_\\-]+"
        },
        "eula": {
            "description": "URL of the End User License Agreement",
            "type": "string",
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^https://.*",
            "contentMediaType": "text/plain"
        },
        "homepage": {
            "description": "URL to the package software's homepage",
            "type": "string",
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^https://.*",
            "contentMediaType": "text/html"
        },
        "bugtracker": {
            "description": "URL to the package software's issue tracker",
            "type": "string",
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^https://.*",
            "contentMediaType": "text/html"
        },
        "screenshots": {
            "description": "URLs to screenshot PNG files",
            "type": "array",
            "uniqueItems": true,
            "items": {
                "type": "string",
                "minLength": 0,
                "maxLength": 255,
                "pattern": "^https://.*\\.",
                "contentMediaType": "image/png"
            }
        },
        "override": {
            "description": "override category directories in payloads",
            "type": "object",
            "properties": {
                "bin": { "type": "string" },
                "inc": { "type": "string" },
                "lib": { "type": "string" },
                "etc": { "type": "string" },
                "src": { "type": "string" },
                "shr": { "type": "string" },
                "man": { "type": "string" },
                "var": { "type": "string" }
            }
        },
        "postinst": {
            "type": "object",
            "properties": {
                "env": {
                    "description": "configuration form specification for environment variables",
                    "type": "array",
                    "maxItems": 15,
                    "uniqueItems": true,
                    "items": {
                        "type": "object",
                        "properties": {
                            "name": {
                                "description": "name of the variable",
                                "type": "string",
                                "minLength": 0,
                                "maxLength": 15
                            },
                            "type": {
                                "description": "type of the variable",
                                "type": "string",
                                "minLength": 0,
                                "maxLength": 255
                            },
                            "desc": {
                                "description": "translated names and descriptions of the variables",
                                "type": "array",
                                "minItems": 1,
                                "uniqueItems": true,
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "0": {
                                            "description": "language code of the record",
                                            "type": "string",
                                            "minLength": 2,
                                            "maxLength": 5,
                                            "pattern": "^[a-z][a-z][_]?[A-Z]?[A-Z]?$"
                                        },
                                        "1": {
                                            "description": "translated name of the label",
                                            "type": "string",
                                            "minLength": 1,
                                            "maxLength": 31
                                        },
                                        "2": {
                                            "description": "translated description of the label",
                                            "type": "string",
                                            "minLength": 1,
                                            "maxLength": 255
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "commands": {
                    "description": "commands to be executed after installation",
                    "type": "array",
                    "maxItems": 7,
                    "items": {
                        "type": "string",
                        "minLength": 0,
                        "maxLength": 255
                    }
                }
            }
        },
        "payloads": {
            "description": "payload descriptions",
            "type": "array",
            "minItems": 1,
            "uniqueItems": true,
            "items": {
                "type": "object",
                "properties": {
                    "0": {
                        "description": "architecture or 'any'",
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 15
                    },
                    "1": {
                        "description": "compressed payload size",
                        "type": "number",
                        "minimum": 0,
                        "maximum": 9223372036854775807
                    },
                    "2": {
                        "description": "uncompressed payload size",
                        "type": "number",
                        "minimum": 0,
                        "maximum": 9223372036854775807
                    },
                    "3": {
                        "description": "SHA checksum of the payload",
                        "type": "string",
                        "minLength": 64,
                        "maxLength": 64,
                        "pattern": "[0-9a-f]"
                    }
                }
            }
        },
        "files": {
            "description": "list of files in payloads",
            "type": "array",
            "uniqueItems": true,
            "items": {
                "type": "object",
                "properties": {
                    "0": {
                        "description": "uncompressed file size",
                        "type": "number",
                        "minimum": 0,
                        "maximum": 9223372036854775807
                    },
                    "1": {
                        "description": "file name",
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 4084
                    }
                }
            }
        }
    },
    "required": [ "id", "description", "version", "category" ]
}