Skip to content

Commit

Permalink
SUPPORTENG-984 Correct the and description in the schema
Browse files Browse the repository at this point in the history
  • Loading branch information
Osarhomiyeke Iyere committed Oct 19, 2023
1 parent d3a764e commit fba170d
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions packages/schema/docs/build/schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -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` | It's important that the value match the sample. Otherwise, the actual value won't match what the user picked, which is confusing.
`label` | **yes** | `string` | A human readable label for this value.

#### Examples
Expand Down
4 changes: 2 additions & 2 deletions packages/schema/exported-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": "It's important that the value match the sample. Otherwise, the actual value won't match what the user picked, which is confusing.",
"type": "string",
"minLength": 1
},
Expand Down
4 changes: 2 additions & 2 deletions packages/schema/lib/schemas/FieldChoiceWithLabelSchema.js
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
"It's important that the value match the sample. Otherwise, the actual value won't match what the user picked, which is confusing.",
type: 'string',
minLength: 1,
},
Expand Down

0 comments on commit fba170d

Please sign in to comment.