Update Flag

v1.0.0

This endpoint updates the metadata of a Feature Flag or Setting with a collection of operations in a specified Config.

Only the name, hint and tags attributes are modifiable by this endpoint. The tags attribute is a simple collection of the attached to the given setting.

The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change.

For example: We have the following resource.

{	"settingId": 5345,	"key": "myGrandFeature",	"name": "Tihs is a naem with soem typos.",	"hint": "This flag controls my grandioso feature.",	"settingType": "boolean",	"tags": [		{			"tagId": 0,			"name": "sample tag",			"color": "whale"		}	]}

If we send an update request body as below (it changes the name and adds the already existing tag with the id 2):

Only the name and tags are going to be updated and all the other attributes are remaining unchanged. So we get a response like this:

{	"settingId": 5345,	"key": "myGrandFeature",	"name": "This is the name without typos.",	"hint": "This flag controls my grandioso feature.",	"settingType": "boolean",	"tags": [		{			"tagId": 0,			"name": "sample tag",			"color": "whale"		},		{			"tagId": 2,			"name": "another tag",			"color": "koala"		}	]}

Input

{
  "type": "object",
  "properties": {
    "operations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "from": {
            "type": "object",
            "properties": {
              "isUriEncoded": {
                "type": "boolean"
              },
              "kind": {
                "type": "string",
                "enum": [
                  "unspecified",
                  "plain",
                  "uriEncoded"
                ]
              },
              "segments": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "source": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "source": {
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "op": {
            "type": "string",
            "enum": [
              "unknown",
              "add",
              "remove",
              "replace",
              "move",
              "copy",
              "test"
            ]
          },
          "path": {
            "type": "object",
            "properties": {
              "isUriEncoded": {
                "type": "boolean"
              },
              "kind": {
                "type": "string",
                "enum": [
                  "unspecified",
                  "plain",
                  "uriEncoded"
                ]
              },
              "segments": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "source": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "source": {
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "value": {
            "type": "object",
            "properties": {
              "options": {
                "type": "object",
                "properties": {
                  "propertyNameCaseInsensitive": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              "parent": {
                "type": "object",
                "additionalProperties": true
              },
              "root": {
                "type": "object",
                "additionalProperties": true
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      }
    },
    "settingId": {
      "type": "integer",
      "format": "int32"
    }
  },
  "required": [
    "settingId"
  ],
  "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
}