Skip to content

Commit

Permalink
Variable Schema Docs Update (#375)
Browse files Browse the repository at this point in the history
* Variable Schema Docs Update

Added notes about adding/editing variable schemas belonging to associated variables.

* Quick edits/updates to variable schema docs

Cleaned up warning box for variable schema docs

---------

Co-authored-by: Andrew MacLean <andrewdmaclean@gmail.com>
  • Loading branch information
katemacfarlane and andrewdmaclean authored Oct 20, 2023
1 parent f457eca commit bb3cac3
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/extras/advanced-variables/variable-schemas.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Variable Schemas is a new DevCycle feature that lets you define allowable values

## Defining a Variable Schema

To define a Variable Schema for a variable, navigate to the Schema section of the Variable Details page to select and define a schema for that particular variable. The variable must be unassociated in order to select and define a schema.
To define a Variable Schema for a variable, navigate to the Schema section of the Variable Details page to select and define a schema for that particular variable. Variable Schemas can be added to both associated or unassociated variables.

There are three different types of schemas that you can define for your variable:

Expand All @@ -19,6 +19,10 @@ Each schema type requires a **Brief Description**. For example, when defining a

You also must set an **Example Value**. The example value will be used as the initial value for each variation when adding this variable to a feature.

:::caution
You will be unable to define or edit a Schema that makes the associated Feature’s values invalid.
:::

An **Enum** schema will allow you to input allowable values for a string or number variable.

If “Enum” type is selected, users must define the allowable values in the **Enum Values** input field.
Expand Down Expand Up @@ -56,4 +60,5 @@ You can also click on the word *"here”* to open a side panel which displays th

When adding a new variation for a variable with a schema, you can click on the variable name (e.g. *inline-search* in this example) to open a side panel which displays the schema definition along with other details about the variable.

![Add New Variable JSON Schema Selected](/june-2023-add-new-variation-with-schema.png)
![Add New Variable JSON Schema Selected](/june-2023-add-new-variation-with-schema.png)

1 comment on commit bb3cac3

@vercel
Copy link

@vercel vercel bot commented on bb3cac3 Oct 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.