feat(schema): add sample render URLs for canonical formats#5734
Draft
bokelley wants to merge 1 commit into
Draft
feat(schema): add sample render URLs for canonical formats#5734bokelley wants to merge 1 commit into
bokelley wants to merge 1 commit into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Draft for working group review.
This PR separates static format examples from buyer-asset previews by adding
sample_render_urlto canonical format declarations and registry publisher summaries. The field is explicitly informational: it points to a rendered example using publisher- or registry-provided sample assets, not buyer-submitted creative assets, and is not a renderer endpoint, validation result, creative approval, or live delivery guarantee.It also makes canonical format cards in the publisher registry clickable. The details dialog shows the existing schematic preview, declaration metadata, canonical parameters, and an
Open sample renderaction whensample_render_urlis published.Why
Canonical format declarations in
adagents.jsonorProduct.format_options[]tell buyers what assets are accepted, but they do not by themselves render buyer assets. The working group discussion pointed toward three separate concepts:sample_render_url: static human-facing rendered example of the unit shape.preview_renderers[]: agents that can render buyer manifests.preview_creative.format_context: context needed to resolveformat_kind+format_option_ref, especially product-local refs.This PR intentionally implements only the first concept and avoids
preview_urlterminology so static examples are not confused with buyer-asset preview.Changes
sample_render_urltoProductFormatDeclaration.sample_render_urlin the registry publisher API summary and OpenAPI spec.sample_render_url.adcontextprotocolchangeset for a 3.2 release line.Validation
Passed:
node --check <publisher-home script>node --test --test-force-exit --test-timeout=30000 tests/placement-catalog-schema.test.cjsnpm run test:schemasnpm run test:openapinpm run typechecknpm run build:schemasnode scripts/check-changeset-protocol-scope.cjs origin/mainnpx --yes @changesets/cli@^2.31.0 status --since=origin/mainnode scripts/check-pr-title.cjs "feat(schema): add sample render URLs for canonical formats"git diff --checkReview agents:
preview_urltosample_render_url.preview_urlwas addressed.preview_urlfallback and added a focus trap for the modal.Known local issue:
registry-brand-setup-route.test.tsmock coverage forisDatabaseInitializedin../../src/db/client.js. The commit was created with--no-verifyafter the targeted checks above passed.Follow-ups
preview_renderers[]/ renderer refs separately from this static sample URL.preview_creativewith canonicalformat_contextforformat_kind+format_option_ref, especially product-local refs.