Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AWSCredentialStatus ¶ added in v0.10.0
type AWSCredentialStatus struct {
Available bool `json:"available"`
Sources []string `json:"sources"`
Error string `json:"error,omitempty"`
} // @name AWSCredentialStatus
AWSCredentialStatus is the response for GET /api/v1/plugins/aws/credentials/status. The UI calls that endpoint while a user configures an AWS-based plugin (S3, Glue, and so on) to show whether the Marmot server already has AWS credentials in its environment: it tells the user up front whether "use default credentials" will work or whether they need to enter keys. The check itself is pluginsdk.DetectAWSCredentials, which walks the same credential chain the AWS plugins use when they connect. This local struct exists so the API response schema is owned here; the SDK type can change shape without silently changing our API.
type ListPluginsResponse ¶ added in v0.10.0
type ListPluginsResponse struct {
Plugins []pluginsdk.Meta `json:"plugins"`
Loading bool `json:"loading"`
} // @name ListPluginsResponse
ListPluginsResponse wraps the registered plugin list with a Loading flag so the UI can render a "plugins still loading" banner while server startup finishes registering them, instead of a misleading "no plugins available" state.