Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SUPPORTENG-984 Correct the 'value' and 'sample' description in the 'FieldChoicesWithLabel' schema #716

Merged
merged 4 commits into from
Oct 20, 2023
Merged

SUPPORTENG-984 Correct the 'value' and 'sample' description in the 'FieldChoicesWithLabel' schema #716

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fba170d
SUPPORTENG-984 Correct the and description in the schema
Oct 19, 2023
bb25e8b
Updated the 'sample' description on the exported-schema.json
Osarhomiyeke Oct 20, 2023
988f497
Updated the 'sample' description in the schema.md file
Osarhomiyeke Oct 20, 2023
d0c4a7f
Update FieldChoiceWithLabelSchema.js
Osarhomiyeke Oct 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/schema/docs/build/schema.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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.",
Copy link
Member

@eliangcs eliangcs Oct 20, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
"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,
},
Expand Down