Documentation
¶
Index ¶
- type APIDocResponse
- type AuthLoginResponse
- type AuthLoginState
- type AuthLoginStateResponse
- type AuthStatusResponse
- type BuildStatusRequest
- type BuildStatusResponse
- type BuildTriggerRequest
- type BuildTriggerResponse
- type CreateSessionResponse
- type DatasourcesResponse
- type ExecuteRequest
- type ExecuteResponse
- type ListResourcesResponse
- type ListSessionsResponse
- type ProxyAuthMetadataResponse
- type ResourceInfo
- type ResourceResponse
- type ResourceTemplateInfo
- type RuntimeStorageFile
- type RuntimeStorageListResponse
- type RuntimeStorageURLResponse
- type RuntimeStorageUploadResponse
- type SearchConstantResult
- type SearchEIPResult
- type SearchEIPsResponse
- type SearchExampleResult
- type SearchExamplesResponse
- type SearchRunbookResult
- type SearchRunbooksResponse
- type SearchSpecResult
- type SearchSpecsResponse
- type SessionResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIDocResponse ¶
type APIDocResponse struct {
Library string `json:"library"`
Description string `json:"description"`
Modules map[string]types.ModuleDoc `json:"modules"`
}
APIDocResponse is the response for the python://ethpandaops resource.
type AuthLoginResponse ¶ added in v0.37.0
type AuthLoginResponse struct {
Enabled bool `json:"enabled"`
VerificationURI string `json:"verification_uri,omitempty"`
VerificationURIComplete string `json:"verification_uri_complete,omitempty"`
UserCode string `json:"user_code,omitempty"`
ExpiresIn int `json:"expires_in,omitempty"`
Interval int `json:"interval,omitempty"`
}
AuthLoginResponse is returned when a device-authorization login is started. Only the user-facing verification details are exposed; the device code is retained server-side and exchanged for tokens by the server's poller.
type AuthLoginState ¶ added in v0.37.0
type AuthLoginState string
AuthLoginState is the state of an in-flight device-authorization login.
const ( // AuthLoginPending means the user has not yet approved the device login. AuthLoginPending AuthLoginState = "pending" // AuthLoginAuthenticated means the login completed and tokens were stored. AuthLoginAuthenticated AuthLoginState = "authenticated" // AuthLoginError means the login failed (denied, expired, or provider error). AuthLoginError AuthLoginState = "error" // AuthLoginNone means no login is in flight. AuthLoginNone AuthLoginState = "none" )
type AuthLoginStateResponse ¶ added in v0.37.0
type AuthLoginStateResponse struct {
State AuthLoginState `json:"state"`
Error string `json:"error,omitempty"`
}
AuthLoginStateResponse reports progress of an in-flight device login so the CLI can poll for completion.
type AuthStatusResponse ¶ added in v0.37.0
type AuthStatusResponse struct {
Enabled bool `json:"enabled"`
Authenticated bool `json:"authenticated"`
IssuerURL string `json:"issuer_url,omitempty"`
ClientID string `json:"client_id,omitempty"`
Resource string `json:"resource,omitempty"`
ExpiresAt *time.Time `json:"expires_at,omitempty"`
Expired bool `json:"expired"`
RefreshTokenPresent bool `json:"refresh_token_present"`
RefreshTokenIssuedAt *time.Time `json:"refresh_token_issued_at,omitempty"`
CredentialsPath string `json:"credentials_path,omitempty"`
}
AuthStatusResponse reports the server's credential state. It deliberately carries no tokens — the access and refresh tokens never leave the server.
type BuildStatusRequest ¶ added in v0.22.0
type BuildStatusRequest struct {
RunID int64 `json:"run_id"`
}
BuildStatusRequest is the request for POST /api/v1/build/status.
type BuildStatusResponse ¶ added in v0.22.0
type BuildStatusResponse struct {
RunID int64 `json:"run_id"`
Status string `json:"status"`
Conclusion string `json:"conclusion"`
HTMLURL string `json:"html_url"`
}
BuildStatusResponse is the response from POST /api/v1/build/status.
type BuildTriggerRequest ¶ added in v0.22.0
type BuildTriggerRequest struct {
// Client is the client name (e.g. "geth", "lighthouse", "prysm").
Client string `json:"client"`
// Repository is the source repository override (optional).
Repository string `json:"repository,omitempty"`
// Ref is the branch, tag, or SHA to build from (optional).
Ref string `json:"ref,omitempty"`
// DockerTag is the target docker tag override (optional).
DockerTag string `json:"docker_tag,omitempty"`
}
BuildTriggerRequest is the request for POST /api/v1/build/trigger.
type BuildTriggerResponse ¶ added in v0.22.0
type BuildTriggerResponse struct {
// WorkflowURL is the URL to the GitHub Actions workflow page.
WorkflowURL string `json:"workflow_url"`
// Client is the client that was built.
Client string `json:"client"`
// Workflow is the workflow filename that was triggered.
Workflow string `json:"workflow"`
// RunID is the GitHub Actions run ID (0 if not yet available).
RunID int64 `json:"run_id,omitempty"`
// RunURL is the direct URL to the specific workflow run.
RunURL string `json:"run_url,omitempty"`
}
BuildTriggerResponse is the response from POST /api/v1/build/trigger.
type CreateSessionResponse ¶
type DatasourcesResponse ¶
type DatasourcesResponse struct {
Datasources []types.DatasourceInfo `json:"datasources"`
}
type ExecuteRequest ¶
type ExecuteResponse ¶
type ExecuteResponse struct {
Stdout string `json:"stdout,omitempty"`
Stderr string `json:"stderr,omitempty"`
ExitCode int `json:"exit_code"`
ExecutionID string `json:"execution_id"`
OutputFiles []string `json:"output_files,omitempty"`
Metrics map[string]any `json:"metrics,omitempty"`
DurationSeconds float64 `json:"duration_seconds"`
SessionID string `json:"session_id,omitempty"`
SessionFiles []sandbox.SessionFile `json:"session_files,omitempty"`
SessionTTLRemaining string `json:"session_ttl_remaining,omitempty"`
}
type ListResourcesResponse ¶ added in v0.5.0
type ListResourcesResponse struct {
Resources []ResourceInfo `json:"resources"`
Templates []ResourceTemplateInfo `json:"templates,omitempty"`
}
ListResourcesResponse is the response for GET /api/v1/resources.
type ListSessionsResponse ¶
type ListSessionsResponse struct {
Sessions []SessionResponse `json:"sessions"`
Total int `json:"total"`
MaxSessions int `json:"max_sessions"`
}
type ResourceInfo ¶ added in v0.5.0
type ResourceInfo struct {
URI string `json:"uri"`
Name string `json:"name"`
Description string `json:"description,omitempty"`
MIMEType string `json:"mime_type,omitempty"`
}
ResourceInfo describes a single static resource.
type ResourceResponse ¶
type ResourceTemplateInfo ¶ added in v0.5.0
type ResourceTemplateInfo struct {
URITemplate string `json:"uri_template"`
Name string `json:"name"`
Description string `json:"description,omitempty"`
MIMEType string `json:"mime_type,omitempty"`
}
ResourceTemplateInfo describes a resource template with URI parameters.
type RuntimeStorageFile ¶
type RuntimeStorageListResponse ¶
type RuntimeStorageListResponse struct {
Files []RuntimeStorageFile `json:"files"`
}
type SearchConstantResult ¶ added in v0.21.0
type SearchConstantResult struct {
Name string `json:"name"`
Value string `json:"value"`
Fork string `json:"fork"`
SimilarityScore float64 `json:"similarity_score"`
}
SearchConstantResult represents a single spec constant search result.
type SearchEIPResult ¶ added in v0.12.0
type SearchEIPResult struct {
Number int `json:"number"`
Title string `json:"title"`
Description string `json:"description"`
Author string `json:"author,omitempty"`
Status string `json:"status"`
Type string `json:"type"`
Category string `json:"category,omitempty"`
Created string `json:"created,omitempty"`
URL string `json:"url"`
Ref string `json:"ref"`
SimilarityScore float64 `json:"similarity_score"`
}
type SearchEIPsResponse ¶ added in v0.12.0
type SearchEIPsResponse struct {
Type string `json:"type"`
Query string `json:"query"`
StatusFilter string `json:"status_filter,omitempty"`
CategoryFilter string `json:"category_filter,omitempty"`
TypeFilter string `json:"type_filter,omitempty"`
TotalMatches int `json:"total_matches"`
Results []*SearchEIPResult `json:"results"`
AvailableStatuses []string `json:"available_statuses"`
AvailableCategories []string `json:"available_categories"`
AvailableTypes []string `json:"available_types"`
}
type SearchExampleResult ¶
type SearchExampleResult struct {
CategoryKey string `json:"category_key"`
CategoryName string `json:"category_name"`
ExampleName string `json:"example_name"`
Description string `json:"description"`
Query string `json:"query"`
Target string `json:"target"`
Dataset string `json:"dataset,omitempty"`
SimilarityScore float64 `json:"similarity_score"`
}
type SearchExamplesResponse ¶
type SearchExamplesResponse struct {
Type string `json:"type"`
Query string `json:"query"`
CategoryFilter string `json:"category_filter,omitempty"`
DatasetFilter string `json:"dataset_filter,omitempty"`
TotalMatches int `json:"total_matches"`
Results []*SearchExampleResult `json:"results"`
AvailableCategories []string `json:"available_categories"`
Guidance []string `json:"guidance,omitempty"`
}
type SearchRunbookResult ¶
type SearchRunbooksResponse ¶
type SearchSpecResult ¶ added in v0.21.0
type SearchSpecResult struct {
Fork string `json:"fork"`
Topic string `json:"topic"`
Title string `json:"title"`
URL string `json:"url"`
Ref string `json:"ref"`
SimilarityScore float64 `json:"similarity_score"`
}
SearchSpecResult represents a single consensus spec search result.
type SearchSpecsResponse ¶ added in v0.21.0
type SearchSpecsResponse struct {
Type string `json:"type"`
Query string `json:"query"`
ForkFilter string `json:"fork_filter,omitempty"`
TotalMatches int `json:"total_matches"`
Specs []*SearchSpecResult `json:"specs"`
Constants []*SearchConstantResult `json:"constants,omitempty"`
AvailableForks []string `json:"available_forks"`
}
SearchSpecsResponse is the response for consensus spec search.