Split · Schema

FeatureFlagDefinitionCreate

Request body for creating a feature flag definition in an environment

ExperimentationFeature FlagsFeature ManagementRolloutsSDKs

Properties

Name Type Description
treatments array List of treatments for this definition
defaultTreatment string The default treatment for unmatched traffic
baselineTreatment string The baseline treatment for experimentation
rules array Targeting rules for the definition
defaultRule array Default percentage-based rollout rule
trafficAllocation integer Percentage of traffic included in evaluation
View JSON Schema on GitHub

JSON Schema

split-featureflagdefinitioncreate-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FeatureFlagDefinitionCreate",
  "title": "FeatureFlagDefinitionCreate",
  "type": "object",
  "description": "Request body for creating a feature flag definition in an environment",
  "required": [
    "treatments",
    "defaultTreatment",
    "defaultRule"
  ],
  "properties": {
    "treatments": {
      "type": "array",
      "description": "List of treatments for this definition",
      "items": {
        "$ref": "#/components/schemas/Treatment"
      }
    },
    "defaultTreatment": {
      "type": "string",
      "description": "The default treatment for unmatched traffic"
    },
    "baselineTreatment": {
      "type": "string",
      "description": "The baseline treatment for experimentation"
    },
    "rules": {
      "type": "array",
      "description": "Targeting rules for the definition",
      "items": {
        "$ref": "#/components/schemas/TargetingRule"
      }
    },
    "defaultRule": {
      "type": "array",
      "description": "Default percentage-based rollout rule",
      "items": {
        "$ref": "#/components/schemas/Bucket"
      }
    },
    "trafficAllocation": {
      "type": "integer",
      "description": "Percentage of traffic included in evaluation",
      "minimum": 0,
      "maximum": 100
    }
  }
}