Product surfaces
Installable surfaces
Provider projects publish versioned capability bundles across every plane. Consumer projects install with grants, audit, billing, revocation, and PCG evidence.
This page is the documentation contract for the Installable surfaces surface in Vadyl's final form. It is not a marketing summary: it names the authorities, projections, runtime behavior, examples, limits, errors, and observability expectations that every product implementation must honor.
What this surface owns
- Installable surfaces owns the canonical product-facing contract described here; provider-specific machinery stays behind capability declarations.
- Provider projects publish versioned capability bundles across every plane. Consumer projects install with grants, audit, billing, revocation, and PCG evidence.
- The final docs treat this as complete: REST, GraphQL, gRPC, SDK, CLI, MCP, dashboard, observability, limits, errors, and explainability are all covered as projections of one authority.
Canonical authorities
| Authority | Role |
|---|---|
ExposureBindingDescriptor | Defines how Installable surfaces appears through REST, OpenAPI, GraphQL, gRPC, SDK, CLI, MCP, dashboard, webhooks, realtime, and events. |
IApiOperationDispatcher | Canonical owner for Installable surfaces; downstream surfaces derive from this rather than inventing their own truth. |
ContractProjectionDescriptor | Projects Installable surfaces from canonical project state into every caller-visible contract. |
ProjectCapabilitySurfaceManifest | Places Installable surfaces inside the UCSA taxonomy and enforces binding, grants, conformance, and consumption. |
Projection coverage
| Surface kinds | WireSurface, OperationProjectionSurface, SdkSurface, CommandSurface, ToolSurface, UiProjectionSurface |
| Projection facets | Operations, Cli, ExposureBindings |
| Protocols | Rest, OpenApi, GraphQL, Grpc, Sdk, Cli, Mcp, Dashboard |
| Public projections | REST; OpenAPI; GraphQL; gRPC; SDK; CLI; MCP; dashboard actions; webhooks; realtime |
Project-scope parity
Publish, install, consume
Consumption evidence
Runtime behavior
- thin controller dispatch
- operation projection
- descriptor hash validation
- grant-set enforcement
REST and controller surface
Code-backed controllers are listed here so the docs menu does not hide the real endpoint surface. The complete route-by-route table remains in the REST controller atlas.
| Controller | Base route | Endpoint count | Examples |
|---|---|---|---|
| Operation | /api/Operation | 2 | POST ExecutePOST Plan |
| ContractProjection | /api/ContractProjection | 4 | GET descriptorGET {language}/declarationsGET cliGET events |
| Sdk | /api/Sdk | 3 | POST generateGET languagesGET versioning |
| Surface | /api/Surface | 9 | GET /GET {id}GET {id}/is-installedPOST / |
| RuntimeFabric | /api/RuntimeFabric and /api/PlatformRuntimeFabric | 35 | GET {projectId}/fabricGET {projectId}/realization/{projectEnvironmentId}GET {projectId}/health/{projectEnvironmentId}GET {projectId}/topology |
| PlaneCapabilityGraph | /api/PlaneCapabilityGraph | 2 | GET descriptorGET nodes/{kind} |
| Usage | /api/Usage | 7 | GET {projectId}/eventsGET {projectId}/rollupsGET {projectId}/quotasPOST {projectId}/quotas |
SDK and CLI surface
| Projection | Namespace / group | Coverage |
|---|---|---|
| SDK | platform | provider health/capabilities, runtime fabric scaling, distribution, version governance, data portability. Rendered methods: 12. |
| SDK | mcp | token issuance, exposure descriptors, tool invocation, resources, prompts. Rendered methods: 6. |
| SDK | surfaces | publish, validate, describe, install, upgrade, grant, consume, invoke, explain, suspend, resume, revoke project capability surfaces. Rendered methods: 10. |
| CLI | vadyl sdk | Generate / inspect language SDKs. Rendered commands: 3. |
| CLI | vadyl status | Health and version. Rendered commands: 3. |
| CLI | vadyl surface | Publish, validate, describe, install, upgrade, grant, consume, explain, suspend, resume, and revoke project capability surfaces. Rendered commands: 12. |
| CLI | vadyl connector | Contracts, implementations, bindings, builds, conformance, invocation. Rendered commands: 6. |
| CLI | vadyl runtime-fabric | Topology, scaling, resources, ingress, realization, health, binding, deployment plans, reconcile, drain. Rendered commands: 15. |
Input request and output
POST /api/Operation/Execute HTTP/1.1
Host: api.vadyl.app
Authorization: Bearer $VADYL_TOKEN
X-Vadyl-Tenant: acme
X-Vadyl-Project: billing
Content-Type: application/json
{
"surface": "installable-surfaces",
"publicationVersion": 412,
"explain": true
}Limits and quotas
Error model
| Error | Meaning |
|---|