Skip to content

DATA-7189: Update categories query with position field and improve descriptions#568

Merged
meker12 merged 2 commits into
meker12-patch-1from
DATA-7189-cs-categories-position-field
May 27, 2026
Merged

DATA-7189: Update categories query with position field and improve descriptions#568
meker12 merged 2 commits into
meker12-patch-1from
DATA-7189-cs-categories-position-field

Conversation

@meker12
Copy link
Copy Markdown
Contributor

@meker12 meker12 commented May 27, 2026

Purpose of this pull request

  • Documents the position field on the Catalog Service categories query,
  • Corrects CategoryView and CategoryViewInterface field 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.md

  • Added position to the example GraphQL request and JSON response.
  • Updated Input fields and Subtree input to match schema descriptions (roles optional, corrected types and wording).

src/_includes/graphql/catalog-service/categories.md

  • Documented position on CategoryView and CategoryViewInterface.
  • Corrected roles descriptions (category roles, not SEO keywords) and aligned field descriptions with the schema.
  • Restored the full CategoryViewInterface field table.

What's New highlights

whatsnew
Updated the Catalog Service categories query with the position field and corrected category field descriptions.

- 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.
@meker12 meker12 changed the base branch from main to meker12-patch-1 May 27, 2026 15:56
@meker12 meker12 merged commit ece20b8 into meker12-patch-1 May 27, 2026
24 checks passed
@meker12 meker12 deleted the DATA-7189-cs-categories-position-field branch May 27, 2026 15:56
@github-project-automation github-project-automation Bot moved this from 📋 Needs Review to 🏁 Done in Commerce - Pull Requests May 27, 2026
@meker12 meker12 changed the title Enhance GraphQL category and product view documentation DATA-7189: Update categories query with position field and improve descriptions May 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 🏁 Done

Development

Successfully merging this pull request may close these issues.

2 participants