TraceControl.json

{
    "$schema": "https://raw.githubusercontent.com/rdkcentral/Thunder/master/Tools/JsonGenerator/schemas/interface.schema.json",
    "jsonrpc": "2.0",
    "info": {
        "title": "TraceControl API",
        "class": "TraceControl",
        "description": "The `TraceControl` plugin provides ability to disable/enable trace output an set its verbosity level."
    },
    "common": {
        "$ref": "../common/common.json"
    },
    "definitions": {
        "module": {
            "description": "The module name. If the module name is not specified then, it returns all modules",
            "type": "string",
            "example": "Plugin_Monitor"
        },
        "category": {
            "description": "The category name. If the category name is not specified then, it returns all categories",
            "type": "string",
            "example": "Information"
        },
        "state": {
            "description": "The state value",
            "type": "string",
            "enum": [
                "enabled",
                "disabled",
                "tristated"
            ],
            "example": "disabled"
        },
        "trace": {
            "description": "Trace information",
            "type": "object",
            "properties": {
                "module": {
                    "$ref": "#/definitions/module"
                },
                "category": {
                    "$ref": "#/definitions/category"
                },
                "state": {
                    "$ref": "#/definitions/state"
                }
            },
            "required": [
              "module",
              "category",
              "state"
            ]
        }
    },
    "methods": {
        "set": {
            "summary": "Sets traces. Enables or disables all or select category traces for the specified module.",
            "params": {
                "$ref": "#/definitions/trace"
            },
            "result": {
                "$ref": "#/common/results/void"
            }
        },
        "status":{
            "summary": "Retrieves the actual trace status information for the specified module and category. If the category or module is not specified then, all the information is returned. If both module and category are not specified then, the result is empty. It retrieves the details about the console status and remote address (port and binding), if these are configured.",
            "params": {
                "type": "object",
                "properties": {
                    "module": {
                        "$ref": "#/definitions/module"
                    },
                    "category": {
                        "$ref": "#/definitions/category"
                    }
                },
                "required": [
                    "module",
                    "category"
                ]
            },
            "result": {
                "type": "object",
                "properties": {
                    "console": {
                        "description": "`true` if a console, otherwise `false`",
                        "type": "boolean",
                        "example": false
                    },
                    "remote": {
                        "description": "The remote address",
                        "type": "object",
                        "properties": {
                            "port": {
                                "description": "The port number",
                                "type": "number",
                                "size": 16,
                                "example": 2200
                            },
                            "binding": {
                                "description": "The binding address",
                                "type": "string",
                                "example": "0.0.0.0"
                            }
                        },
                        "required": [
                            "port",
                            "binding"
                        ]
                    },
                    "settings": {
                        "type": "array",
                        "items": {
                            "$ref": "#/definitions/trace"
                        }
                    }
                },
                "required": [
                    "console",
                    "remote",
                    "settings"
                ]
            }
        }
    }
}