Viewset for viewing and uploading recipes.

GET /api/v3/recipe/721/?format=api
HTTP 200 OK
Allow: GET, PUT, PATCH, DELETE, HEAD, OPTIONS
Cache-Control: public, max-age=30
Content-Type: application/json
Vary: Accept

{
    "approved_revision": {
        "action": {
            "arguments_schema": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Run a feature experiment activated by a preference.",
                "type": "object",
                "required": [
                    "slug",
                    "preferenceName",
                    "preferenceType",
                    "branches"
                ],
                "properties": {
                    "slug": {
                        "description": "Unique identifier for this experiment",
                        "type": "string",
                        "pattern": "^[A-Za-z0-9\\-_]+$"
                    },
                    "experimentDocumentUrl": {
                        "description": "URL of a document describing the experiment",
                        "type": "string",
                        "format": "uri",
                        "default": ""
                    },
                    "preferenceName": {
                        "description": "Full dotted-path of the preference that controls this experiment",
                        "type": "string"
                    },
                    "preferenceType": {
                        "description": "Data type of the preference that controls this experiment",
                        "type": "string",
                        "enum": [
                            "string",
                            "integer",
                            "boolean"
                        ]
                    },
                    "preferenceBranchType": {
                        "description": "Controls whether the default or user value of the preference is modified",
                        "type": "string",
                        "enum": [
                            "user",
                            "default"
                        ],
                        "default": "default"
                    },
                    "isHighPopulation": {
                        "description": "Marks the preference experiment as a high population experiment, that should be excluded from certain types of telemetry",
                        "type": "boolean",
                        "default": "false"
                    },
                    "isEnrollmentPaused": {
                        "description": "If true, new users will not be enrolled in the study.",
                        "type": "boolean",
                        "default": false
                    },
                    "branches": {
                        "description": "List of experimental branches",
                        "type": "array",
                        "minItems": 1,
                        "items": {
                            "type": "object",
                            "required": [
                                "slug",
                                "value",
                                "ratio"
                            ],
                            "properties": {
                                "slug": {
                                    "description": "Unique identifier for this branch of the experiment",
                                    "type": "string",
                                    "pattern": "^[A-Za-z0-9\\-_]+$"
                                },
                                "value": {
                                    "description": "Value to set the preference to for this branch",
                                    "type": [
                                        "string",
                                        "number",
                                        "boolean"
                                    ]
                                },
                                "ratio": {
                                    "description": "Ratio of users who should be grouped into this branch",
                                    "type": "integer",
                                    "minimum": 1
                                }
                            }
                        }
                    }
                }
            },
            "name": "preference-experiment",
            "id": 3,
            "implementation_url": "https://normandy.cdn.mozilla.net/api/v1/action/preference-experiment/implementation/sha384-o1w_DJcXVnm6ppFcrPr78-Q32ZVXgi6lfYm9wUS3JBj5466SxrFpXaFt_KgJC87O/"
        },
        "approval_request": {
            "approved": true,
            "approver": {
                "id": 38,
                "first_name": "Benson",
                "last_name": "Wong",
                "email": "bwong@mozilla.com"
            },
            "comment": "removal of QA pref",
            "created": "2019-03-21T22:31:06.749571Z",
            "creator": {
                "id": 14,
                "first_name": "Rehan",
                "last_name": "Dalal",
                "email": "rdalal@mozilla.com"
            },
            "id": 1498,
            "revision": {
                "id": 2336,
                "recipe_id": 721
            }
        },
        "arguments": {
            "preferenceBranchType": "default",
            "slug": "hotfix-office365-legacy-keycode-and-charcode",
            "experimentDocumentUrl": "https://bugzilla.mozilla.org/show_bug.cgi?id=1536453",
            "isHighVolume": true,
            "preferenceName": "dom.keyboardevent.keypress.hack.use_legacy_keycode_and_charcode",
            "preferenceType": "string",
            "isEnrollmentPaused": false,
            "branches": [
                {
                    "ratio": 1,
                    "slug": "default",
                    "value": "powerpoint.officeapps.live.com"
                }
            ]
        },
        "experimenter_slug": null,
        "capabilities": [
            "jexl.transform.versionCompare",
            "jexl.context.env.version",
            "capabilities-v1",
            "action.preference-experiment"
        ],
        "comment": "",
        "creator": {
            "id": 14,
            "first_name": "Rehan",
            "last_name": "Dalal",
            "email": "rdalal@mozilla.com"
        },
        "date_created": "2019-03-21T22:31:00.920157Z",
        "enabled_states": [
            {
                "id": 764,
                "created": "2019-03-21T22:37:27.666999Z",
                "creator": {
                    "id": 14,
                    "first_name": "Rehan",
                    "last_name": "Dalal",
                    "email": "rdalal@mozilla.com"
                },
                "enabled": true,
                "carryover_from": null
            }
        ],
        "enabled": true,
        "extra_capabilities": [],
        "extra_filter_expression": "normandy.version < \"66.0.2\"",
        "filter_expression": "(normandy.channel in [\"release\"]) && ((env.version|versionCompare(\"66.!\")>=0)&&(env.version|versionCompare(\"66.*\")<0)) && (normandy.version < \"66.0.2\")",
        "filter_object": [
            {
                "channels": [
                    "release"
                ],
                "type": "channel"
            },
            {
                "versions": [
                    66
                ],
                "type": "version"
            }
        ],
        "id": 2336,
        "identicon_seed": "v1:gx557ngwoe",
        "metadata": {},
        "name": "Hotfix: Office 365 Legacy Keycode And Charcode",
        "recipe": {
            "approved_revision_id": 2336,
            "id": 721,
            "latest_revision_id": 2336
        },
        "updated": "2019-03-21T22:37:27.948324Z"
    },
    "id": 721,
    "latest_revision": {
        "action": {
            "arguments_schema": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Run a feature experiment activated by a preference.",
                "type": "object",
                "required": [
                    "slug",
                    "preferenceName",
                    "preferenceType",
                    "branches"
                ],
                "properties": {
                    "slug": {
                        "description": "Unique identifier for this experiment",
                        "type": "string",
                        "pattern": "^[A-Za-z0-9\\-_]+$"
                    },
                    "experimentDocumentUrl": {
                        "description": "URL of a document describing the experiment",
                        "type": "string",
                        "format": "uri",
                        "default": ""
                    },
                    "preferenceName": {
                        "description": "Full dotted-path of the preference that controls this experiment",
                        "type": "string"
                    },
                    "preferenceType": {
                        "description": "Data type of the preference that controls this experiment",
                        "type": "string",
                        "enum": [
                            "string",
                            "integer",
                            "boolean"
                        ]
                    },
                    "preferenceBranchType": {
                        "description": "Controls whether the default or user value of the preference is modified",
                        "type": "string",
                        "enum": [
                            "user",
                            "default"
                        ],
                        "default": "default"
                    },
                    "isHighPopulation": {
                        "description": "Marks the preference experiment as a high population experiment, that should be excluded from certain types of telemetry",
                        "type": "boolean",
                        "default": "false"
                    },
                    "isEnrollmentPaused": {
                        "description": "If true, new users will not be enrolled in the study.",
                        "type": "boolean",
                        "default": false
                    },
                    "branches": {
                        "description": "List of experimental branches",
                        "type": "array",
                        "minItems": 1,
                        "items": {
                            "type": "object",
                            "required": [
                                "slug",
                                "value",
                                "ratio"
                            ],
                            "properties": {
                                "slug": {
                                    "description": "Unique identifier for this branch of the experiment",
                                    "type": "string",
                                    "pattern": "^[A-Za-z0-9\\-_]+$"
                                },
                                "value": {
                                    "description": "Value to set the preference to for this branch",
                                    "type": [
                                        "string",
                                        "number",
                                        "boolean"
                                    ]
                                },
                                "ratio": {
                                    "description": "Ratio of users who should be grouped into this branch",
                                    "type": "integer",
                                    "minimum": 1
                                }
                            }
                        }
                    }
                }
            },
            "name": "preference-experiment",
            "id": 3,
            "implementation_url": "https://normandy.cdn.mozilla.net/api/v1/action/preference-experiment/implementation/sha384-o1w_DJcXVnm6ppFcrPr78-Q32ZVXgi6lfYm9wUS3JBj5466SxrFpXaFt_KgJC87O/"
        },
        "approval_request": {
            "approved": true,
            "approver": {
                "id": 38,
                "first_name": "Benson",
                "last_name": "Wong",
                "email": "bwong@mozilla.com"
            },
            "comment": "removal of QA pref",
            "created": "2019-03-21T22:31:06.749571Z",
            "creator": {
                "id": 14,
                "first_name": "Rehan",
                "last_name": "Dalal",
                "email": "rdalal@mozilla.com"
            },
            "id": 1498,
            "revision": {
                "id": 2336,
                "recipe_id": 721
            }
        },
        "arguments": {
            "preferenceBranchType": "default",
            "slug": "hotfix-office365-legacy-keycode-and-charcode",
            "experimentDocumentUrl": "https://bugzilla.mozilla.org/show_bug.cgi?id=1536453",
            "isHighVolume": true,
            "preferenceName": "dom.keyboardevent.keypress.hack.use_legacy_keycode_and_charcode",
            "preferenceType": "string",
            "isEnrollmentPaused": false,
            "branches": [
                {
                    "ratio": 1,
                    "slug": "default",
                    "value": "powerpoint.officeapps.live.com"
                }
            ]
        },
        "experimenter_slug": null,
        "capabilities": [
            "jexl.transform.versionCompare",
            "jexl.context.env.version",
            "capabilities-v1",
            "action.preference-experiment"
        ],
        "comment": "",
        "creator": {
            "id": 14,
            "first_name": "Rehan",
            "last_name": "Dalal",
            "email": "rdalal@mozilla.com"
        },
        "date_created": "2019-03-21T22:31:00.920157Z",
        "enabled_states": [
            {
                "id": 764,
                "created": "2019-03-21T22:37:27.666999Z",
                "creator": {
                    "id": 14,
                    "first_name": "Rehan",
                    "last_name": "Dalal",
                    "email": "rdalal@mozilla.com"
                },
                "enabled": true,
                "carryover_from": null
            }
        ],
        "enabled": true,
        "extra_capabilities": [],
        "extra_filter_expression": "normandy.version < \"66.0.2\"",
        "filter_expression": "(normandy.channel in [\"release\"]) && ((env.version|versionCompare(\"66.!\")>=0)&&(env.version|versionCompare(\"66.*\")<0)) && (normandy.version < \"66.0.2\")",
        "filter_object": [
            {
                "channels": [
                    "release"
                ],
                "type": "channel"
            },
            {
                "versions": [
                    66
                ],
                "type": "version"
            }
        ],
        "id": 2336,
        "identicon_seed": "v1:gx557ngwoe",
        "metadata": {},
        "name": "Hotfix: Office 365 Legacy Keycode And Charcode",
        "recipe": {
            "approved_revision_id": 2336,
            "id": 721,
            "latest_revision_id": 2336
        },
        "updated": "2019-03-21T22:37:27.948324Z"
    },
    "signature": {
        "timestamp": "2024-04-19T00:01:07.777701Z",
        "signature": "niIkGG9Lu0pd9LIFmAlZRTAT34vX4H3RFr1VgB1ic99KH9nLvRnfbRU6hP7A8f0NTa0xqujh9sYN1cIHG1qzBrdzks1LDpsYNXfK_KZBKdCjkRpM3Jq84HZZcK8UxtzH",
        "x5u": "https://content-signature-2.cdn.mozilla.net/chains/normandy.content-signature.mozilla.org-2024-05-20-00-15-25.chain",
        "public_key": ""
    },
    "uses_only_baseline_capabilities": false
}