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 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
|
# frozen_string_literal: true
module API
# Snippets API
class Snippets < ::API::Base
include PaginationParams
feature_category :source_code_management
urgency :low
before do
set_current_organization
end
helpers do
def find_snippets(user: current_user, params: {})
SnippetsFinder.new(user, params).execute
end
def snippets_for_current_user
find_snippets(params: { author: current_user })
end
end
resource :snippets do
helpers Helpers::SnippetsHelpers
helpers SpammableActions::CaptchaCheck::RestApiActionsSupport
desc 'Get a snippets list for an authenticated user' do
detail 'This feature was introduced in GitLab 8.15.'
success Entities::Snippet
failure [
{ code: 404, message: 'Not found' }
]
tags %w[snippets]
is_array true
end
params do
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'
use :pagination
end
get do
authenticate!
filter_params = declared_params(include_missing: false).merge(author: current_user)
present paginate(find_snippets(params: filter_params)), with: Entities::Snippet, current_user: current_user
end
desc 'List all public personal snippets current_user has access to' do
detail 'This feature was introduced in GitLab 8.15.'
success Entities::PersonalSnippet
failure [
{ code: 404, message: 'Not found' }
]
tags %w[snippets]
is_array true
end
params do
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'
use :pagination
end
get 'public' do
authenticate!
filter_params = declared_params(include_missing: false).merge(only_personal: true)
present paginate(find_snippets(user: nil, params: filter_params)), with: Entities::PersonalSnippet, current_user: current_user
end
desc 'List all snippets current_user has access to' do
detail 'This feature was introduced in GitLab 16.3.'
success Entities::Snippet
failure [
{ code: 404, message: 'Not found' }
]
tags %w[snippets]
is_array true
end
params do
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'
use :pagination
use :optional_list_params_ee
end
get 'all' do
authenticate!
filter_params = declared_params(include_missing: false).merge(all_available: true)
present paginate(find_snippets(params: filter_params)), with: Entities::Snippet, current_user: current_user
end
desc 'Get a single snippet' do
detail 'This feature was introduced in GitLab 8.15.'
success Entities::PersonalSnippet
failure [
{ code: 404, message: 'Not found' }
]
tags %w[snippets]
end
params do
requires :id, type: Integer, desc: 'The ID of a snippet'
end
get ':id' do
snippet = find_snippets.find_by_id(params[:id])
break not_found!('Snippet') unless snippet
present snippet, with: Entities::PersonalSnippet, current_user: current_user
end
desc 'Create new snippet' do
detail 'This feature was introduced in GitLab 8.15.'
success Entities::PersonalSnippet
failure [
{ code: 400, message: 'Validation error' },
{ code: 404, message: 'Not found' },
{ code: 422, message: 'Unprocessable entity' }
]
tags %w[snippets]
end
params do
requires :title, type: String, allow_blank: false, desc: 'The title of a snippet'
optional :description, type: String, desc: 'The description of a snippet'
optional :visibility, type: String,
values: Gitlab::VisibilityLevel.string_values,
default: 'internal',
desc: 'The visibility of the snippet'
use :create_file_params
end
post do
authenticate!
authorize! :create_snippet
attrs = process_create_params(declared_params(include_missing: false)).merge(organization_id: Current.organization_id)
service_response = ::Snippets::CreateService.new(project: nil, current_user: current_user, params: attrs).execute
snippet = service_response.payload[:snippet]
if service_response.success?
present snippet, with: Entities::PersonalSnippet, current_user: current_user
else
with_captcha_check_rest_api(spammable: snippet) do
render_api_error!({ error: service_response.message }, service_response.http_status)
end
end
end
desc 'Update an existing snippet' do
detail 'This feature was introduced in GitLab 8.15.'
success Entities::PersonalSnippet
failure [
{ code: 400, message: 'Validation error' },
{ code: 404, message: 'Not found' },
{ code: 422, message: 'Unprocessable entity' }
]
tags %w[snippets]
end
params do
requires :id, type: Integer, desc: 'The ID of a snippet'
optional :content, type: String, allow_blank: false, desc: 'The content of a snippet'
optional :description, type: String, desc: 'The description of a snippet'
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'
optional :visibility, type: String,
values: Gitlab::VisibilityLevel.string_values,
desc: 'The visibility of the snippet'
use :update_file_params
use :minimum_update_params
end
put ':id' do
authenticate!
snippet = snippets_for_current_user.find_by_id(params.delete(:id))
break not_found!('Snippet') unless snippet
authorize! :update_snippet, snippet
validate_params_for_multiple_files(snippet)
attrs = process_update_params(declared_params(include_missing: false))
service_response = ::Snippets::UpdateService.new(project: nil, current_user: current_user, params: attrs, perform_spam_check: true).execute(snippet)
snippet = service_response.payload[:snippet]
if service_response.success?
present snippet, with: Entities::PersonalSnippet, current_user: current_user
else
with_captcha_check_rest_api(spammable: snippet) do
render_api_error!({ error: service_response.message }, service_response.http_status)
end
end
end
desc 'Remove snippet' do
detail 'This feature was introduced in GitLab 8.15.'
success Entities::PersonalSnippet
failure [
{ code: 400, message: 'Validation error' },
{ code: 404, message: 'Not found' }
]
tags %w[snippets]
end
params do
requires :id, type: Integer, desc: 'The ID of a snippet'
end
delete ':id' do
authenticate!
snippet = snippets_for_current_user.find_by_id(params.delete(:id))
break not_found!('Snippet') unless snippet
authorize! :admin_snippet, snippet
destroy_conditionally!(snippet) do |snippet|
service = ::Snippets::DestroyService.new(current_user, snippet)
response = service.execute
if response.error?
render_api_error!({ error: response.message }, response.http_status)
end
end
end
desc 'Get a raw snippet' do
detail 'This feature was introduced in GitLab 8.15.'
failure [
{ code: 404, message: 'Not found' }
]
tags %w[snippets]
end
params do
requires :id, type: Integer, desc: 'The ID of a snippet'
end
get ":id/raw" do
snippet = find_snippets.find_by_id(params.delete(:id))
not_found!('Snippet') unless snippet
present content_for(snippet)
end
desc 'Get raw snippet file contents from the repository' do
failure [
{ code: 404, message: 'Not found' }
]
tags %w[snippets]
end
params do
use :raw_file_params
end
get ":id/files/:ref/:file_path/raw", requirements: { file_path: API::NO_SLASH_URL_PART_REGEX } do
snippet = find_snippets.find_by_id(params.delete(:id))
not_found!('Snippet') unless snippet&.repo_exists?
present file_content_for(snippet)
end
desc 'Get the user agent details for a snippet' do
success Entities::UserAgentDetail
failure [
{ code: 404, message: 'Not found' }
]
tags %w[snippets]
end
params do
requires :id, type: Integer, desc: 'The ID of a snippet'
end
get ":id/user_agent_detail" do
authenticated_as_admin!
snippet = Snippet.find(params[:id])
break not_found!('UserAgentDetail') unless snippet.user_agent_detail
present snippet.user_agent_detail, with: Entities::UserAgentDetail
end
end
end
end
API::Snippets.prepend_mod_with('API::Snippets')
|