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

AuthorityRole
ExposureBindingDescriptorDefines how Installable surfaces appears through REST, OpenAPI, GraphQL, gRPC, SDK, CLI, MCP, dashboard, webhooks, realtime, and events.
IApiOperationDispatcherCanonical owner for Installable surfaces; downstream surfaces derive from this rather than inventing their own truth.
ContractProjectionDescriptorProjects Installable surfaces from canonical project state into every caller-visible contract.
ProjectCapabilitySurfaceManifestPlaces Installable surfaces inside the UCSA taxonomy and enforces binding, grants, conformance, and consumption.

Projection coverage

Surface kindsWireSurface, OperationProjectionSurface, SdkSurface, CommandSurface, ToolSurface, UiProjectionSurface
Projection facetsOperations, Cli, ExposureBindings
ProtocolsRest, OpenApi, GraphQL, Grpc, Sdk, Cli, Mcp, Dashboard
Public projectionsREST; 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.

        ControllerBase routeEndpoint countExamples
        Operation/api/Operation2
        POST Execute
        POST Plan
        ContractProjection/api/ContractProjection4
        GET descriptor
        GET {language}/declarations
        GET cli
        GET events
        Sdk/api/Sdk3
        POST generate
        GET languages
        GET versioning
        Surface/api/Surface9
        GET /
        GET {id}
        GET {id}/is-installed
        POST /
        RuntimeFabric/api/RuntimeFabric and /api/PlatformRuntimeFabric35
        GET {projectId}/fabric
        GET {projectId}/realization/{projectEnvironmentId}
        GET {projectId}/health/{projectEnvironmentId}
        GET {projectId}/topology
        PlaneCapabilityGraph/api/PlaneCapabilityGraph2
        GET descriptor
        GET nodes/{kind}
        Usage/api/Usage7
        GET {projectId}/events
        GET {projectId}/rollups
        GET {projectId}/quotas
        POST {projectId}/quotas

        SDK and CLI surface

        ProjectionNamespace / groupCoverage
        SDKplatformprovider health/capabilities, runtime fabric scaling, distribution, version governance, data portability. Rendered methods: 12.
        SDKmcptoken issuance, exposure descriptors, tool invocation, resources, prompts. Rendered methods: 6.
        SDKsurfacespublish, validate, describe, install, upgrade, grant, consume, invoke, explain, suspend, resume, revoke project capability surfaces. Rendered methods: 10.
        CLIvadyl sdkGenerate / inspect language SDKs. Rendered commands: 3.
        CLIvadyl statusHealth and version. Rendered commands: 3.
        CLIvadyl surfacePublish, validate, describe, install, upgrade, grant, consume, explain, suspend, resume, and revoke project capability surfaces. Rendered commands: 12.
        CLIvadyl connectorContracts, implementations, bindings, builds, conformance, invocation. Rendered commands: 6.
        CLIvadyl runtime-fabricTopology, 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

          ErrorMeaning

          Observability and explainability

            Related references