SDK Surface Reference¶
Generated page — do not edit by hand
Rendered by scripts/build_reference_pages.py from the committed
537 contract trinity. Run python scripts/build_reference_pages.py build¶
after changing a source; CI runs check and fails on stale output.
Renders the hordago-contracts field docs and generator pins from templates/surface-template/surface.lock.json. The pydantic (Python) and zod/typescript-fetch clients are generated from one OpenAPI contract, so field docs stay in lock-step across both SDKs.
Generator pins¶
| Target | Package | Pin |
|---|---|---|
| Python (pydantic) | template_service_client |
pydantic >=2.0.0 |
| TypeScript (typescript-fetch) | @template/service-client |
v0.1.0 (openapi-generator 7.15.0) |
Contract models (pydantic / zod)¶
Field docs from templates/surface-template/specs/example.openapi.yaml components.schemas, emitted as pydantic v2 models (templates/surface-template/generated/sdk/python) and the typescript-fetch client:
Item¶
| Field | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | Stable item identifier. |
name |
string |
yes | Human readable item name. |
tags |
array<string> |
no | Optional labels. |
ItemCreate¶
| Field | Type | Required | Description |
|---|---|---|---|
name |
string |
yes | Human readable item name. |
tags |
array<string> |
no | Optional labels. |
ItemList¶
| Field | Type | Required | Description |
|---|---|---|---|
items |
array<Item> |
yes | Returned item records. |
next_cursor |
string | null |
no | Cursor for the next page. |
Contract registry¶
registry/index.json renders as it lands
The full hordago-contracts registry/index.json (42 schemas → pydantic/zod) lives in the standalone hordago-contracts repo. This page renders the committed surface-template contract models today and will fold in the federated registry index once it is checked in / published, keeping the renderer a consumer only (#537).