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.

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

Feedback for “Schemas” #202

Closed
electricenjindevops opened this issue Mar 28, 2024 · 4 comments
Closed

Feedback for “Schemas” #202

electricenjindevops opened this issue Mar 28, 2024 · 4 comments
Assignees
Labels
wip Work is currently in progress.

Comments

@electricenjindevops
Copy link

On the schemas documentation we are unable to click the arrows to see more info for array / object structures.

examples:

  • facet
  • meta
  • selected

https://developer.bigcommerce.com/docs/storefront/stencil/themes/context/object-reference/schemas#category

I am using Chrome (latest version) on Windows 10.

@slsriehl slsriehl self-assigned this Apr 1, 2024
@slsriehl slsriehl added the wip Work is currently in progress. label Apr 1, 2024
@slsriehl
Copy link
Contributor

slsriehl commented Apr 1, 2024

Hi @electricenjindevops -- thanks for developing with BC and opening this issue. This work is ticketed and planned, and I'm going to leave this issue open until it's resolved.

@electricenjindevops
Copy link
Author

electricenjindevops commented Apr 1, 2024 via email

slsriehl pushed a commit that referenced this issue May 13, 2024
<!-- Ticket number or summary of work -->
# ISSUE-202: [update] Category object, add empty properties


## What changed?
<!-- Provide a bulleted list in the present tense -->
* Add empty properties to objects that didn't have them, per #202 

## Release notes draft
<!-- 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 @bc-traciporter
@slsriehl
Copy link
Contributor

@electricenjindevops There actually isn't any more detail in the schema as we have it now, so this isn't a problem with the docs per se (although they are part of the solution!). I did make a small adjustment to the source file, which you can see in the merged PR above, but it doesn't yet add any of the detail you're after.

We'll make sure there's an open ticket for the engineering group that manages Stencil to check out the issue with meta, as well as a docs ticket to add more detail.

@bc-traciporter
Copy link
Collaborator

@electricenjindevops I will close this issue due to inactivity. I did confirm that there isn't any more detail in the schemas. Unfortunately the empty arrays are confusing. We have informed our team.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wip Work is currently in progress.
Projects
None yet
Development

No branches or pull requests

3 participants