Skip to content

docs: centralize shared REST header requirements via macro - #819

Open
proshoumma wants to merge 2 commits into
Universal-Commerce-Protocol:mainfrom
proshoumma:docs/shared-header-requirements
Open

docs: centralize shared REST header requirements via macro#819
proshoumma wants to merge 2 commits into
Universal-Commerce-Protocol:mainfrom
proshoumma:docs/shared-header-requirements

Conversation

@proshoumma

Copy link
Copy Markdown

Description

The UCP-Agent (and Idempotency-Key) "Specific Header Requirements" was copy-pasted across REST bindings, and the order binding had already drifted to different wording. This PR adds a header_requirements macro as the single source for these bullets, and switches all five bindings to call it.

Docs-only change.

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

Not applicable

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)

Not applicable

@damaz91 damaz91 added the status:needs-triage Signal that the PR is ready for human triage label Sep 10, 2026
@damaz91 damaz91 added documentation Improvements or additions to documentation devops and removed status:needs-triage Signal that the PR is ready for human triage labels Sep 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

devops documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants