Skip to content

docs: add description for catalog fulfillment property#588

Closed
carolinerg1 wants to merge 1 commit into
mainfrom
fix/catalog-fulfillment-description
Closed

docs: add description for catalog fulfillment property#588
carolinerg1 wants to merge 1 commit into
mainfrom
fix/catalog-fulfillment-description

Conversation

@carolinerg1

Copy link
Copy Markdown

Description

This change adds an explicit "description" to the Fulfillment property in "source/schemas/shopping/fulfillment.json" under "$defs.fulfillment_variant" and "$defs.fulfillment_lookup_variant".

Fixes an issue where the Properties table in the Fulfillment Extension specification (docs/specification/fulfillment.md), rendered dynamically via the {{ extension_fields(...) }} macro, displayed a blank description for the fulfillment property (Catalog Fulfillment).

Changes

  • Updated source/schemas/shopping/fulfillment.json:
    • Added "description": "Fulfillment options and availability for this variant." to properties.fulfillment within fulfillment_variant.
    • Added "description": "Fulfillment options and availability for this variant." to properties.fulfillment within fulfillment_lookup_variant.

Category (Required)

Please select one or more categories that apply to this change.

  • Core Protocol: Changes to the base communication layer, global context, or breaking refactors. (Requires Technical Council approval)
  • Governance/Contributing: Updates to GOVERNANCE.md, CONTRIBUTING.md, or CODEOWNERS. (Requires Governance Council approval)
  • Capability: New schemas (Discovery, Cart, etc.) or extensions. (Requires Maintainer approval)
  • Documentation: Updates to README, or documentations regarding schema or capabilities. (Requires Maintainer approval)
  • Infrastructure: CI/CD, Linters, or build scripts. (Requires DevOps Maintainer approval)
  • Maintenance: Version bumps, lockfile updates, or minor bug fixes. (Requires DevOps Maintainer approval)
  • SDK: Language-specific SDK updates and releases. (Requires DevOps Maintainer approval)
  • Samples / Conformance: Maintaining samples and the conformance suite. (Requires Maintainer approval)
  • UCP Schema: Changes to the ucp-schema tool (resolver, linter, validator). (Requires Maintainer approval)
  • Community Health (.github): Updates to templates, workflows, or org-level configs. (Requires DevOps Maintainer approval)

Related Issues

Checklist

  • I have followed the Contributing Guide (including Conventional Commits title requirements and ! for breaking changes).
  • I have updated the documentation (if applicable).
  • My changes pass all local linting and formatting checks.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • (For Core/Capability) I have included/updated the relevant JSON schemas.
  • I have regenerated Python Pydantic models by running generate_models.sh under python_sdk.

Screenshots / Logs (if applicable)

Current Fulfillment with blank description:
Catalog Fulfillment - empty description

Updated Fulfillment with a detailed description:
Catalog Fulfillment - empty description fix

@google-cla

google-cla Bot commented Jul 15, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@damaz91 damaz91 added the status:needs-triage Signal that the PR is ready for human triage label Jul 15, 2026
@carolinerg1
carolinerg1 force-pushed the fix/catalog-fulfillment-description branch from f568ccb to 04e7994 Compare July 15, 2026 20:48
@damaz91 damaz91 added documentation Improvements or additions to documentation status:under-review and removed status:needs-triage Signal that the PR is ready for human triage labels Jul 16, 2026
@damaz91

damaz91 commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Great catch @carolinerg1 ! This table is indeed rendered poorly.

I found out that's not caused by something missing in the schema, but rather in the table rendering macro called in the wrong way.

Current: {{ extension_fields('fulfillment', 'fulfillment') }}

Correct: {{ extension_fields('fulfillment', 'checkout') }}

Opened #592 to fix. Thanks again!

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

Labels

documentation Improvements or additions to documentation status:under-review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants