debian-mirror-gitlab/lib/api/snippets.rb

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

265 lines
8.8 KiB
Ruby
Raw Normal View History

2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2017-08-17 22:00:37 +05:30
module API
# Snippets API
2021-01-03 14:25:43 +05:30
class Snippets < ::API::Base
2017-08-17 22:00:37 +05:30
include PaginationParams
2021-01-29 00:20:46 +05:30
feature_category :snippets
2022-11-25 23:54:43 +05:30
urgency :low
2021-01-29 00:20:46 +05:30
2017-08-17 22:00:37 +05:30
resource :snippets do
2020-05-24 23:13:21 +05:30
helpers Helpers::SnippetsHelpers
2022-05-07 20:08:51 +05:30
helpers SpammableActions::CaptchaCheck::RestApiActionsSupport
2017-08-17 22:00:37 +05:30
helpers do
def snippets_for_current_user
SnippetsFinder.new(current_user, author: current_user).execute
end
def public_snippets
2020-01-01 13:55:28 +05:30
Snippet.only_personal_snippets.are_public.fresh
2017-08-17 22:00:37 +05:30
end
2019-07-07 11:18:12 +05:30
def snippets
SnippetsFinder.new(current_user).execute
end
2017-08-17 22:00:37 +05:30
end
2021-01-03 14:25:43 +05:30
desc 'Get a snippets list for an authenticated user' do
2017-08-17 22:00:37 +05:30
detail 'This feature was introduced in GitLab 8.15.'
2020-05-24 23:13:21 +05:30
success Entities::Snippet
2023-01-13 00:05:48 +05:30
failure [
{ code: 404, message: 'Not found' }
]
tags %w[snippets]
is_array true
2017-08-17 22:00:37 +05:30
end
params do
2022-08-13 15:12:31 +05:30
optional :created_after, type: DateTime, desc: 'Return snippets created after the specified time'
optional :created_before, type: DateTime, desc: 'Return snippets created before the specified time'
2017-08-17 22:00:37 +05:30
use :pagination
end
get do
2021-01-03 14:25:43 +05:30
authenticate!
2022-08-13 15:12:31 +05:30
filter_params = declared_params(include_missing: false).merge(author: current_user)
present paginate(SnippetsFinder.new(current_user, filter_params).execute), with: Entities::Snippet, current_user: current_user
2017-08-17 22:00:37 +05:30
end
2020-01-01 13:55:28 +05:30
desc 'List all public personal snippets current_user has access to' do
2017-08-17 22:00:37 +05:30
detail 'This feature was introduced in GitLab 8.15.'
success Entities::PersonalSnippet
2023-01-13 00:05:48 +05:30
failure [
{ code: 404, message: 'Not found' }
]
tags %w[snippets]
is_array true
2017-08-17 22:00:37 +05:30
end
params do
2022-08-13 15:12:31 +05:30
optional :created_after, type: DateTime, desc: 'Return snippets created after the specified time'
optional :created_before, type: DateTime, desc: 'Return snippets created before the specified time'
2017-08-17 22:00:37 +05:30
use :pagination
end
2022-11-25 23:54:43 +05:30
get 'public' do
2021-01-03 14:25:43 +05:30
authenticate!
2022-08-13 15:12:31 +05:30
filter_params = declared_params(include_missing: false).merge(only_personal: true)
present paginate(SnippetsFinder.new(nil, filter_params).execute), with: Entities::PersonalSnippet, current_user: current_user
2017-08-17 22:00:37 +05:30
end
desc 'Get a single snippet' do
detail 'This feature was introduced in GitLab 8.15.'
success Entities::PersonalSnippet
2023-01-13 00:05:48 +05:30
failure [
{ code: 404, message: 'Not found' }
]
tags %w[snippets]
2017-08-17 22:00:37 +05:30
end
params do
requires :id, type: Integer, desc: 'The ID of a snippet'
end
get ':id' do
2019-07-07 11:18:12 +05:30
snippet = snippets.find_by_id(params[:id])
break not_found!('Snippet') unless snippet
2020-07-28 23:09:34 +05:30
present snippet, with: Entities::PersonalSnippet, current_user: current_user
2017-08-17 22:00:37 +05:30
end
desc 'Create new snippet' do
detail 'This feature was introduced in GitLab 8.15.'
success Entities::PersonalSnippet
2023-01-13 00:05:48 +05:30
failure [
{ code: 400, message: 'Validation error' },
{ code: 404, message: 'Not found' },
{ code: 422, message: 'Unprocessable entity' }
]
tags %w[snippets]
2017-08-17 22:00:37 +05:30
end
params do
2020-05-24 23:13:21 +05:30
requires :title, type: String, allow_blank: false, desc: 'The title of a snippet'
2017-09-10 17:25:29 +05:30
optional :description, type: String, desc: 'The description of a snippet'
2017-08-17 22:00:37 +05:30
optional :visibility, type: String,
values: Gitlab::VisibilityLevel.string_values,
default: 'internal',
desc: 'The visibility of the snippet'
2020-10-24 23:57:45 +05:30
use :create_file_params
2017-08-17 22:00:37 +05:30
end
post do
2021-01-03 14:25:43 +05:30
authenticate!
2020-03-28 13:19:24 +05:30
authorize! :create_snippet
2020-11-24 15:15:51 +05:30
attrs = process_create_params(declared_params(include_missing: false))
2020-10-24 23:57:45 +05:30
2021-09-30 23:02:18 +05:30
spam_params = ::Spam::SpamParams.new_from_request(request: request)
service_response = ::Snippets::CreateService.new(project: nil, current_user: current_user, params: attrs, spam_params: spam_params).execute
2020-03-13 15:44:24 +05:30
snippet = service_response.payload[:snippet]
2017-08-17 22:00:37 +05:30
2020-05-24 23:13:21 +05:30
if service_response.success?
2020-07-28 23:09:34 +05:30
present snippet, with: Entities::PersonalSnippet, current_user: current_user
2017-08-17 22:00:37 +05:30
else
2022-05-07 20:08:51 +05:30
with_captcha_check_rest_api(spammable: snippet) do
render_api_error!({ error: service_response.message }, service_response.http_status)
end
2017-08-17 22:00:37 +05:30
end
end
desc 'Update an existing snippet' do
detail 'This feature was introduced in GitLab 8.15.'
success Entities::PersonalSnippet
2023-01-13 00:05:48 +05:30
failure [
{ code: 400, message: 'Validation error' },
{ code: 404, message: 'Not found' },
{ code: 422, message: 'Unprocessable entity' }
]
tags %w[snippets]
2017-08-17 22:00:37 +05:30
end
2020-11-24 15:15:51 +05:30
2017-08-17 22:00:37 +05:30
params do
requires :id, type: Integer, desc: 'The ID of a snippet'
2020-05-24 23:13:21 +05:30
optional :content, type: String, allow_blank: false, desc: 'The content of a snippet'
2017-09-10 17:25:29 +05:30
optional :description, type: String, desc: 'The description of a snippet'
2020-11-24 15:15:51 +05:30
optional :file_name, type: String, desc: 'The name of a snippet file'
optional :title, type: String, allow_blank: false, desc: 'The title of a snippet'
2017-08-17 22:00:37 +05:30
optional :visibility, type: String,
values: Gitlab::VisibilityLevel.string_values,
desc: 'The visibility of the snippet'
2020-11-24 15:15:51 +05:30
use :update_file_params
use :minimum_update_params
2017-08-17 22:00:37 +05:30
end
put ':id' do
2021-01-03 14:25:43 +05:30
authenticate!
2019-07-07 11:18:12 +05:30
snippet = snippets_for_current_user.find_by_id(params.delete(:id))
2018-10-15 14:42:47 +05:30
break not_found!('Snippet') unless snippet
2018-03-17 18:26:18 +05:30
2020-03-13 15:44:24 +05:30
authorize! :update_snippet, snippet
2017-08-17 22:00:37 +05:30
2020-11-24 15:15:51 +05:30
validate_params_for_multiple_files(snippet)
attrs = process_update_params(declared_params(include_missing: false))
2021-09-30 23:02:18 +05:30
spam_params = ::Spam::SpamParams.new_from_request(request: request)
service_response = ::Snippets::UpdateService.new(project: nil, current_user: current_user, params: attrs, spam_params: spam_params).execute(snippet)
2020-11-24 15:15:51 +05:30
2020-03-13 15:44:24 +05:30
snippet = service_response.payload[:snippet]
2017-08-17 22:00:37 +05:30
2020-05-24 23:13:21 +05:30
if service_response.success?
2020-07-28 23:09:34 +05:30
present snippet, with: Entities::PersonalSnippet, current_user: current_user
2017-08-17 22:00:37 +05:30
else
2022-05-07 20:08:51 +05:30
with_captcha_check_rest_api(spammable: snippet) do
render_api_error!({ error: service_response.message }, service_response.http_status)
end
2017-08-17 22:00:37 +05:30
end
end
desc 'Remove snippet' do
detail 'This feature was introduced in GitLab 8.15.'
success Entities::PersonalSnippet
2023-01-13 00:05:48 +05:30
failure [
{ code: 400, message: 'Validation error' },
{ code: 404, message: 'Not found' }
]
tags %w[snippets]
2017-08-17 22:00:37 +05:30
end
params do
requires :id, type: Integer, desc: 'The ID of a snippet'
end
delete ':id' do
2021-01-03 14:25:43 +05:30
authenticate!
2019-07-07 11:18:12 +05:30
snippet = snippets_for_current_user.find_by_id(params.delete(:id))
2018-10-15 14:42:47 +05:30
break not_found!('Snippet') unless snippet
2017-08-17 22:00:37 +05:30
2020-03-13 15:44:24 +05:30
authorize! :admin_snippet, snippet
destroy_conditionally!(snippet) do |snippet|
service = ::Snippets::DestroyService.new(current_user, snippet)
response = service.execute
2017-08-17 22:00:37 +05:30
2020-03-13 15:44:24 +05:30
if response.error?
render_api_error!({ error: response.message }, response.http_status)
end
end
2017-08-17 22:00:37 +05:30
end
desc 'Get a raw snippet' do
detail 'This feature was introduced in GitLab 8.15.'
2023-01-13 00:05:48 +05:30
failure [
{ code: 404, message: 'Not found' }
]
tags %w[snippets]
2017-08-17 22:00:37 +05:30
end
params do
requires :id, type: Integer, desc: 'The ID of a snippet'
end
get ":id/raw" do
2019-07-07 11:18:12 +05:30
snippet = snippets.find_by_id(params.delete(:id))
2020-07-28 23:09:34 +05:30
not_found!('Snippet') unless snippet
2017-08-17 22:00:37 +05:30
2020-05-24 23:13:21 +05:30
present content_for(snippet)
2017-08-17 22:00:37 +05:30
end
2017-09-10 17:25:29 +05:30
2023-01-13 00:05:48 +05:30
desc 'Get raw snippet file contents from the repository' do
failure [
{ code: 404, message: 'Not found' }
]
tags %w[snippets]
end
2020-07-28 23:09:34 +05:30
params do
use :raw_file_params
end
2022-11-25 23:54:43 +05:30
get ":id/files/:ref/:file_path/raw", requirements: { file_path: API::NO_SLASH_URL_PART_REGEX } do
2020-07-28 23:09:34 +05:30
snippet = snippets.find_by_id(params.delete(:id))
not_found!('Snippet') unless snippet&.repo_exists?
present file_content_for(snippet)
end
2017-09-10 17:25:29 +05:30
desc 'Get the user agent details for a snippet' do
success Entities::UserAgentDetail
2023-01-13 00:05:48 +05:30
failure [
{ code: 404, message: 'Not found' }
]
tags %w[snippets]
2017-09-10 17:25:29 +05:30
end
params do
requires :id, type: Integer, desc: 'The ID of a snippet'
end
get ":id/user_agent_detail" do
authenticated_as_admin!
2022-06-21 17:19:12 +05:30
snippet = Snippet.find(params[:id])
2017-09-10 17:25:29 +05:30
2018-10-15 14:42:47 +05:30
break not_found!('UserAgentDetail') unless snippet.user_agent_detail
2017-09-10 17:25:29 +05:30
present snippet.user_agent_detail, with: Entities::UserAgentDetail
end
2017-08-17 22:00:37 +05:30
end
end
end