Split · Schema

FeatureFlagDefinitionUpdate

Request body for partially updating a feature flag definition in an environment. Only provided fields are updated.

ExperimentationFeature FlagsFeature ManagementRolloutsSDKs

Properties

Name	Type	Description
treatments	array	Updated list of treatments
defaultTreatment	string	Updated default treatment
baselineTreatment	string	Updated baseline treatment
rules	array	Updated targeting rules
defaultRule	array	Updated default percentage-based rollout rule
trafficAllocation	integer	Updated traffic allocation percentage
comment	string	Comment describing the update

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FeatureFlagDefinitionUpdate",
  "title": "FeatureFlagDefinitionUpdate",
  "type": "object",
  "description": "Request body for partially updating a feature flag definition in an environment. Only provided fields are updated.",
  "properties": {
    "treatments": {
      "type": "array",
      "description": "Updated list of treatments",
      "items": {
        "$ref": "#/components/schemas/Treatment"
      }
    },
    "defaultTreatment": {
      "type": "string",
      "description": "Updated default treatment"
    },
    "baselineTreatment": {
      "type": "string",
      "description": "Updated baseline treatment"
    },
    "rules": {
      "type": "array",
      "description": "Updated targeting rules",
      "items": {
        "$ref": "#/components/schemas/TargetingRule"
      }
    },
    "defaultRule": {
      "type": "array",
      "description": "Updated default percentage-based rollout rule",
      "items": {
        "$ref": "#/components/schemas/Bucket"
      }
    },
    "trafficAllocation": {
      "type": "integer",
      "description": "Updated traffic allocation percentage",
      "minimum": 0,
      "maximum": 100
    },
    "comment": {
      "type": "string",
      "description": "Comment describing the update"
    }
  }
}