Skip to content

- Add product review export attributes to Catalog - #636

Merged
meker12 merged 5 commits into
mainfrom
ACCS-432-api-doc-for-reviews-feature
Oct 29, 2026
Merged

meker12 merged 5 commits into
mainfrom
ACCS-432-api-doc-for-reviews-feature

Conversation

@meker12

@meker12 meker12 commented Oct 29, 2026

Copy link
Copy Markdown
Contributor

Summary

Document the product review summary attributes returned by the Catalog Service products query, and remove the PaaS-only badge from the review ratings queries and mutation.

Related to ACCS-432

Changes

  • Catalog Service products query (catalog-service/queries/products.md)
    • Add a Product review attributes section describing ac_review_count and ac_rating_summary. These are system attributes returned in the attributes field on ProductView, not top-level fields.
    • Explain that the product feed updates when review summaries change, that product reviews are disabled by default, and that only approved reviews contribute to the count and rating summary.
  • Remove the PaaS-only banner from createProductReview mutation and productReviewRatingsMetadata query pages

whatsnew
Updated the products query to add new ac_review_count and ac_rating_summary system attributes, returned in ProductView.attributes when product reviews are enabled. See Product review attributes.

@github-project-automation github-project-automation Bot moved this from 📋 Needs Review to 👍 Approved in Commerce - Pull Requests Oct 29, 2026
@meker12 meker12 self-assigned this Oct 29, 2026
@meker12 meker12 added the technical Changes to code, examples, or technical processes label Oct 29, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-10-29T16:31:23.196Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/commerce-webapi/commerce-webapi
Skipped Rules:
  - check-frontmatter → src/pages/includes
  - missing-heading → src/pages/includes

───────────────────────────────────────────────────────────────

Files to process: 3

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/graphql/schema/catalog-service/queries/products.md
───────────────────────────────────────────────────────────────
  ❌ ERROR
    Location: Line 45:1
    Message: Unescaped opening curly brace "{" found. Use "\{" to escape it.
    Rule: no-unescaped-curly-braces


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    3
  📄 Files with issues:  1
  ❌ Total errors:       1
  ⚠️  Total warnings:     0
  📋 Total issues:       1

Result: ❌ FAILED - Fatal errors found

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

@github-actions

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-10-29T16:35:09.834Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/commerce-webapi/commerce-webapi
Skipped Rules:
  - check-frontmatter → src/pages/includes
  - missing-heading → src/pages/includes

───────────────────────────────────────────────────────────────

Files to process: 3

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/graphql/schema/catalog-service/queries/products.md
───────────────────────────────────────────────────────────────
  ❌ ERROR
    Location: Line 45:1
    Message: Unescaped opening curly brace "{" found. Use "\{" to escape it.
    Rule: no-unescaped-curly-braces


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    3
  📄 Files with issues:  1
  ❌ Total errors:       1
  ⚠️  Total warnings:     0
  📋 Total issues:       1

Result: ❌ FAILED - Fatal errors found

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

Co-authored-by: Kevin Harper <keharper@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-10-29T17:00:43.033Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/commerce-webapi/commerce-webapi
Skipped Rules:
  - check-frontmatter → src/pages/includes
  - missing-heading → src/pages/includes

───────────────────────────────────────────────────────────────

Files to process: 3


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    3
  📄 Files with issues:  0
  ❌ Total errors:       0
  ⚠️  Total warnings:     0
  📋 Total issues:       0

Result: ✅ PASSED - All files passed linting successfully!

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

@meker12
meker12 merged commit d548d80 into main Oct 29, 2026
28 checks passed
@meker12
meker12 deleted the ACCS-432-api-doc-for-reviews-feature branch October 29, 2026 17:53
@github-project-automation github-project-automation Bot moved this from 👍 Approved to 🏁 Done in Commerce - Pull Requests Oct 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

technical Changes to code, examples, or technical processes

Projects

Status: 🏁 Done

Development

Successfully merging this pull request may close these issues.

3 participants