Documentation
¶
Overview ¶
Package generated contains Go types auto-generated from the DevHelm OpenAPI spec.
DO NOT EDIT — regenerate with: make typegen
This file is a bootstrap placeholder that matches what oapi-codegen would produce from docs/openapi/monitoring-api.json. Once oapi-codegen runs against the real spec it replaces this file entirely.
Required (always-present) response fields → value types. Nullable / optional fields → pointer types. JSON tags match the API's camelCase convention.
Index ¶
- type AddMonitorTagsRequest
- type AddResourceGroupMemberRequest
- type AlertChannelDto
- type ApiKeyAuthConfig
- type BasicAuthConfig
- type BearerAuthConfig
- type ConfirmationPolicy
- type CreateAlertChannelRequest
- type CreateAssertionRequest
- type CreateEnvironmentRequest
- type CreateMonitorRequest
- type CreateNotificationPolicyRequest
- type CreateResourceGroupRequest
- type CreateSecretRequest
- type CreateTagRequest
- type CreateWebhookEndpointRequest
- type DiscordChannelConfig
- type DnsMonitorConfig
- type EmailChannelConfig
- type EnvironmentDto
- type EscalationChain
- type EscalationStep
- type HeaderAuthConfig
- type HeartbeatMonitorConfig
- type HttpMonitorConfig
- type IcmpMonitorConfig
- type IncidentPolicyDto
- type MatchRule
- type McpServerMonitorConfig
- type MonitorAssertionDto
- type MonitorDto
- type MonitorTagDto
- type NewTagRequest
- type NotificationPolicyDto
- type OpsGenieChannelConfig
- type PagerDutyChannelConfig
- type RecoveryPolicy
- type ResourceGroupDto
- type ResourceGroupMemberDto
- type RetryStrategy
- type SecretDto
- type ServiceSubscribeRequest
- type ServiceSubscriptionDto
- type SlackChannelConfig
- type Summary
- type TagDto
- type TcpMonitorConfig
- type TeamsChannelConfig
- type TriggerRule
- type UpdateAlertChannelRequest
- type UpdateAlertSensitivityRequest
- type UpdateEnvironmentRequest
- type UpdateIncidentPolicyRequest
- type UpdateMonitorRequest
- type UpdateNotificationPolicyRequest
- type UpdateResourceGroupRequest
- type UpdateSecretRequest
- type UpdateTagRequest
- type UpdateWebhookEndpointRequest
- type WebhookChannelConfig
- type WebhookEndpointDto
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddMonitorTagsRequest ¶
type AddMonitorTagsRequest struct {
TagIds []string `json:"tagIds,omitempty"`
NewTags []NewTagRequest `json:"newTags,omitempty"`
}
type AlertChannelDto ¶
type ApiKeyAuthConfig ¶
type BasicAuthConfig ¶
type BearerAuthConfig ¶
type ConfirmationPolicy ¶
type CreateAlertChannelRequest ¶
type CreateAlertChannelRequest struct {
Name string `json:"name"`
Config json.RawMessage `json:"config"`
}
type CreateAssertionRequest ¶
type CreateAssertionRequest struct {
Config json.RawMessage `json:"config"`
Severity *string `json:"severity,omitempty"`
}
type CreateMonitorRequest ¶
type CreateMonitorRequest struct {
Name string `json:"name"`
Type string `json:"type"`
Config json.RawMessage `json:"config"`
ManagedBy string `json:"managedBy"`
FrequencySeconds *int `json:"frequencySeconds,omitempty"`
Enabled *bool `json:"enabled,omitempty"`
Regions []string `json:"regions,omitempty"`
EnvironmentID *string `json:"environmentId,omitempty"`
Assertions []CreateAssertionRequest `json:"assertions,omitempty"`
Auth *json.RawMessage `json:"auth,omitempty"`
IncidentPolicy *UpdateIncidentPolicyRequest `json:"incidentPolicy,omitempty"`
AlertChannelIds []string `json:"alertChannelIds,omitempty"`
Tags *AddMonitorTagsRequest `json:"tags,omitempty"`
}
type CreateNotificationPolicyRequest ¶
type CreateNotificationPolicyRequest struct {
Name string `json:"name"`
Enabled *bool `json:"enabled,omitempty"`
Priority *int `json:"priority,omitempty"`
MatchRules []MatchRule `json:"matchRules,omitempty"`
Escalation EscalationChain `json:"escalation"`
}
type CreateResourceGroupRequest ¶
type CreateResourceGroupRequest struct {
Name string `json:"name"`
Description *string `json:"description,omitempty"`
AlertPolicyID *string `json:"alertPolicyId,omitempty"`
DefaultFrequency *int `json:"defaultFrequency,omitempty"`
DefaultRegions []string `json:"defaultRegions,omitempty"`
DefaultRetryStrategy *RetryStrategy `json:"defaultRetryStrategy,omitempty"`
DefaultAlertChannels []string `json:"defaultAlertChannels,omitempty"`
DefaultEnvironmentID *string `json:"defaultEnvironmentId,omitempty"`
HealthThresholdType *string `json:"healthThresholdType,omitempty"`
HealthThresholdValue *float64 `json:"healthThresholdValue,omitempty"`
SuppressMemberAlerts *bool `json:"suppressMemberAlerts,omitempty"`
ConfirmationDelaySeconds *int `json:"confirmationDelaySeconds,omitempty"`
RecoveryCooldownMinutes *int `json:"recoveryCooldownMinutes,omitempty"`
}
type CreateSecretRequest ¶
type CreateTagRequest ¶
type DiscordChannelConfig ¶
type DnsMonitorConfig ¶
type EmailChannelConfig ¶
type EnvironmentDto ¶
type EscalationChain ¶
type EscalationChain struct {
Steps []EscalationStep `json:"steps"`
OnResolve *string `json:"onResolve,omitempty"`
OnReopen *string `json:"onReopen,omitempty"`
}
type EscalationStep ¶
type HeaderAuthConfig ¶
type HeartbeatMonitorConfig ¶
type HttpMonitorConfig ¶
type IcmpMonitorConfig ¶
type IncidentPolicyDto ¶
type IncidentPolicyDto struct {
ID string `json:"id"`
TriggerRules []TriggerRule `json:"triggerRules"`
Confirmation ConfirmationPolicy `json:"confirmation"`
Recovery RecoveryPolicy `json:"recovery"`
}
type McpServerMonitorConfig ¶
type MonitorAssertionDto ¶
type MonitorAssertionDto struct {
ID string `json:"id"`
Config json.RawMessage `json:"config"`
Severity *string `json:"severity,omitempty"`
}
type MonitorDto ¶
type MonitorDto struct {
ID string `json:"id"`
Name string `json:"name"`
Type string `json:"type"`
Config json.RawMessage `json:"config"`
FrequencySeconds int `json:"frequencySeconds"`
Enabled bool `json:"enabled"`
Regions []string `json:"regions"`
ManagedBy *string `json:"managedBy,omitempty"`
Environment *Summary `json:"environment,omitempty"`
Auth *json.RawMessage `json:"auth,omitempty"`
IncidentPolicy *IncidentPolicyDto `json:"incidentPolicy,omitempty"`
AlertChannelIds []string `json:"alertChannelIds,omitempty"`
Tags []MonitorTagDto `json:"tags,omitempty"`
Assertions []MonitorAssertionDto `json:"assertions,omitempty"`
PingUrl *string `json:"pingUrl,omitempty"`
}
type MonitorTagDto ¶
type NewTagRequest ¶
type NotificationPolicyDto ¶
type OpsGenieChannelConfig ¶
type PagerDutyChannelConfig ¶
type RecoveryPolicy ¶
type ResourceGroupDto ¶
type ResourceGroupDto struct {
ID string `json:"id"`
Name string `json:"name"`
Slug string `json:"slug"`
Description *string `json:"description,omitempty"`
AlertPolicyID *string `json:"alertPolicyId,omitempty"`
DefaultFrequency *int `json:"defaultFrequency,omitempty"`
DefaultRegions []string `json:"defaultRegions,omitempty"`
DefaultRetryStrategy *RetryStrategy `json:"defaultRetryStrategy,omitempty"`
DefaultAlertChannels []string `json:"defaultAlertChannels,omitempty"`
DefaultEnvironmentID *string `json:"defaultEnvironmentId,omitempty"`
HealthThresholdType *string `json:"healthThresholdType,omitempty"`
HealthThresholdValue *float64 `json:"healthThresholdValue,omitempty"`
SuppressMemberAlerts *bool `json:"suppressMemberAlerts,omitempty"`
ConfirmationDelaySeconds *int `json:"confirmationDelaySeconds,omitempty"`
RecoveryCooldownMinutes *int `json:"recoveryCooldownMinutes,omitempty"`
Members []ResourceGroupMemberDto `json:"members,omitempty"`
}
type ResourceGroupMemberDto ¶
type RetryStrategy ¶
type ServiceSubscribeRequest ¶
type ServiceSubscriptionDto ¶
type SlackChannelConfig ¶
type TcpMonitorConfig ¶
type TeamsChannelConfig ¶
type TriggerRule ¶
type TriggerRule struct {
Type string `json:"type"`
Severity string `json:"severity"`
Scope *string `json:"scope,omitempty"`
Count *int `json:"count,omitempty"`
WindowMinutes *int `json:"windowMinutes,omitempty"`
ThresholdMs *int `json:"thresholdMs,omitempty"`
AggregationType *string `json:"aggregationType,omitempty"`
}
type UpdateAlertChannelRequest ¶
type UpdateAlertChannelRequest = CreateAlertChannelRequest
type UpdateAlertSensitivityRequest ¶
type UpdateAlertSensitivityRequest struct {
AlertSensitivity string `json:"alertSensitivity"`
}
type UpdateIncidentPolicyRequest ¶
type UpdateIncidentPolicyRequest struct {
TriggerRules []TriggerRule `json:"triggerRules"`
Confirmation ConfirmationPolicy `json:"confirmation"`
Recovery RecoveryPolicy `json:"recovery"`
}
type UpdateMonitorRequest ¶
type UpdateMonitorRequest struct {
Name *string `json:"name,omitempty"`
Config *json.RawMessage `json:"config,omitempty"`
ManagedBy *string `json:"managedBy,omitempty"`
FrequencySeconds *int `json:"frequencySeconds,omitempty"`
Enabled *bool `json:"enabled,omitempty"`
Regions []string `json:"regions,omitempty"`
EnvironmentID *string `json:"environmentId,omitempty"`
ClearEnvironmentID *bool `json:"clearEnvironmentId,omitempty"`
Assertions []CreateAssertionRequest `json:"assertions,omitempty"`
Auth *json.RawMessage `json:"auth,omitempty"`
ClearAuth *bool `json:"clearAuth,omitempty"`
IncidentPolicy *UpdateIncidentPolicyRequest `json:"incidentPolicy,omitempty"`
AlertChannelIds []string `json:"alertChannelIds,omitempty"`
Tags *AddMonitorTagsRequest `json:"tags,omitempty"`
}
type UpdateNotificationPolicyRequest ¶
type UpdateNotificationPolicyRequest = CreateNotificationPolicyRequest
type UpdateResourceGroupRequest ¶
type UpdateResourceGroupRequest = CreateResourceGroupRequest
type UpdateSecretRequest ¶
type UpdateSecretRequest struct {
Value string `json:"value"`
}
type UpdateTagRequest ¶
type UpdateTagRequest = CreateTagRequest
type WebhookChannelConfig ¶
Click to show internal directories.
Click to hide internal directories.