Vadyl
Product surfaces

Compiled APIs

REST, GraphQL SDL + executor, gRPC, OpenAPI, MCP, typed SDKs — one product model.

This page is the documentation contract for the Compiled APIs 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

  • Compiled APIs owns the canonical product-facing contract described here; provider-specific machinery stays behind capability declarations.
  • REST, GraphQL SDL + executor, gRPC, OpenAPI, MCP, typed SDKs — one product model.
  • 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 Compiled APIs appears through REST, OpenAPI, GraphQL, gRPC, SDK, CLI, MCP, dashboard, webhooks, realtime, and events.
IApiOperationDispatcherCanonical owner for Compiled APIs; downstream surfaces derive from this rather than inventing their own truth.
ContractProjectionDescriptorProjects Compiled APIs from canonical project state into every caller-visible contract.
ProjectCapabilitySurfaceManifestPlaces Compiled APIs 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
        Entity/api/Entity16
        POST /
        POST {entityName}
        GET {entityName}/{id}
        POST {entityName}/{id}/restore

        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.
        SDKentities.<Entity>list, read, create, update, upsert, delete, count, exists, alternate-key, batch, subscribe. Rendered methods: 10.
        CLIvadyl sdkGenerate / inspect language SDKs. Rendered commands: 3.
        CLIvadyl statusHealth and version. Rendered commands: 3.

        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": "api-surface",
  "publicationVersion": 412,
  "explain": true
}

        Limits and quotas

          Error model

          ErrorMeaning

          Observability and explainability

            Related references

            Previous
            Full surface atlas
            Next
            Exposure bindings