Skip to content

docs: add schema links to preview_creative reference#1777

Merged
bokelley merged 2 commits into
mainfrom
EmmaLouise2018/preview-creative-schemas
Mar 31, 2026
Merged

docs: add schema links to preview_creative reference#1777
bokelley merged 2 commits into
mainfrom
EmmaLouise2018/preview-creative-schemas

Conversation

@EmmaLouise2018

Copy link
Copy Markdown
Contributor

Summary

  • Adds Request Schema and Response Schema links to the preview_creative task reference page
  • Points to the v3 versioned schemas, matching the pattern used by other creative task references (get_creative_delivery, list_creative_formats, etc.)
  • Helps users discover exact enum values, required fields, and output types from the authoritative schema

Test plan

  • npm run build passes
  • All docs navigation tests pass
  • Mintlify link checker finds no broken links
  • Verify schema links resolve on docs site after deploy

Add Request Schema and Response Schema links pointing to the v3
versioned schemas, matching the pattern used by other creative
task references.
@github-actions

github-actions Bot commented Mar 31, 2026

Copy link
Copy Markdown
Contributor

Schema Link Check Results

Commit: 7cff41c - docs: add changeset for preview_creative schema links

⚠️ Warnings (schema not yet released)

These schemas exist in source but haven't been released yet. The links will be broken until the next version is published:

  • https://adcontextprotocol.org/schemas/v3/compliance/comply-test-controller-request.json
    • Schema exists in latest (source) but not yet released in v3
    • Action: This link will work after next 3.x release is published
  • https://adcontextprotocol.org/schemas/v3/compliance/comply-test-controller-response.json
    • Schema exists in latest (source) but not yet released in v3
    • Action: This link will work after next 3.x release is published
  • https://adcontextprotocol.org/schemas/v3/enums/si-session-status.json
    • Schema exists in latest (source) but not yet released in v3
    • Action: This link will work after next 3.x release is published

To fix: Either:

  1. Wait for the next release and merge this PR after the release is published
  2. Use latest instead of a version alias if you need the link to work immediately (note: latest is the development version and may change)
  3. Coordinate with maintainers to cut a new release before merging

@bokelley bokelley merged commit 446a625 into main Mar 31, 2026
16 checks passed
@bokelley bokelley deleted the EmmaLouise2018/preview-creative-schemas branch March 31, 2026 21:09
bokelley added a commit that referenced this pull request May 17, 2026
…ore/authorized-agent-base.json (closes #4510) (#4610)

* refactor(adagents): extract shared authorized_agents[*] fields into core/authorized-agent-base.json

Closes #4510. Previously deferred because adcp-client TS codegen
(json-schema-to-typescript) produced broken union types on `allOf+$ref`
patterns. Unblocked by adcp-client#1756 (PRs #1777 / #1783 — pre-merge
pass that flattens `allOf+$ref` siblings before codegen).

Five fields shared across all six authorized_agents[*] variants — url,
authorized_for, signing_keys, encryption_keys, last_updated — move into
core/authorized-agent-base.json. Each variant now allOfs the base
alongside its variant-specific properties.

Discriminator-specific fields (authorization_type const + the variant
selector) and property-variant qualifiers (collections, placement_ids,
placement_tags, delegation_type, exclusive, countries, effective_*)
stay at the variant root so audit-oneof's discriminator detection keeps
working.

No semantic change — the bundled schema permits the same inputs.
Existing files validate unchanged.

Codegen verified:
- Python (datamodel-codegen): clean inheritance,
  AuthorizedAgents1..6(AuthorizedAgentBase). Field duplication across
  six variants eliminated.
- TS (json-schema-to-typescript): adcp-client's just-shipped pre-merge
  pass handles allOf+$ref. End-to-end verification after they regen.

Drift prevention: adding a new shared field requires one schema edit
instead of six (cf. last_updated in PR #4504, which had to be added
six times).

Tests:
- audit-oneof --check: ok (37 -> 39 discriminated; new base classified
  cleanly).
- composed-schema-validation: 43/43 pass.
- example-validation: 14/14 adagents-relevant pass.
- Bundled schemas include the new base file.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* docs(adagents): neutralize base-schema descriptions per protocol-review

Expert review on PR #4610. Protocol expert's only should-fix:

Pre-refactor, signal_ids/signal_tags variants had distinct prose for
url + authorized_for ("authorized signals agent's API endpoint URL" /
"what signals this agent is authorized to resell"). The first-cut base
collapsed those into property-flavored descriptions, leaving signal-side
codegen docstrings reading wrong.

Neutralized the base-level descriptions to fit both audiences:
- url: refer to registries generically ("sales-agent list, signal-
  provider registry, TMP provider lookup") instead of just TMP/property.
- authorized_for: name both inflections (sells / provides) and pin the
  variant choice as the discriminator.

Plus code-reviewer's nit: dropped "(4 property + 2 signal)" count from
the base description — phrasing was prone to staleness if a 7th
variant lands.

audit-oneof, composed-schema-validation, build all unchanged (39
discriminated; 43/43 tests pass).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants