Split · Schema

ChangeRequest

A change request representing a pending modification to a feature flag definition that requires approval.

ExperimentationFeature FlagsFeature ManagementRolloutsSDKs

Properties

Name Type Description
id string Unique identifier for the change request
status string Current status of the change request
title string Title of the change request
comment string Comment describing the proposed change
split string Name of the feature flag being modified
environment string Environment in which the change is proposed
operationType string Type of operation being requested
createdAt integer Timestamp of when the change request was created
approvers array Users who can approve the change request
View JSON Schema on GitHub

JSON Schema

split-changerequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ChangeRequest",
  "title": "ChangeRequest",
  "type": "object",
  "description": "A change request representing a pending modification to a feature flag definition that requires approval.",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the change request"
    },
    "status": {
      "type": "string",
      "description": "Current status of the change request",
      "enum": [
        "OPEN",
        "APPROVED",
        "DECLINED",
        "APPLIED",
        "CANCELLED"
      ]
    },
    "title": {
      "type": "string",
      "description": "Title of the change request"
    },
    "comment": {
      "type": "string",
      "description": "Comment describing the proposed change"
    },
    "split": {
      "type": "string",
      "description": "Name of the feature flag being modified"
    },
    "environment": {
      "type": "string",
      "description": "Environment in which the change is proposed"
    },
    "operationType": {
      "type": "string",
      "description": "Type of operation being requested"
    },
    "createdAt": {
      "type": "integer",
      "format": "int64",
      "description": "Timestamp of when the change request was created"
    },
    "approvers": {
      "type": "array",
      "description": "Users who can approve the change request",
      "items": {
        "$ref": "#/components/schemas/User"
      }
    }
  }
}