COMOPT-2359 Document Private Catalog Views and Restricted Access Keys for GraphQL - #354

Open

meker12 wants to merge 7 commits into

mainfrom

COMOPT-2359-header-updates-for-gated-catalogs

meker12 commented Jul 31, 2026

Contributor

Purpose of this pull request

This pull request documents Private Catalog Views and Restricted Access Keys for the Merchandising API, a new gated-catalog capability in Adobe Commerce Optimizer. It explains how Catalog Protection and Restricted Access Keys work, how clients authenticate with a signed JWT in the X-Commerce-Access-Token header, and how to interpret the access-key-invalid GraphQL errors returned when authentication fails. It also adds the corresponding key and token limits, troubleshooting guidance, and updated B2B/multi-channel use cases.

Affected pages

meker12 added 2 commits

July 31, 2026 15:35


          Updates to support restricted keys and private catalog views

5bdb842


          Updates to support restricted keys and private

107e501

catalog views

meker12 self-assigned this

meker12 added the new-topic label

dshevtsov added this to Commerce - Pull Requests

github-project-automation Bot moved this to 📋 Needs Review in Commerce - Pull Requests

github-actions Bot commented Jul 31, 2026

Contributor

🔍 Linter Report

Click to expand full report

═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-07-31T20:55:59.371Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/commerce-services/commerce-services
Skipped Rules:
  - check-frontmatter → src/pages/includes

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

Files to process: 5

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/optimizer/merchandising-services/using-the-api.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 64:451
    Message: Unexpected dead URL `https://experienceleague.adobe.com/en/docs/commerce/optimizer/setup/catalog-view#protect-a-catalog-view`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 64:330
    Message: Unexpected dead URL `https://experienceleague.adobe.com/en/docs/commerce/optimizer/setup/restricted-access-keys`, expected live URL
    Rule: no-dead-urls


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

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

Result: ⚠️  PASSED WITH WARNINGS - No fatal errors

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

This comment was automatically generated by the linter bot.


          Validation fixes

7a831ba

github-actions Bot commented Jul 31, 2026

Contributor

🔍 Linter Report

Click to expand full report

═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-07-31T21:09:48.197Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/commerce-services/commerce-services
Skipped Rules:
  - check-frontmatter → src/pages/includes

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

Files to process: 5

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/optimizer/merchandising-services/using-the-api.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 64:451
    Message: Unexpected dead URL `https://experienceleague.adobe.com/en/docs/commerce/optimizer/setup/catalog-view#protect-a-catalog-view`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 64:330
    Message: Unexpected dead URL `https://experienceleague.adobe.com/en/docs/commerce/optimizer/setup/restricted-access-keys`, expected live URL
    Rule: no-dead-urls


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

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

Result: ⚠️  PASSED WITH WARNINGS - No fatal errors

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

This comment was automatically generated by the linter bot.


          chore: auto-generate contributors

677393d

github-actions Bot commented Jul 31, 2026

Contributor

🔍 Linter Report

Click to expand full report

═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-07-31T22:11:15.252Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/commerce-services/commerce-services
Skipped Rules:
  - check-frontmatter → src/pages/includes

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

Files to process: 5

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/optimizer/merchandising-services/using-the-api.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 64:451
    Message: Unexpected dead URL `https://experienceleague.adobe.com/en/docs/commerce/optimizer/setup/catalog-view#protect-a-catalog-view`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 64:330
    Message: Unexpected dead URL `https://experienceleague.adobe.com/en/docs/commerce/optimizer/setup/restricted-access-keys`, expected live URL
    Rule: no-dead-urls


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

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

Result: ⚠️  PASSED WITH WARNINGS - No fatal errors

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

This comment was automatically generated by the linter bot.

meker12 deployed to github-pages

July 31, 2026 22:41

— with

GitHub Actions View deployment


          Improve authentication info

412365e

github-actions Bot commented Aug 1, 2026

Contributor

🔍 Linter Report

Click to expand full report

═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-08-01T01:55:50.876Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/commerce-services/commerce-services
Skipped Rules:
  - check-frontmatter → src/pages/includes

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

Files to process: 5

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/optimizer/merchandising-services/using-the-api.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 67:204
    Message: Unexpected dead URL `https://experienceleague.adobe.com/en/docs/commerce/optimizer/setup/catalog-view#protect-a-catalog-view`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 67:83
    Message: Unexpected dead URL `https://experienceleague.adobe.com/en/docs/commerce/optimizer/setup/restricted-access-keys`, expected live URL
    Rule: no-dead-urls


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

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

Result: ⚠️  PASSED WITH WARNINGS - No fatal errors

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

This comment was automatically generated by the linter bot.


          Adjust graphic size

0fa03a4

github-actions Bot commented Aug 1, 2026

Contributor

🔍 Linter Report

Click to expand full report

═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-08-01T02:27:47.964Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/commerce-services/commerce-services
Skipped Rules:
  - check-frontmatter → src/pages/includes

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

Files to process: 5

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/optimizer/merchandising-services/using-the-api.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 67:204
    Message: Unexpected dead URL `https://experienceleague.adobe.com/en/docs/commerce/optimizer/setup/catalog-view#protect-a-catalog-view`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 67:83
    Message: Unexpected dead URL `https://experienceleague.adobe.com/en/docs/commerce/optimizer/setup/restricted-access-keys`, expected live URL
    Rule: no-dead-urls


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

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

Result: ⚠️  PASSED WITH WARNINGS - No fatal errors

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

This comment was automatically generated by the linter bot.


          chore: auto-generate contributors

e3f238f

github-actions Bot commented Aug 1, 2026

Contributor

🔍 Linter Report

Click to expand full report

═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-08-01T13:20:56.359Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/commerce-services/commerce-services
Skipped Rules:
  - check-frontmatter → src/pages/includes

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

Files to process: 5

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/optimizer/merchandising-services/using-the-api.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 67:204
    Message: Unexpected dead URL `https://experienceleague.adobe.com/en/docs/commerce/optimizer/setup/catalog-view#protect-a-catalog-view`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 67:83
    Message: Unexpected dead URL `https://experienceleague.adobe.com/en/docs/commerce/optimizer/setup/restricted-access-keys`, expected live URL
    Rule: no-dead-urls


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

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

Result: ⚠️  PASSED WITH WARNINGS - No fatal errors

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

This comment was automatically generated by the linter bot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels