Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions docs/specification/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,16 @@ The top-level structure of a discovery document (`/.well-known/ucp`).

{{ extension_schema_fields('ucp.json#/$defs/discovery_profile', 'reference') }}

### Services
Services define the API surface for a vertical (shopping, common, etc.) with
transport bindings. Each service is keyed by its reverse-domain name
(e.g., `dev.ucp.shopping`) in the discovery profile's `services` object.

{{ extension_schema_fields('ucp.json#/$defs/services', 'reference') }}

#### Service Schema
{{ schema_fields('service_schema', 'reference') }}

### Checkout Response Metadata
The `ucp` object included in checkout responses.

Expand Down
1 change: 1 addition & 0 deletions main.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ def define_env(env):
"spec/schemas/",
"spec/schemas/shopping/",
"spec/schemas/shopping/types/",
"spec/services/",
]

def _load_json_file(entity_name):
Expand Down
5 changes: 5 additions & 0 deletions source/schemas/ucp.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@
"services": {
"type": "object",
"description": "Service definitions keyed by reverse-domain service name.",
"properties": {
"com.example.service": {
"$ref": "../services/service_schema.json"
}
},
"additionalProperties": {"$ref": "../services/service_schema.json"}
},

Expand Down
5 changes: 5 additions & 0 deletions spec/schemas/ucp.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@
"services": {
"type": "object",
"description": "Service definitions keyed by reverse-domain service name.",
"properties": {
"com.example.service": {
"$ref": "../services/service_schema.json"
}
},
"additionalProperties": {
"$ref": "../services/service_schema.json"
}
Expand Down