gitlab-org--gitlab-foss/lib/api/metrics/dashboard/annotations.rb

48 lines
2 KiB
Ruby

# frozen_string_literal: true
module API
module Metrics
module Dashboard
class Annotations < Grape::API
desc 'Create a new monitoring dashboard annotation' do
success Entities::Metrics::Dashboard::Annotation
end
ANNOTATIONS_SOURCES = [
{ class: ::Environment, resource: :environments, create_service_param_key: :environment },
{ class: Clusters::Cluster, resource: :clusters, create_service_param_key: :cluster }
].freeze
ANNOTATIONS_SOURCES.each do |annotations_source|
resource annotations_source[:resource] do
params do
requires :starting_at, type: DateTime,
desc: 'Date time indicating starting moment to which the annotation relates.'
optional :ending_at, type: DateTime,
desc: 'Date time indicating ending moment to which the annotation relates.'
requires :dashboard_path, type: String, coerce_with: -> (val) { CGI.unescape(val) },
desc: 'The path to a file defining the dashboard on which the annotation should be added'
requires :description, type: String, desc: 'The description of the annotation'
end
post ':id/metrics_dashboard/annotations' do
annotations_source_object = annotations_source[:class].find(params[:id])
forbidden! unless can?(current_user, :create_metrics_dashboard_annotation, annotations_source_object)
create_service_params = declared(params).merge(annotations_source[:create_service_param_key] => annotations_source_object)
result = ::Metrics::Dashboard::Annotations::CreateService.new(current_user, create_service_params).execute
if result[:status] == :success
present result[:annotation], with: Entities::Metrics::Dashboard::Annotation
else
error!(result, 400)
end
end
end
end
end
end
end
end