summaryrefslogtreecommitdiff
path: root/app/graphql/types/metrics/dashboards/annotation_type.rb
blob: b9e040dd063bdd2ffc4c8b58ab673f99b66592c8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# frozen_string_literal: true

module Types
  module Metrics
    module Dashboards
      class AnnotationType < ::Types::BaseObject
        authorize :read_metrics_dashboard_annotation
        graphql_name 'MetricsDashboardAnnotation'

        field :description, GraphQL::STRING_TYPE, null: true,
              description: 'Description of the annotation.'

        field :id, GraphQL::ID_TYPE, null: false,
              description: 'ID of the annotation.'

        field :panel_id, GraphQL::STRING_TYPE, null: true,
              description: 'ID of a dashboard panel to which the annotation should be scoped.'

        field :starting_at, Types::TimeType, null: true,
              description: 'Timestamp marking start of annotated time span.'

        field :ending_at, Types::TimeType, null: true,
              description: 'Timestamp marking end of annotated time span.'

        def panel_id
          object.panel_xid
        end
      end
    end
  end
end