feat: enhance options for /settings/system/ API #1108

bzwei · 2024-10-17T20:35:28Z

Add customized attributes to fields from GET and PATCH method in the return body from OPTIONS method. These can be used for UI to properly render them to customer.

This implemententation returns a format compatible with how the controller returns OPTIONS request.

AAP-33164: EDA settings API needs to provide Options method.

Sample output:

{
    "name": "Setting",
    "description": "",
    "renders": [
        "application/json",
        "text/html"
    ],
    "parses": [
        "application/json",
        "application/x-www-form-urlencoded",
        "multipart/form-data"
    ],
    "actions": {
        "PATCH": {
            "INSIGHTS_TRACKING_STATE": {
                "type": "boolean",
                "required": false,
                "label": "Gather data for Automation Analytics",
                "help_text": "Enables the service to gather data on automation and send it to Automation Analytics.",
                "category": "System",
                "category_slug": "system",
                "hidden": false,
                "default": false
            }
        }
        "GET": {
            "INSIGHTS_TRACKING_STATE": {
                "type": "boolean",
                "label": "Gather data for Automation Analytics",
                "help_text": "Enables the service to gather data on automation and send it to Automation Analytics.",
                "category": "System",
                "category_slug": "system",
                "defined_in_file": false,
                "hidden": false
            }
        }
    }
}

Add customized attributes to fields from GET and PATCH method in the return body from OPTIONS method. These can be used for UI to properly render them to customer. This implemententation returns a format compatible with how the controller returns OPTIONS request. AAP-33164: EDA settings API needs to provide Options method