Module: Grafana::Api::Validations

Included in:: Models::ActiveSyncStatusDTO, Models::ActiveUserStats, Models::AddDataSource200Response, Models::AddDataSourceCommand, Models::AddInviteForm, Models::AddOrgUserCommand, Models::AddServiceAccountTokenCommand, Models::AddTeamMemberCommand, Models::AddTeamRoleCommand, Models::AddUserRoleCommand, Models::Address, Models::AdminCreateUserForm, Models::AdminCreateUserResponse, Models::AdminStats, Models::AdminUpdateUserPasswordForm, Models::AdminUpdateUserPermissionsForm, Models::Alert, Models::AlertDiscovery, Models::AlertGroup, Models::AlertInstancesResponse, Models::AlertManager, Models::AlertManagersResult, Models::AlertQuery, Models::AlertQueryExport, Models::AlertResponse, Models::AlertRuleEditorSettings, Models::AlertRuleExport, Models::AlertRuleGroup, Models::AlertRuleGroupExport, Models::AlertRuleGroupMetadata, Models::AlertRuleMetadata, Models::AlertRuleNotificationSettings, Models::AlertRuleNotificationSettingsExport, Models::AlertRuleRecordExport, Models::AlertStatus, Models::AlertingFileExport, Models::AlertingRule, Models::AlertingStatus, Models::AlertmanagerConfig, Models::AlertmanagerStatus, Models::AlertmanagerUserConfig, Models::Annotation, Models::AnnotationActions, Models::AnnotationEvent, Models::AnnotationPanelFilter, Models::AnnotationPermission, Models::AnnotationQuery, Models::AnnotationTarget, Models::ApiRuleNode, Models::Assignments, Models::AttributeTypeAndValue, Models::Authorization, Models::BacktestConfig, Models::BasicAuth, Models::CacheConfig, Models::CacheConfigResponse, Models::CacheConfigSetter, Models::CalculateDiffTarget, Models::Certificate, Models::ChangeUserPasswordCommand, Models::ClearHelpFlags200Response, Models::CloudMigrationRunListDTO, Models::CloudMigrationSessionListResponseDTO, Models::CloudMigrationSessionRequestDTO, Models::CloudMigrationSessionResponseDTO, Models::ClusterStatus, Models::Config, Models::ContactPointExport, Models::ConvertPrometheusResponse, Models::Correlation, Models::CorrelationConfig, Models::CorrelationConfigUpdateDTO, Models::CreateAccessTokenResponseDTO, Models::CreateCorrelationCommand, Models::CreateCorrelationResponseBody, Models::CreateDashboardSnapshot200Response, Models::CreateDashboardSnapshotCommand, Models::CreateFolderCommand, Models::CreateLibraryElementCommand, Models::CreateOrUpdateReport, Models::CreateOrg200Response, Models::CreateOrgCommand, Models::CreatePlaylistCommand, Models::CreateQueryInQueryHistoryCommand, Models::CreateReport200Response, Models::CreateRoleForm, Models::CreateServiceAccountForm, Models::CreateSnapshotRequestDTO, Models::CreateSnapshotResponseDTO, Models::CreateTeam200Response, Models::CreateTeamCommand, Models::DashboardACLInfoDTO, Models::DashboardACLUpdateItem, Models::DashboardCreateCommand, Models::DashboardFullWithMeta, Models::DashboardMeta, Models::DashboardRedirect, Models::DashboardSnapshotDTO, Models::DashboardTagCloudItem, Models::DashboardVersionMeta, Models::DashboardVersionResponseMeta, Models::DataLink, Models::DataResponse, Models::DataSource, Models::DataSourceListItemDTO, Models::DataSourceRef, Models::DeleteCorrelationResponseBody, Models::DeleteDashboardByUID200Response, Models::DeleteDataSourceByName200Response, Models::DeleteFolder200Response, Models::DeleteTokenCommand, Models::Description, Models::DeviceDTO, Models::DeviceSearchHitDTO, Models::DiscordConfig, Models::DiscoveryBase, Models::EmailConfig, Models::EmailDTO, Models::EmbeddedContactPoint, Models::EnumFieldConfig, Models::ErrorResponseBody, Models::EvalAlertConditionCommand, Models::EvalQueriesPayload, Models::ExtendedReceiver, Models::Extension, Models::ExternalAlertmanagerConfig, Models::ExternalAlertmanagerStatus, Models::ExtraConfiguration, Models::FailedUser, Models::Field, Models::FieldConfig, Models::FieldTypeConfig, Models::FindTagsResult, Models::FloatHistogram, Models::Folder, Models::FolderSearchHit, Models::FooterItem, Models::ForbiddenError, Models::Frame, Models::FrameMeta, Models::GetAccessTokenResponseDTO, Models::GetAnnotationTagsResponse, Models::GetDataSourceIdByName200Response, Models::GetGroupsResponse, Models::GetHomeDashboardResponse, Models::GetSharingOptions200Response, Models::GetSnapshotResponseDTO, Models::GettableAlert, Models::GettableAlertmanagers, Models::GettableApiAlertingConfig, Models::GettableApiReceiver, Models::GettableExtendedRuleNode, Models::GettableGrafanaReceiver, Models::GettableGrafanaReceivers, Models::GettableGrafanaRule, Models::GettableGrafanaSilence, Models::GettableHistoricUserConfig, Models::GettableNGalertConfig, Models::GettableRuleGroupConfig, Models::GettableSilence, Models::GettableStatus, Models::GettableUserConfig, Models::GlobalConfig, Models::Group, Models::GroupAttributes, Models::HTTPClientConfig, Models::Header, Models::Headers, Models::HealthResponse, Models::Hit, Models::HostPort, Models::IPNet, Models::ImportDashboardInput, Models::ImportDashboardRequest, Models::ImportDashboardResponse, Models::InhibitRule, Models::IntegrationStatus, Models::InternalDataLink, Models::JSONWebKey, Models::JiraConfig, Models::Label, Models::LibraryElementArrayResponse, Models::LibraryElementConnectionDTO, Models::LibraryElementConnectionsResponse, Models::LibraryElementDTO, Models::LibraryElementDTOMeta, Models::LibraryElementDTOMetaUser, Models::LibraryElementResponse, Models::LibraryElementSearchResponse, Models::LibraryElementSearchResult, Models::LinkTransformationConfig, Models::ListAllProvidersSettings200ResponseInner, Models::ListSortOptions200Response, Models::MSTeamsConfig, Models::MSTeamsV2Config, Models::MassDeleteAnnotationsCmd, Models::Matcher, Models::MessageResponse, Models::MetricRequest, Models::MigrateDataResponseDTO, Models::MigrateDataResponseItemDTO, Models::MigrateDataResponseListDTO, Models::MoveFolderCommand, Models::MuteTimeInterval, Models::MuteTimeIntervalExport, Models::Name, Models::NavbarPreference, Models::NewApiKeyResult, Models::Notice, Models::NotificationPolicyExport, Models::NotificationTemplate, Models::NotificationTemplateContent, Models::NotifierConfig, Models::OAuth2, Models::OpsGenieConfig, Models::OpsGenieConfigResponder, Models::OrgDTO, Models::OrgDetailsDTO, Models::OrgUserDTO, Models::PagerdutyConfig, Models::PagerdutyImage, Models::PagerdutyLink, Models::PatchAnnotationsCmd, Models::PatchLibraryElementCommand, Models::PatchPrefsCmd, Models::PatchProviderSettingsRequest, Models::PatchQueryCommentInQueryHistoryCommand, Models::PeerStatus, Models::Permission, Models::Playlist, Models::PlaylistDTO, Models::PlaylistDashboard, Models::PlaylistItem, Models::PlaylistItemDTO, Models::PolicyMapping, Models::PostAnnotation200Response, Models::PostAnnotationsCmd, Models::PostDashboard200Response, Models::PostGraphiteAnnotationsCmd, Models::PostSilencesOKBody, Models::PostableAlert, Models::PostableApiAlertingConfig, Models::PostableApiReceiver, Models::PostableExtendedRuleNode, Models::PostableExtendedRuleNodeExtended, Models::PostableGrafanaReceiver, Models::PostableGrafanaReceivers, Models::PostableGrafanaRule, Models::PostableNGalertConfig, Models::PostableRuleGroupConfig, Models::PostableSilence, Models::PostableUserConfig, Models::PreferencesNavbarPreference, Models::PreferencesQueryHistoryPreference, Models::PreferencesSpec, Models::PrometheusNamespace, Models::PrometheusRemoteWriteTargetJSON, Models::PrometheusRule, Models::PrometheusRuleGroup, Models::ProvisionedAlertRule, Models::ProxyConfig, Models::PublicDashboard, Models::PublicDashboardDTO, Models::PublicDashboardListResponse, Models::PublicDashboardListResponseWithPagination, Models::PublicError, Models::PushoverConfig, Models::QueryDataResponse, Models::QueryHistoryDTO, Models::QueryHistoryDeleteQueryResponse, Models::QueryHistoryPreference, Models::QueryHistoryResponse, Models::QueryHistorySearchResponse, Models::QueryHistorySearchResult, Models::QueryStat, Models::QuotaDTO, Models::Receiver, Models::ReceiverExport, Models::ReceiverStatus, Models::Record, Models::RecordingRuleJSON, Models::RelativeTimeRange, Models::RelativeTimeRangeExport, Models::RemoteWriteConfig, Models::Report, Models::ReportBrandingOptions, Models::ReportDashboard, Models::ReportDashboardID, Models::ReportEmail, Models::ReportOptions, Models::ReportSchedule, Models::ReportSettings, Models::ReportTimeRange, Models::ResourceDependenciesResponseDTO, Models::ResourceDependencyDTO, Models::ResourcePermissionDTO, Models::ResponseDetails, Models::RestoreDashboardVersionCommand, Models::RestoreDeletedDashboardCommand, Models::RetrieveJWKS200Response, Models::RevokeAuthTokenCmd, Models::RoleAssignmentsDTO, Models::RoleDTO, Models::RolesSearchQuery, Models::Route, Models::RouteExport, Models::Rule, Models::RuleDiscovery, Models::RuleGroup, Models::RuleGroupConfigResponse, Models::RuleResponse, Models::SNSConfig, Models::Sample, Models::SaveDashboardCommand, Models::SearchDeviceQueryResult, Models::SearchOrgServiceAccountsResult, Models::SearchOrgUsersQueryResult, Models::SearchTeamGroupsQueryResult, Models::SearchTeamQueryResult, Models::SearchUserQueryResult, Models::ServiceAccountDTO, Models::ServiceAccountProfileDTO, Models::SetPermissionCommand, Models::SetPermissionsCommand, Models::SetResourcePermissionCommand, Models::SetRoleAssignmentsCommand, Models::SetTeamMembershipsCommand, Models::SetTeamRolesCommand, Models::SetUserRolesCommand, Models::SigV4Config, Models::Silence, Models::SilenceMetadata, Models::SilenceStatus, Models::SlackAction, Models::SlackConfig, Models::SlackConfirmationField, Models::SlackField, Models::SnapshotDTO, Models::SnapshotListResponseDTO, Models::SnapshotResourceStats, Models::Span, Models::SuccessResponseBody, Models::SyncResult, Models::TLSConfig, Models::TagsDTO, Models::TeamDTO, Models::TeamGroupDTO, Models::TeamGroupMapping, Models::TeamLBACRule, Models::TeamLBACRules, Models::TeamMemberDTO, Models::TelegramConfig, Models::TempUserDTO, Models::TestRulePayload, Models::TestRuleResponse, Models::TestTemplatesConfigBodyParams, Models::TestTemplatesErrorResult, Models::TestTemplatesResult, Models::TestTemplatesResults, Models::Threshold, Models::ThresholdsConfig, Models::TimeInterval, Models::TimeIntervalItem, Models::TimeIntervalTimeRange, Models::TimeRange, Models::Token, Models::TokenDTO, Models::Transformation, Models::TypeMeta, Models::Unstructured, Models::UpdateAnnotationsCmd, Models::UpdateCorrelationCommand, Models::UpdateCorrelationResponseBody, Models::UpdateDashboardACLCommand, Models::UpdateDataSourceCommand, Models::UpdateFolderCommand, Models::UpdateNamespaceRulesRequest, Models::UpdateNamespaceRulesResponse, Models::UpdateOrgAddressForm, Models::UpdateOrgForm, Models::UpdateOrgUserCommand, Models::UpdatePlaylistCommand, Models::UpdatePrefsCmd, Models::UpdateProviderSettingsRequest, Models::UpdateQuotaCmd, Models::UpdateRoleCommand, Models::UpdateRuleGroupResponse, Models::UpdateServiceAccount200Response, Models::UpdateServiceAccountForm, Models::UpdateTeamCommand, Models::UpdateTeamLBACCommand, Models::UpdateTeamLBACRulesApi200Response, Models::UpdateTeamMemberCommand, Models::UpdateUserCommand, Models::UserInfo, Models::UserLookupDTO, Models::UserOrgDTO, Models::UserProfileDTO, Models::UserSearchHitDTO, Models::UserToken, Models::ValidationError, Models::VersionInfo, Models::VictorOpsConfig, Models::WebexConfig, Models::WebhookConfig, Models::WechatConfig

Defined in:: lib/grafana-api/validations.rb

Overview

Declarative attribute DSL. attribute :name, type:, required:, enum:, ... generates the accessor, registers the attribute in openapi_attributes, and stores the validation rules. Replaces the per-model EnumAttributeValidator.

Defined Under Namespace

Modules: ClassMethods

Class Method Summary collapse

.included(base) ⇒ Object

Class Method Details

.included(base) ⇒ `Object`



8
9
10

# File 'lib/grafana-api/validations.rb', line 8

def self.included(base)
  base.extend(ClassMethods)
end

Instance Method Details

#list_invalid_properties ⇒ `Object`

# File 'lib/grafana-api/validations.rb', line 51

def list_invalid_properties
  errors = []
  self.class.openapi_attributes.each do |name, attr|
    errors.concat(validate_attribute(name, attr, public_send(name)))
  end
  errors
end

#valid? ⇒ `Boolean`

Returns:

(Boolean)



59
60
61

# File 'lib/grafana-api/validations.rb', line 59

def valid?
  list_invalid_properties.empty?
end