Skip to content

DEVDOCS-6453 - add resourceId to translation gql docs #1035

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

Merged
merged 12 commits into from
Aug 21, 2025
Merged

Conversation

chris-nowicki
Copy link
Contributor

@chris-nowicki chris-nowicki commented Aug 4, 2025

DEVDOCS-6453

What changed?

  • Documentation for filtering translations by resourceId for brands, categories, and locations resource types.

Release notes draft

Updated documentation for filtering translations by resourceId

ping @bc-janet

@chris-nowicki chris-nowicki requested a review from bc-janet August 4, 2025 13:16
@chris-nowicki chris-nowicki added ready for review This PR is complete and awaiting a review. need-SME-review A subject matter expert is needed to review. awaiting-css-cue labels Aug 4, 2025
@DmytroSirenko
Copy link

@chris-nowicki , can you please update query example as shown in https://github.com/bigcommerce/api-proxy-java/pull/3578 -> Testing -> Manual Testing section?
The key difference is that ResourceId field has to be replaced with ResourceIds one.

@chris-nowicki
Copy link
Contributor Author

@chris-nowicki , can you please update query example as shown in bigcommerce/api-proxy-java#3578 -> Testing -> Manual Testing section? The key difference is that ResourceId field has to be replaced with ResourceIds one.

@DmytroSirenko I made the updates to match! Let me know if this is good to go :)

@DmytroSirenko
Copy link

@chris-nowicki , can you please update query example as shown in bigcommerce/api-proxy-java#3578 -> Testing -> Manual Testing section? The key difference is that ResourceId field has to be replaced with ResourceIds one.

@DmytroSirenko I made the updates to match! Let me know if this is good to go :)

Thanks @chris-nowicki,
The current version is correct though could you please make it more complex by changing REQUEST from single-string resourceIds: ["bc/store/brand/37"] to array resourceIds: ["bc/store/brand/37","bc/store/brand/38"] in order to highlight a bulk nature of this parameter? In this case, the RESPONSE will change as well containing 2 nodes (trees) instead of 1.

@chris-nowicki
Copy link
Contributor Author

chris-nowicki commented Aug 21, 2025

@chris-nowicki , can you please update query example as shown in bigcommerce/api-proxy-java#3578 -> Testing -> Manual Testing section? The key difference is that ResourceId field has to be replaced with ResourceIds one.

@DmytroSirenko I made the updates to match! Let me know if this is good to go :)

Thanks @chris-nowicki, The current version is correct though could you please make it more complex by changing REQUEST from single-string resourceIds: ["bc/store/brand/37"] to array resourceIds: ["bc/store/brand/37","bc/store/brand/38"] in order to highlight a bulk nature of this parameter? In this case, the RESPONSE will change as well containing 2 nodes (trees) instead of 1.

@DmytroSirenko Updated for multiple strings in the resourceIds and updated the responses. :) ✅

Copy link

@bc-janet bc-janet left a comment

Choose a reason for hiding this comment

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

Looks good, and was approved by stakeholder via slack

@chris-nowicki chris-nowicki merged commit 2eb989e into main Aug 21, 2025
3 checks passed
@chris-nowicki chris-nowicki deleted the DEVDOCS-6453 branch August 21, 2025 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting-css-cue need-SME-review A subject matter expert is needed to review. ready for review This PR is complete and awaiting a review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants