debian-mirror-gitlab/lib/api/error_tracking/client_keys.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

67 lines
2.2 KiB
Ruby
Raw Normal View History

2021-11-11 11:23:49 +05:30
# frozen_string_literal: true
module API
2021-11-18 22:05:49 +05:30
class ErrorTracking::ClientKeys < ::API::Base
2021-11-11 11:23:49 +05:30
before { authenticate! }
2023-01-13 00:05:48 +05:30
ERROR_TRACKING_CLIENT_KEYS_TAGS = %w[error_tracking_client_keys].freeze
2021-11-11 11:23:49 +05:30
feature_category :error_tracking
2022-07-23 23:45:48 +05:30
urgency :low
2021-11-11 11:23:49 +05:30
params do
2023-01-13 00:05:48 +05:30
requires :id, types: [String, Integer],
desc: 'The ID or URL-encoded path of the project owned by the authenticated user'
2021-11-11 11:23:49 +05:30
end
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
segment ':id/error_tracking' do
before do
authorize! :admin_operations, user_project
end
2023-01-13 00:05:48 +05:30
desc 'List project client keys' do
detail 'List all client keys. This feature was introduced in GitLab 14.3.'
2021-11-11 11:23:49 +05:30
success Entities::ErrorTracking::ClientKey
2023-01-13 00:05:48 +05:30
is_array true
tags ERROR_TRACKING_CLIENT_KEYS_TAGS
2021-11-11 11:23:49 +05:30
end
get '/client_keys' do
collection = user_project.error_tracking_client_keys
present paginate(collection), with: Entities::ErrorTracking::ClientKey
end
desc 'Create a client key' do
2023-01-13 00:05:48 +05:30
detail 'Creates a new client key for a project. The public key attribute is generated automatically.'\
'This feature was introduced in GitLab 14.3.'
2021-11-11 11:23:49 +05:30
success Entities::ErrorTracking::ClientKey
2023-01-13 00:05:48 +05:30
tags ERROR_TRACKING_CLIENT_KEYS_TAGS
2021-11-11 11:23:49 +05:30
end
post '/client_keys' do
key = user_project.error_tracking_client_keys.create!
present key, with: Entities::ErrorTracking::ClientKey
end
desc 'Delete a client key' do
2023-01-13 00:05:48 +05:30
detail 'Removes a client key from the project. This feature was introduced in GitLab 14.3.'
2021-11-11 11:23:49 +05:30
success Entities::ErrorTracking::ClientKey
2023-01-13 00:05:48 +05:30
failure [
{ code: 400, message: 'Bad request' },
{ code: 401, message: 'Unauthorized' },
{ code: 404, message: 'Not found' }
]
tags ERROR_TRACKING_CLIENT_KEYS_TAGS
2021-11-11 11:23:49 +05:30
end
delete '/client_keys/:key_id' do
key = user_project.error_tracking_client_keys.find(params[:key_id])
key.destroy!
2022-07-16 23:28:13 +05:30
present key, with: Entities::ErrorTracking::ClientKey
2021-11-11 11:23:49 +05:30
end
end
end
end
end