Skip to content

docs: use versioned schema URLs in docs #155

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

Merged
wry-ry merged 1 commit into from
Feb 6, 2026
+150 −150
Merged

docs: use versioned schema URLs in docs #155

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
22 changes: 11 additions & 11 deletions docs/documentation/schema-authoring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,17 +158,17 @@ by `name` rather than arrays of objects with `name` fields.
```json
{
"capabilities": {
"dev.ucp.shopping.checkout": [{"version": "2026-01-11"}],
"dev.ucp.shopping.fulfillment": [{"version": "2026-01-11"}]
"dev.ucp.shopping.checkout": [{"version": "2026-01-23"}],
"dev.ucp.shopping.fulfillment": [{"version": "2026-01-23"}]
},
"services": {
"dev.ucp.shopping": [
{"version": "2026-01-11", "transport": "rest"},
{"version": "2026-01-11", "transport": "mcp"}
{"version": "2026-01-23", "transport": "rest"},
{"version": "2026-01-23", "transport": "mcp"}
]
},
"payment_handlers": {
"com.google.pay": [{"id": "gpay_1234", "version": "2026-01-11"}]
"com.google.pay": [{"id": "gpay_1234", "version": "2026-01-23"}]
}
}
```
Expand Down Expand Up @@ -204,9 +204,9 @@ Each entity type defines **three variants** for different contexts:
```json
{
"dev.ucp.shopping.fulfillment": [{
"version": "2026-01-11",
"version": "2026-01-23",
"spec": "https://ucp.dev/specification/fulfillment",
"schema": "https://ucp.dev/schemas/shopping/fulfillment.json",
"schema": "https://ucp.dev/2026-01-23/schemas/shopping/fulfillment.json",
"config": {
"supports_multi_group": true
}
Expand All @@ -219,7 +219,7 @@ Each entity type defines **three variants** for different contexts:
```json
{
"dev.ucp.shopping.fulfillment": [{
"version": "2026-01-11",
"version": "2026-01-23",
"config": {
"allows_multi_destination": {"shipping": true}
}
Expand All @@ -233,7 +233,7 @@ Each entity type defines **three variants** for different contexts:
{
"ucp": {
"capabilities": {
"dev.ucp.shopping.fulfillment": [{"version": "2026-01-11"}]
"dev.ucp.shopping.fulfillment": [{"version": "2026-01-23"}]
}
}
}
Expand Down Expand Up @@ -284,9 +284,9 @@ A capability schema defines both payload structure and declaration variants:
```json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://ucp.dev/schemas/shopping/checkout.json",
"$id": "https://ucp.dev/2026-01-23/schemas/shopping/checkout.json",
"name": "dev.ucp.shopping.checkout",
"version": "2026-01-11",
"version": "2026-01-23",
"title": "Checkout",
"description": "Base checkout schema. Extensions compose via allOf.",

Expand Down
18 changes: 9 additions & 9 deletions docs/playground.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ Accept: application/json</pre>
* ------------------------------------------------------------------
*/
const UcpData = {
version: "2026-01-11",
version: "2026-01-23",

inventory: {
"sku_stickers": { title: "UCP Demo Sticker Pack", price: 599, image_url: "https://example.com/images/stickers.jpg" },
Expand All @@ -416,7 +416,7 @@ const UcpData = {
"com.shopify.shop_pay": [
{
id: "shop_pay",
version: "2026-01-11",
version: "2026-01-23",
spec: "https://shopify.dev/docs/agents/checkout/shop-pay-handler",
config_schema: "https://shopify.dev/ucp/shop-pay-handler/2026-01-11/config.json",
instrument_schemas: ["https://shopify.dev/ucp/shop-pay-handler/2026-01-11/instrument.json"],
Expand All @@ -426,7 +426,7 @@ const UcpData = {
"com.google.pay": [
{
id: "gpay",
version: "2026-01-11",
version: "2026-01-23",
spec: "https://pay.google.com/gp/p/ucp/2026-01-11/",
config_schema: "https://pay.google.com/gp/p/ucp/2026-01-11/schemas/config.json",
instrument_schemas: [
Expand Down Expand Up @@ -466,22 +466,22 @@ const UcpData = {
capabilities: {
"dev.ucp.shopping.checkout": [
{
version: "2026-01-11",
version: "2026-01-23",
spec: "https://ucp.dev/specs/checkout",
schema: "https://ucp.dev/schemas/shopping/checkout.json"
}
],
"dev.ucp.shopping.order": [
{
version: "2026-01-11",
version: "2026-01-23",
spec: "https://ucp.dev/specs/order",
schema: "https://ucp.dev/schemas/shopping/order.json"
}
],
"dev.ucp.shopping.fulfillment": [
{
extends: "dev.ucp.shopping.checkout",
version: "2026-01-11",
version: "2026-01-23",
spec: "https://ucp.dev/specs/fulfillment",
schema: "https://ucp.dev/schemas/shopping/fulfillment.json",
config: {
Expand All @@ -499,23 +499,23 @@ const UcpData = {
"dev.ucp.shopping.discount": [
{
extends: "dev.ucp.shopping.checkout",
version: "2026-01-11",
version: "2026-01-23",
spec: "https://ucp.dev/specs/discount",
schema: "https://ucp.dev/schemas/shopping/discount.json"
}
],
"dev.ucp.shopping.buyer_consent": [
{
extends: "dev.ucp.shopping.checkout",
version: "2026-01-11",
version: "2026-01-23",
spec: "https://ucp.dev/specs/buyer_consent",
schema: "https://ucp.dev/schemas/shopping/buyer_consent.json"
}
],
"dev.ucp.shopping.ap2_mandates": [
{
extends: "dev.ucp.shopping.checkout",
version: "2026-01-11",
version: "2026-01-23",
spec: "https://ucp.dev/specs/ap2_mandates",
schema: "https://ucp.dev/schemas/shopping/ap2_mandates.json"
}
Expand Down
8 changes: 4 additions & 4 deletions docs/specification/ap2-mandates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,16 +72,16 @@ Businesses declare support by adding `dev.ucp.shopping.ap2_mandate` to their
"capabilities": {
"dev.ucp.shopping.checkout": [
{
"version": "2026-01-11",
"version": "2026-01-23",
"spec": "https://ucp.dev/specification/checkout",
"schema": "https://ucp.dev/schemas/shopping/checkout.json"
"schema": "https://ucp.dev/2026-01-23/schemas/shopping/checkout.json"
}
],
"dev.ucp.shopping.ap2_mandate": [
{
"version": "2026-01-11",
"version": "2026-01-23",
"spec": "https://ucp.dev/specification/ap2-mandates",
"schema": "https://ucp.dev/schemas/shopping/ap2_mandate.json",
"schema": "https://ucp.dev/2026-01-23/schemas/shopping/ap2_mandate.json",
"extends": "dev.ucp.shopping.checkout",
"config": {
"vp_formats_supported": {
Expand Down
2 changes: 1 addition & 1 deletion docs/specification/buyer-consent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Businesses advertise consent support in their profile:
"capabilities": {
"dev.ucp.shopping.buyer_consent": [
{
"version": "2026-01-11",
"version": "2026-01-23",
"extends": "dev.ucp.shopping.checkout"
}
]
Expand Down
8 changes: 4 additions & 4 deletions docs/specification/checkout-a2a.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ platforms to interact with the business services over A2A Protocol.
```json
{
"ucp": {
"version": "2026-01-11",
"version": "2026-01-23",
"services": {
"dev.ucp.shopping": [
{
"version": "2026-01-11",
"version": "2026-01-23",
"spec": "https://ucp.dev/specification/overview",
"transport": "a2a",
"endpoint": "https://example-business.com/.well-known/agent-card.json"
Expand Down Expand Up @@ -87,11 +87,11 @@ An example:
"params": {
"capabilities": {
"dev.ucp.shopping.checkout": [
{"version": "2026-01-11"}
{"version": "2026-01-23"}
],
"dev.ucp.shopping.fulfillment": [
{
"version": "2026-01-11",
"version": "2026-01-23",
"extends": "dev.ucp.shopping.checkout"
}
]
Expand Down
32 changes: 16 additions & 16 deletions docs/specification/checkout-mcp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,31 +29,31 @@ Businesses advertise MCP transport availability through their UCP profile at
```json
{
"ucp": {
"version": "2026-01-11",
"version": "2026-01-23",
"services": {
"dev.ucp.shopping": [
{
"version": "2026-01-11",
"version": "2026-01-23",
"spec": "https://ucp.dev/specification/overview",
"transport": "mcp",
"schema": "https://ucp.dev/services/shopping/mcp.openrpc.json",
"schema": "https://ucp.dev/2026-01-23/services/shopping/mcp.openrpc.json",
"endpoint": "https://business.example.com/ucp/mcp"
}
]
},
"capabilities": {
"dev.ucp.shopping.checkout": [
{
"version": "2026-01-11",
"version": "2026-01-23",
"spec": "https://ucp.dev/specification/checkout",
"schema": "https://ucp.dev/schemas/shopping/checkout.json"
"schema": "https://ucp.dev/2026-01-23/schemas/shopping/checkout.json"
}
],
"dev.ucp.shopping.fulfillment": [
{
"version": "2026-01-11",
"version": "2026-01-23",
"spec": "https://ucp.dev/specification/fulfillment",
"schema": "https://ucp.dev/schemas/shopping/fulfillment.json",
"schema": "https://ucp.dev/2026-01-23/schemas/shopping/fulfillment.json",
"extends": "dev.ucp.shopping.checkout"
}
]
Expand All @@ -62,7 +62,7 @@ Businesses advertise MCP transport availability through their UCP profile at
"com.example.vendor.delegate_payment": [
{
"id": "handler_1",
"version": "2026-01-11",
"version": "2026-01-23",
"spec": "https://example.vendor.com/specs/delegate-payment",
"schema": "https://example.vendor.com/schemas/delegate-payment-config.json",
"config": {}
Expand Down Expand Up @@ -204,18 +204,18 @@ Maps to the [Create Checkout](checkout.md#create-checkout) operation.
"id": 1,
"result": {
"ucp": {
"version": "2026-01-11",
"version": "2026-01-23",
"capabilities": {
"dev.ucp.shopping.checkout": [
{"version": "2026-01-11"}
{"version": "2026-01-23"}
],
"dev.ucp.shopping.fulfillment": [
{"version": "2026-01-11"}
{"version": "2026-01-23"}
]
},
"payment_handlers": {
"com.example.vendor.delegate_payment": [
{"id": "handler_1", "version": "2026-01-11", "config": {}}
{"id": "handler_1", "version": "2026-01-23", "config": {}}
]
}
},
Expand Down Expand Up @@ -413,18 +413,18 @@ Maps to the [Update Checkout](checkout.md#update-checkout) operation.
"id": 2,
"result": {
"ucp": {
"version": "2026-01-11",
"version": "2026-01-23",
"capabilities": {
"dev.ucp.shopping.checkout": [
{"version": "2026-01-11"}
{"version": "2026-01-23"}
],
"dev.ucp.shopping.fulfillment": [
{"version": "2026-01-11"}
{"version": "2026-01-23"}
]
},
"payment_handlers": {
"com.example.vendor.delegate_payment": [
{"id": "handler_1", "version": "2026-01-11", "config": {}}
{"id": "handler_1", "version": "2026-01-23", "config": {}}
]
}
},
Expand Down
Loading