Merge pull request #716 from zapier/SUPPORTENG-984-correct-the-FieldC…

…hoiceWithLabelSchema SUPPORTENG-984 Correct the 'value' and 'sample' description in the 'FieldChoicesWithLabel' schema
zapier · Oct 20, 2023 · 3e63c86 · 3e63c86
2 parents d3a764e + d0c4a7f
commit 3e63c86
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/packages/schema/docs/build/schema.md b/packages/schema/docs/build/schema.md
@@ -858,8 +858,8 @@ An object describing a labeled choice in a static dropdown. Useful if the value
 
 Key | Required | Type | Description
 --- | -------- | ---- | -----------
-`value` | **yes** | `string` | The actual value that is sent into the Zap. Should match sample exactly.
-`sample` | **yes** | `string` | Displayed as light grey text in the editor. It's important that the value match the sample. Otherwise, the actual value won't match what the user picked, which is confusing.
+`value` | **yes** | `string` | The actual value that is sent into the Zap. This is displayed as light grey text in the editor. Should match sample exactly.
+`sample` | **yes** | `string` | A legacy field that is no longer used by the editor, but it is still required for now and should match the value.
 `label` | **yes** | `string` | A human readable label for this value.
 
 #### Examples
@@ -2217,4 +2217,4 @@ Represents a simplified semver string, from `0.0.0` to `999.999.999`.
 * `'1000.0.0'` - _Each number can be a maximum of 3 digits_
 * `'v1.0.0'` - _No letters allowed_
 * `'1.0.0-beta'` - _undefined_
-<!-- {% endraw %} -->
+<!-- {% endraw %} -->
diff --git a/packages/schema/exported-schema.json b/packages/schema/exported-schema.json
@@ -103,12 +103,12 @@
       "required": ["value", "sample", "label"],
       "properties": {
         "value": {
-          "description": "The actual value that is sent into the Zap. Should match sample exactly.",
+          "description": "The actual value that is sent into the Zap. This is displayed as light grey text in the editor. Should match sample exactly.",
           "type": "string",
           "minLength": 1
         },
         "sample": {
-          "description": "Displayed as light grey text in the editor. It's important that the value match the sample. Otherwise, the actual value won't match what the user picked, which is confusing.",
+          "description": "A legacy field that is no longer used by the editor, but it is still required for now and should match the value.",
           "type": "string",
           "minLength": 1
         },

diff --git a/packages/schema/lib/schemas/FieldChoiceWithLabelSchema.js b/packages/schema/lib/schemas/FieldChoiceWithLabelSchema.js
@@ -11,13 +11,13 @@ module.exports = makeSchema({
   properties: {
     value: {
       description:
-        'The actual value that is sent into the Zap. Should match sample exactly.',
+        'The actual value that is sent into the Zap. This is displayed as light grey text in the editor. Should match sample exactly.',
       type: 'string',
       minLength: 1,
     },
     sample: {
       description:
-        "Displayed as light grey text in the editor. It's important that the value match the sample. Otherwise, the actual value won't match what the user picked, which is confusing.",
+        "A legacy field that is no longer used by the editor, but it is still required for now and should match the value.",
       type: 'string',
       minLength: 1,
     },