-
Notifications
You must be signed in to change notification settings - Fork 0
API Coverage
goldsky-go implements the complete 40-operation Goldsky REST API v1.2.0 manifest examined by this project. The live OpenAPI specification remains authoritative; the SDK repository contains the full operation-to-method, request, response, and contract-test map in docs/api-coverage.md.1
This page is the human-oriented navigation layer. It groups Go methods by the work developers typically perform.
| Product area | Operations | Primary service |
|---|---|---|
| Turbo Pipelines | 13 | client.Pipelines |
| Subgraphs and Subgraph Webhooks | 16 |
client.Subgraphs, client.Webhooks
|
| Edge endpoints and catalogs | 11 |
client.Edge, client.Catalogs
|
| Total REST operations | 40 | — |
| Capability | Go method | Key input / result |
|---|---|---|
| List | Pipelines.List |
ListPipelinesOptions → Page[Pipeline]
|
| Create | Pipelines.Create |
CreatePipelineRequest → Pipeline
|
| Get | Pipelines.Get |
name → Pipeline
|
| Delete | Pipelines.Delete |
name → error only |
| Validate | Pipelines.Validate |
ValidatePipelineRequest → ValidatePipelineResponse
|
| Preview | Pipelines.Preview |
PreviewPipelineRequest → PreviewPipelineResponse
|
| Pause | Pipelines.Pause |
name → error only |
| Resume | Pipelines.Resume |
name → error only |
| Restart | Pipelines.Restart |
name, optional RestartPipelineRequest → error only |
| Read logs | Pipelines.Logs |
PipelineLogsOptions → PipelineLogsResponse
|
| Read error count | Pipelines.ErrorCount |
name, hours → PipelineErrorCountResponse
|
| Read status | Pipelines.Status |
name → PipelineStatusResponse
|
| Read state | Pipelines.State |
name → raw PipelineStateResponse
|
See Pipelines for authoring and operational guidance.
| Capability | Go method | Key input / result |
|---|---|---|
| List subgraphs | Subgraphs.List |
ListSubgraphsOptions → Page[Subgraph]
|
| Get named subgraph | Subgraphs.Get |
name → Page[Subgraph]
|
| List supported chains |
Subgraphs.SupportedChains / Catalogs.SupportedSubgraphChains
|
→ SubgraphChainsResponse
|
| Get version or tag | Subgraphs.GetVersion |
name, version/tag → Page[Subgraph]
|
| Update version or tag settings | Subgraphs.UpdateVersion |
UpdateSubgraphVersionRequest → Subgraph
|
| Read indexing logs | Subgraphs.Logs |
SubgraphLogsOptions → SubgraphLogsResponse
|
| Pause / resume a version |
Subgraphs.Pause / Subgraphs.Resume
|
name, version → error only |
| Set tag | Subgraphs.SetTag |
SetSubgraphTagRequest → Subgraph
|
| Delete tag | Subgraphs.DeleteTag |
name, tag → error only |
| Delete deployment | Subgraphs.DeleteDeployment |
name, version → error only |
| Deploy bundle | Subgraphs.Deploy |
DeploySubgraphOptions → Subgraph
|
| List webhooks | Webhooks.List |
→ WebhookListResponse
|
| Create webhook | Webhooks.Create |
CreateWebhookRequest → one-time secret response |
| Delete webhook | Webhooks.Delete |
name → error only |
| List webhook entities | Subgraphs.WebhookEntities |
name, version/tag → WebhookEntitiesResponse
|
See Subgraphs and Webhooks for release and receiver patterns.
| Capability | Go method | Key input / result |
|---|---|---|
| List supported Edge networks | Catalogs.EdgeNetworks |
→ EdgeNetworksResponse
|
| List Edge Data sources | Catalogs.EdgeSources |
→ EdgeSourcesResponse
|
| List endpoints | Edge.List |
ListEdgeEndpointsOptions → Page[EdgeEndpoint]
|
| Create endpoint | Edge.Create |
CreateEdgeEndpointRequest → one-time key response |
| Get endpoint | Edge.Get |
name → EdgeEndpoint
|
| Update endpoint | Edge.Update |
UpdateEdgeEndpointRequest → EdgeEndpoint
|
| Delete endpoint | Edge.Delete |
name → error only |
| Pause / resume endpoint |
Edge.Pause / Edge.Resume
|
name → EdgeEndpoint
|
| Reveal endpoint key | Edge.RevealKey |
name → RevealEdgeKeyResponse
|
| Read metrics | Edge.Metrics |
EdgeMetricsOptions → EdgeMetricsResponse
|
See Edge Endpoints for lifecycle and secret-handling guidance.
GraphQL and Edge RPC are separate from the REST manifest, but are first-class SDK services.
| Capability | Go method | Notes |
|---|---|---|
| Build public GraphQL URL | GraphQL.PublicURL |
No credential sent by QueryPublic. |
| Build private GraphQL URL | GraphQL.PrivateURL |
Uses project API token with QueryPrivate. |
| Query arbitrary GraphQL endpoint | GraphQL.Query |
Caller chooses endpoint and whether to authenticate. |
| Query public/private GraphQL |
GraphQL.QueryPublic / GraphQL.QueryPrivate
|
Returns GraphQLResponse; check HasErrors(). |
| Single Edge JSON-RPC call | RPC.Call |
Returns *RPCError for a JSON-RPC method error. |
| Batch Edge JSON-RPC calls | RPC.Batch |
Returns responses in input order; inspect each .Error. |
| Verify webhook secret |
VerifyWebhookSecret / VerifyWebhookRequest
|
Constant-time header-secret comparison. |
The SDK exposes Goldsky REST operations, Subgraph GraphQL, Edge JSON-RPC over HTTPS, and webhook-secret verification. It does not invent a static schema for flexible Turbo pipeline definitions or raw pipeline state, because Goldsky leaves those payloads open. Those areas are represented as map[string]any and json.RawMessage to preserve compatibility as Goldsky evolves.
The SDK also does not provide WebSocket RPC subscriptions because Goldsky Edge RPC documents HTTPS-only transport. See Edge RPC.
When upgrading the library or integrating a new Goldsky capability, compare the current Goldsky OpenAPI source to the repository’s coverage map and contract tests. The live API document can change after this wiki page is published.
curl -sSL https://api.goldsky.com/api/v1/docs/openapi.json \
-o testdata/openapi/openapi.json
go test ./...The repository’s docs/api-coverage.md describes the snapshot maintenance process and names the contract test associated with every REST operation.