Create Flag

v1.0.0

This endpoint creates a new Feature Flag or Setting in a specified Config identified by the configId parameter.

Important: The key attribute must be unique within the given Config.

Input

{
  "type": "object",
  "properties": {
    "configId": {
      "type": "string",
      "format": "uuid"
    },
    "hint": {
      "type": "string",
      "description": "A short description for the setting, shown on the Dashboard UI."
    },
    "initialValues": {
      "type": "array",
      "description": "Optional, initial values of the feature flag or setting in the given Environments.",
      "items": {
        "type": "object",
        "properties": {
          "environmentId": {
            "type": "string",
            "format": "uuid",
            "description": "The ID of the Environment where the initial value should be set."
          },
          "value": {
            "description": "The initial value in the given Environment. It must respect the setting type.",
            "type": "object"
          }
        },
        "additionalProperties": false
      }
    },
    "key": {
      "type": "string",
      "description": "The key of the setting."
    },
    "name": {
      "type": "string",
      "description": "The name of the setting, shown on the Dashboard UI."
    },
    "settingType": {
      "type": "string",
      "enum": [
        "boolean",
        "string",
        "int",
        "double"
      ]
    },
    "tags": {
      "type": "array",
      "description": "The IDs of the tags which are attached to the setting.",
      "items": {
        "type": "integer",
        "format": "int64"
      }
    }
  },
  "required": [
    "configId",
    "key",
    "name",
    "settingType"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "configId": {
      "type": "string",
      "format": "uuid"
    },
    "configName": {
      "type": "string"
    },
    "hint": {
      "type": "string"
    },
    "key": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "order": {
      "type": "integer",
      "format": "int32"
    },
    "settingId": {
      "type": "integer",
      "format": "int32"
    },
    "settingType": {
      "type": "string",
      "enum": [
        "boolean",
        "string",
        "int",
        "double"
      ]
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "color": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "product": {
            "type": "object",
            "properties": {
              "description": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "order": {
                "type": "integer",
                "format": "int32"
              },
              "organization": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "organizationId": {
                    "type": "string",
                    "format": "uuid"
                  }
                },
                "additionalProperties": false
              },
              "productId": {
                "type": "string",
                "format": "uuid"
              },
              "reasonRequired": {
                "type": "boolean"
              }
            },
            "additionalProperties": false
          },
          "tagId": {
            "type": "integer",
            "format": "int64"
          }
        },
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false
}