Skip to content

Surface Matrix

This matrix classifies exported service.Platform methods across the local CLI, REST operator, and GraphQL operator surfaces. Internal means the method is a helper used by adapters or tests and should not be exposed directly.

Platform methodCLIRESTGraphQLOmit reason
RootInternalInternalInternalAdapter helper.
LoadStackInternalInternalInternalFile-loading primitive; callers expose specific operations.
EmptyStackInternalInternalInternalConstruction helper for stack init/tests.
StackInitYesYesYes-
StackTemplateQuestionsYesNoNoInteractive local prompt flow.
StackUpdateYesYesYes-
StackDestroyYesYesYes-
StackPrepareYesYesYes-
StackCompileYesNoNoInternal compile flow; remote surfaces use StackPrepare.
StackStatusYesYesYes-
StackBuildYesYesYes-
StackUpYesYesYes-
StackUpForegroundYesNoNoLocal-only streaming process.
StackDevYesYesYesRemote adapter calls non-foreground runtime flow.
StackDevForegroundYesNoNoLocal-only streaming process.
StackDownYesYesYes-
StackLogsYesYesNoGraphQL uses bounded StackLogsLimited.
StackLogsLimitedNoNoYesGraphQL snapshot guardrail.
ServiceInitYesYesYes-
ServiceUpdateYesYesYes-
ServiceDestroyYesYesYes-
ServiceListYesYesYes-
ServiceStartYesYesYes-
ServiceStopYesYesYes-
ServiceRestartYesYesYes-
JobListYesYesYes-
JobRunYesYesYes-
SourceListYesYesYes-
SourceFetchYesYesYes-
SourceStatusYesYesYes-
SourcePullYesYesYes-
SourcePushYesYesYes-
WorkspaceCreateYesYesYes-
WorkspaceListYesYesYes-
WorkspaceGetYesYesYes-
WorkspaceStatusYesYesYes-
WorkspaceUpdateYesYesYes-
WorkspaceDestroyYesYesYes-
WorkspaceLogsYesYesNoGraphQL uses bounded WorkspaceLogsLimited.
WorkspaceLogsLimitedNoNoYesGraphQL snapshot guardrail.
WorkspaceStartYesYesYes-
WorkspaceStopYesYesYes-
WorkspaceGitStatusYesYesYes-
WorkspacePushYesYesYes-
WorkspaceSyncBaseYesYesYes-
GitOpsTopologyNoNoYesGap: currently GraphQL-only topology view.
WorkspaceSourceFetchNoNoYesGap: currently GraphQL-only per-workspace source operation.
WorkspaceSourcePullNoNoYesGap: currently GraphQL-only per-workspace source operation.
WorkspaceSourcePushNoNoYesGap: currently GraphQL-only per-workspace source operation.

When adding a new exported Platform method, update this table in the same change. internal/service/surface_matrix_test.go verifies that every exported method is classified here.

Released under the AGPL-3.0 License.