Skip to content

Commit

Permalink
DEVDOCS-6158: [update] update key description (#683)
Browse files Browse the repository at this point in the history
<!-- Ticket number or summary of work -->
# [DEVDOCS-6158]


## What changed?
Updated the description of key to prevent confusion

## Release notes draft

Enhancement
<!-- Provide an entry for the release notes using simple, conversational
language. Don't be too technical. Explain how the change will benefit
the merchant and link to the feature.

Examples:
* The newly-released [X feature] is now available to use. Now, you’ll be
able to [perform Y action].
* We're happy to announce [X feature], which can help you [perform Y
action].
* [X feature] helps you to create [Y response] using the [Z query
parameter]. Now, you can deliver [ex, localized shopping experiences for
your customers].
* Fixed a bug in the [X endpoint]. Now the [Y field] will appear when
you click [Z option]. -->
* 

## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->

ping {names}


[DEVDOCS-6158]:
https://bigcommercecloud.atlassian.net/browse/DEVDOCS-6158?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
  • Loading branch information
bc-traciporter authored Nov 26, 2024
1 parent 0dddd49 commit 5cab6d6
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions reference/widgets.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1754,7 +1754,7 @@ components:
properties:
key:
type: string
description: The ID of the `setting` object the conditional attribute is related to.
description: The ID of the `settings` object the conditional attribute is related to. The key must be defined within the same settings array as the conditional property. This ensures the conditional logic is scoped to the relevant settings group.
example: backgroundType
operator:
type: string
Expand Down Expand Up @@ -1955,7 +1955,7 @@ components:
properties:
key:
type: string
description: The ID of the `setting` object the conditional attribute is related to.
description: The ID of the `settings` object the conditional attribute is related to. You must define the key within the same settings array as the conditional property to scope the conditional logic to the relevant settings group.
example: backgroundType
operator:
type: string
Expand Down Expand Up @@ -1983,7 +1983,7 @@ components:
properties:
key:
type: string
description: The ID of the `setting` object the conditional attribute is related to.
description: The ID of the `settings` object the conditional attribute is related to. You must define the key within the same settings array as the conditional property to scope the conditional logic to the relevant settings group.
example: backgroundType
operator:
type: string
Expand Down

0 comments on commit 5cab6d6

Please sign in to comment.