Skip to content

fix(docs): resolve schemas without bundling to preserve type links#551

Open
dantsai wants to merge 1 commit into
Universal-Commerce-Protocol:mainfrom
dantsai:fix-reference-nested-type-links
Open

fix(docs): resolve schemas without bundling to preserve type links#551
dantsai wants to merge 1 commit into
Universal-Commerce-Protocol:mainfrom
dantsai:fix-reference-nested-type-links

Conversation

@dantsai

@dantsai dantsai commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Description

This corrects links in the specification reference docs, specifically for the Type column.

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

N/A

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)

N/A

@damaz91

damaz91 commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Thanks for this PR! During local verification, I noticed that this change introduces one broken link regression in the generated documentation for the "Catalog Lookup" page.

You can resolve this by updating docs/specification/catalog/lookup.md to target "catalog/lookup" in the macro calls and explicitly rendering the "detail_product" schema at the end of the "Get Product" section.

Example:

From {{ extension_schema_fields('catalog_lookup.json#/$defs/lookup_response', 'catalog') }}
to {{ extension_schema_fields('catalog_lookup.json#/$defs/lookup_response', 'catalog/lookup') }}

@dantsai dantsai force-pushed the fix-reference-nested-type-links branch from 1f45442 to d51323c Compare June 26, 2026 22:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants