Skip to content

feat(schemas): two-tier discriminated union for Format.assets[] items #6163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
bokelley wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat(schemas): two-tier discriminated union for Format.assets[] items #6163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/two-tier-format-assets-discriminator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"adcontextprotocol": minor
---

Restructure `Format.assets[]` oneOf from a flat 16-variant union to a two-tier discriminated union. Outer discriminator on `item_type` ("individual" | "repeatable_group"); inner discriminator on `asset_type` for the 15 individual-asset variants. Adds `discriminator.propertyName` hints at both tiers and direct `required` constraints on each variant so codegen tools (openapi-generator, quicktype) produce proper discriminated-union types. Wire-payload acceptance set is unchanged.
5 changes: 0 additions & 5 deletions scripts/oneof-discriminators.baseline.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,11 +191,6 @@
"variants": 3,
"note": "0:[exemplars] | 1:[evaluator_id] | 2:[agent_url]"
},
"core/format.json##/properties/assets/items/oneOf": {
"kind": "dangerous",
"variants": 16,
"note": "shared-required=[∅]; 0:req=[∅] | 1:req=[∅] | 2:req=[∅] | 3:req=[∅] | 4:req=[∅] | 5:req=[∅] | 6:req=[∅] | 7:req=[∅] | 8:req=[∅] | 9:req=[∅] | 10:req=[∅] | 11:req=[∅] | 12:req=[∅] | 13:req=[∅] | 14:req=[∅] | 15:req=[item_type,asset_group_id,required,min_count,max_count,assets]"
},
"core/format.json##/properties/renders/items/oneOf": {
"kind": "narrowable",
"variants": 2,
Expand Down
317 changes: 172 additions & 145 deletions static/schemas/source/core/format.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,154 +205,181 @@
"type": "array",
"description": "Array of all assets supported for this format. Each asset is identified by its asset_id, which must be used as the key in creative manifests. Use the 'required' boolean on each asset to indicate whether it's mandatory.",
"items": {
"discriminator": { "propertyName": "item_type" },
"oneOf": [
{
"title": "IndividualImageAsset",
"description": "Image asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "image" },
"requirements": { "$ref": "/schemas/core/requirements/image-asset-requirements.json" }
}
},
{
"title": "IndividualVideoAsset",
"description": "Video asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "video" },
"requirements": { "$ref": "/schemas/core/requirements/video-asset-requirements.json" }
}
},
{
"title": "IndividualAudioAsset",
"description": "Audio asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "audio" },
"requirements": { "$ref": "/schemas/core/requirements/audio-asset-requirements.json" }
}
},
{
"title": "IndividualTextAsset",
"description": "Text asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "text" },
"requirements": { "$ref": "/schemas/core/requirements/text-asset-requirements.json" }
}
},
{
"title": "IndividualMarkdownAsset",
"description": "Markdown asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "markdown" },
"requirements": { "$ref": "/schemas/core/requirements/markdown-asset-requirements.json" }
}
},
{
"title": "IndividualHtmlAsset",
"description": "HTML asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "html" },
"requirements": { "$ref": "/schemas/core/requirements/html-asset-requirements.json" }
}
},
{
"title": "IndividualCssAsset",
"description": "CSS asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "css" },
"requirements": { "$ref": "/schemas/core/requirements/css-asset-requirements.json" }
}
},
{
"title": "IndividualJavaScriptAsset",
"description": "JavaScript asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "javascript" },
"requirements": { "$ref": "/schemas/core/requirements/javascript-asset-requirements.json" }
}
},
{
"title": "IndividualZipAsset",
"description": "Zip-bundled asset (HTML5 banner bundles, etc.)",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "zip" }
}
},
{
"title": "IndividualVastAsset",
"description": "VAST asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "vast" },
"requirements": { "$ref": "/schemas/core/requirements/vast-asset-requirements.json" }
}
},
{
"title": "IndividualDaastAsset",
"description": "DAAST asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "daast" },
"requirements": { "$ref": "/schemas/core/requirements/daast-asset-requirements.json" }
}
},
{
"title": "IndividualUrlAsset",
"description": "URL asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "url" },
"requirements": { "$ref": "/schemas/core/requirements/url-asset-requirements.json" }
}
},
{
"title": "IndividualWebhookAsset",
"description": "Webhook asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "webhook" },
"requirements": { "$ref": "/schemas/core/requirements/webhook-asset-requirements.json" }
}
},
{
"title": "IndividualBriefAsset",
"description": "Brief asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "brief" }
}
},
{
"title": "IndividualCatalogAsset",
"description": "Catalog asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"type": "object",
"description": "Individual asset slot",
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "catalog" },
"requirements": { "$ref": "/schemas/core/requirements/catalog-requirements.json" }
}
"item_type": { "type": "string", "const": "individual" }
},
"required": ["item_type"],
"discriminator": { "propertyName": "asset_type" },
"oneOf": [
{
"title": "IndividualImageAsset",
"description": "Image asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "image" },
"requirements": { "$ref": "/schemas/core/requirements/image-asset-requirements.json" }
},
"required": ["asset_type"]
},
{
"title": "IndividualVideoAsset",
"description": "Video asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "video" },
"requirements": { "$ref": "/schemas/core/requirements/video-asset-requirements.json" }
},
"required": ["asset_type"]
},
{
"title": "IndividualAudioAsset",
"description": "Audio asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "audio" },
"requirements": { "$ref": "/schemas/core/requirements/audio-asset-requirements.json" }
},
"required": ["asset_type"]
},
{
"title": "IndividualTextAsset",
"description": "Text asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "text" },
"requirements": { "$ref": "/schemas/core/requirements/text-asset-requirements.json" }
},
"required": ["asset_type"]
},
{
"title": "IndividualMarkdownAsset",
"description": "Markdown asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "markdown" },
"requirements": { "$ref": "/schemas/core/requirements/markdown-asset-requirements.json" }
},
"required": ["asset_type"]
},
{
"title": "IndividualHtmlAsset",
"description": "HTML asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "html" },
"requirements": { "$ref": "/schemas/core/requirements/html-asset-requirements.json" }
},
"required": ["asset_type"]
},
{
"title": "IndividualCssAsset",
"description": "CSS asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "css" },
"requirements": { "$ref": "/schemas/core/requirements/css-asset-requirements.json" }
},
"required": ["asset_type"]
},
{
"title": "IndividualJavaScriptAsset",
"description": "JavaScript asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "javascript" },
"requirements": { "$ref": "/schemas/core/requirements/javascript-asset-requirements.json" }
},
"required": ["asset_type"]
},
{
"title": "IndividualZipAsset",
"description": "Zip-bundled asset (HTML5 banner bundles, etc.)",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "zip" }
},
"required": ["asset_type"]
},
{
"title": "IndividualVastAsset",
"description": "VAST asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "vast" },
"requirements": { "$ref": "/schemas/core/requirements/vast-asset-requirements.json" }
},
"required": ["asset_type"]
},
{
"title": "IndividualDaastAsset",
"description": "DAAST asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "daast" },
"requirements": { "$ref": "/schemas/core/requirements/daast-asset-requirements.json" }
},
"required": ["asset_type"]
},
{
"title": "IndividualUrlAsset",
"description": "URL asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "url" },
"requirements": { "$ref": "/schemas/core/requirements/url-asset-requirements.json" }
},
"required": ["asset_type"]
},
{
"title": "IndividualWebhookAsset",
"description": "Webhook asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "webhook" },
"requirements": { "$ref": "/schemas/core/requirements/webhook-asset-requirements.json" }
},
"required": ["asset_type"]
},
{
"title": "IndividualBriefAsset",
"description": "Brief asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "brief" }
},
"required": ["asset_type"]
},
{
"title": "IndividualCatalogAsset",
"description": "Catalog asset",
"allOf": [{ "$ref": "#/$defs/baseIndividualAsset" }],
"properties": {
"item_type": { "const": "individual" },
"asset_type": { "const": "catalog" },
"requirements": { "$ref": "/schemas/core/requirements/catalog-requirements.json" }
},
"required": ["asset_type"]
}
]
},
{
"title": "RepeatableGroupAsset",
Expand Down
Loading