Enhance GraphQL category and product view documentation#568
Merged
Conversation
- Updated `categories` query documentation to include `position` field and improved descriptions for clarity. - Enhanced descriptions in `CategoryView` and `CategoryViewInterface` sections for better understanding of category attributes.
github-project-automation
Bot
moved this from 📋 Needs Review
to 🏁 Done
in Commerce - Pull Requests
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose of this pull request
positionfield on the Catalog Servicecategoriesquery,CategoryViewandCategoryViewInterfacefield descriptions, and aligns query input arguments with the schema.JIRA: DATA-7189
Affected pages
Summary of changes
src/pages/graphql/schema/catalog-service/queries/categories.mdpositionto the example GraphQL request and JSON response.rolesoptional, corrected types and wording).src/_includes/graphql/catalog-service/categories.mdpositiononCategoryViewandCategoryViewInterface.rolesdescriptions (category roles, not SEO keywords) and aligned field descriptions with the schema.CategoryViewInterfacefield table.What's New highlights
whatsnew
Updated the Catalog Service categories query with the
positionfield and corrected category field descriptions.