Replace value

v1.0.0

This endpoint replaces the whole value of a Feature Flag or Setting in a specified Environment.

Only the value, rolloutRules and percentageRules attributes are modifiable by this endpoint.

Important: As this endpoint is doing a complete replace, it's important to set every other attribute that you don't want to change in its original state. Not listing one means that it will reset.

For example: We have the following resource.

If we send a replace request body as below:

Then besides that the default value is set to true, all the Percentage Rules are deleted. So we get a response like this:

The rolloutRules property describes two types of rules:

Targeting rules: When you want to add or update a targenting rule, the comparator, comparisonAttribute, and comparisonValue members are required.
Segment rules: When you want to add add or update a segment rule, the segmentId which identifies the desired segment and the segmentComparator members are required.

Input

{
  "type": "object",
  "properties": {
    "environmentId": {
      "type": "string",
      "format": "uuid"
    },
    "reason": {
      "type": "string"
    },
    "rolloutPercentageItems": {
      "type": "array",
      "description": "The percentage rule collection.",
      "items": {
        "type": "object",
        "required": [
          "percentage"
        ],
        "properties": {
          "percentage": {
            "type": "integer",
            "format": "int64",
            "description": "The percentage value for the rule."
          },
          "value": {
            "description": "The value to serve when the user falls in the percentage rule. It must respect the setting type.",
            "type": "object"
          }
        },
        "additionalProperties": false
      }
    },
    "rolloutRules": {
      "type": "array",
      "description": "The targeting rule collection.",
      "items": {
        "type": "object",
        "properties": {
          "comparator": {
            "type": "string",
            "enum": [
              "isOneOf",
              "isNotOneOf",
              "contains",
              "doesNotContain",
              "semVerIsOneOf",
              "semVerIsNotOneOf",
              "semVerLess",
              "semVerLessOrEquals",
              "semVerGreater",
              "semVerGreaterOrEquals",
              "numberEquals",
              "numberDoesNotEqual",
              "numberLess",
              "numberLessOrEquals",
              "numberGreater",
              "numberGreaterOrEquals",
              "sensitiveIsOneOf",
              "sensitiveIsNotOneOf"
            ]
          },
          "comparisonAttribute": {
            "type": "string",
            "description": "The user attribute to compare."
          },
          "comparisonValue": {
            "type": "string",
            "description": "The value to compare against."
          },
          "segmentComparator": {
            "type": "string",
            "enum": [
              "isIn",
              "isNotIn"
            ]
          },
          "segmentId": {
            "type": "string",
            "format": "uuid",
            "description": "The segment to compare against."
          },
          "value": {
            "description": "The value to serve when the comparison matches. It must respect the setting type.",
            "type": "object"
          }
        },
        "additionalProperties": false
      }
    },
    "settingId": {
      "type": "integer",
      "format": "int32"
    },
    "value": {
      "description": "The value to serve. It must respect the setting type.",
      "type": "object"
    }
  },
  "required": [
    "environmentId",
    "settingId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "config": {
      "type": "object",
      "properties": {
        "configId": {
          "type": "string",
          "format": "uuid"
        },
        "description": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "order": {
          "type": "integer",
          "format": "int32"
        },
        "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
        }
      },
      "additionalProperties": false
    },
    "environment": {
      "type": "object",
      "properties": {
        "color": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "environmentId": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string"
        },
        "order": {
          "type": "integer",
          "format": "int32"
        },
        "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
        },
        "reasonRequired": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "integrationLinks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string"
          },
          "integrationLinkType": {
            "type": "string",
            "enum": [
              "trello",
              "jira",
              "monday"
            ]
          },
          "key": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        },
        "additionalProperties": false
      }
    },
    "lastUpdaterUserEmail": {
      "type": "string"
    },
    "lastUpdaterUserFullName": {
      "type": "string"
    },
    "readOnly": {
      "type": "boolean"
    },
    "rolloutPercentageItems": {
      "type": "array",
      "description": "The percentage rule collection.",
      "items": {
        "type": "object",
        "required": [
          "percentage"
        ],
        "properties": {
          "percentage": {
            "type": "integer",
            "format": "int64",
            "description": "The percentage value for the rule."
          },
          "value": {
            "description": "The value to serve when the user falls in the percentage rule. It must respect the setting type.",
            "type": "object"
          }
        },
        "additionalProperties": false
      }
    },
    "rolloutRules": {
      "type": "array",
      "description": "The targeting rule collection.",
      "items": {
        "type": "object",
        "properties": {
          "comparator": {
            "type": "string",
            "enum": [
              "isOneOf",
              "isNotOneOf",
              "contains",
              "doesNotContain",
              "semVerIsOneOf",
              "semVerIsNotOneOf",
              "semVerLess",
              "semVerLessOrEquals",
              "semVerGreater",
              "semVerGreaterOrEquals",
              "numberEquals",
              "numberDoesNotEqual",
              "numberLess",
              "numberLessOrEquals",
              "numberGreater",
              "numberGreaterOrEquals",
              "sensitiveIsOneOf",
              "sensitiveIsNotOneOf"
            ]
          },
          "comparisonAttribute": {
            "type": "string",
            "description": "The user attribute to compare."
          },
          "comparisonValue": {
            "type": "string",
            "description": "The value to compare against."
          },
          "segmentComparator": {
            "type": "string",
            "enum": [
              "isIn",
              "isNotIn"
            ]
          },
          "segmentId": {
            "type": "string",
            "format": "uuid",
            "description": "The segment to compare against."
          },
          "value": {
            "description": "The value to serve when the comparison matches. It must respect the setting type.",
            "type": "object"
          }
        },
        "additionalProperties": false
      }
    },
    "setting": {
      "type": "object",
      "properties": {
        "createdAt": {
          "type": "string",
          "format": "date-time"
        },
        "creatorEmail": {
          "type": "string"
        },
        "creatorFullName": {
          "type": "string"
        },
        "hint": {
          "type": "string"
        },
        "isWatching": {
          "type": "boolean"
        },
        "key": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "order": {
          "type": "integer",
          "format": "int32"
        },
        "settingId": {
          "type": "integer",
          "format": "int32"
        },
        "settingType": {
          "type": "string",
          "enum": [
            "boolean",
            "string",
            "int",
            "double"
          ]
        }
      },
      "additionalProperties": false
    },
    "settingTags": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "color": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "settingTagId": {
            "type": "integer",
            "format": "int64"
          },
          "tagId": {
            "type": "integer",
            "format": "int64"
          }
        },
        "additionalProperties": false
      }
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "value": {
      "description": "The value to serve. It must respect the setting type.",
      "type": "object"
    }
  },
  "additionalProperties": false
}