96 lines
3.2 KiB
Ruby
96 lines
3.2 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module API
|
|
class Templates < ::API::Base
|
|
include PaginationParams
|
|
|
|
GLOBAL_TEMPLATE_TYPES = {
|
|
gitignores: {
|
|
gitlab_version: 8.8,
|
|
feature_category: :source_code_management
|
|
},
|
|
gitlab_ci_ymls: {
|
|
gitlab_version: 8.9,
|
|
feature_category: :pipeline_authoring
|
|
},
|
|
dockerfiles: {
|
|
gitlab_version: 8.15,
|
|
feature_category: :source_code_management
|
|
}
|
|
}.freeze
|
|
|
|
helpers do
|
|
def render_response(template_type, template)
|
|
not_found!(template_type.to_s.singularize) unless template
|
|
present template, with: Entities::Template
|
|
end
|
|
end
|
|
|
|
desc 'Get the list of the available license template' do
|
|
detail 'This feature was introduced in GitLab 8.7.'
|
|
success ::API::Entities::License
|
|
end
|
|
params do
|
|
optional :popular, type: Boolean, desc: 'If passed, returns only popular licenses'
|
|
use :pagination
|
|
end
|
|
get "templates/licenses", feature_category: :source_code_management do
|
|
popular = declared(params)[:popular]
|
|
popular = to_boolean(popular) if popular.present?
|
|
|
|
templates = TemplateFinder.build(:licenses, nil, popular: popular).execute
|
|
|
|
present paginate(::Kaminari.paginate_array(templates)), with: ::API::Entities::License
|
|
end
|
|
|
|
desc 'Get the text for a specific license' do
|
|
detail 'This feature was introduced in GitLab 8.7.'
|
|
success ::API::Entities::License
|
|
end
|
|
params do
|
|
requires :name, type: String, desc: 'The name of the template'
|
|
end
|
|
get "templates/licenses/:name", requirements: { name: /[\w\.-]+/ }, feature_category: :source_code_management do
|
|
template = TemplateFinder.build(:licenses, nil, name: params[:name]).execute
|
|
|
|
not_found!('License') unless template.present?
|
|
|
|
template.resolve!(
|
|
project_name: params[:project].presence,
|
|
fullname: params[:fullname].presence || current_user&.name
|
|
)
|
|
|
|
present template, with: ::API::Entities::License
|
|
end
|
|
|
|
GLOBAL_TEMPLATE_TYPES.each do |template_type, properties|
|
|
gitlab_version = properties[:gitlab_version]
|
|
|
|
desc 'Get the list of the available template' do
|
|
detail "This feature was introduced in GitLab #{gitlab_version}."
|
|
success Entities::TemplatesList
|
|
end
|
|
params do
|
|
use :pagination
|
|
end
|
|
get "templates/#{template_type}", feature_category: properties[:feature_category] do
|
|
templates = ::Kaminari.paginate_array(TemplateFinder.build(template_type, nil).execute)
|
|
present paginate(templates), with: Entities::TemplatesList
|
|
end
|
|
|
|
desc 'Get the text for a specific template present in local filesystem' do
|
|
detail "This feature was introduced in GitLab #{gitlab_version}."
|
|
success Entities::Template
|
|
end
|
|
params do
|
|
requires :name, type: String, desc: 'The name of the template'
|
|
end
|
|
get "templates/#{template_type}/:name", requirements: { name: /[\w\.-]+/ }, feature_category: properties[:feature_category] do
|
|
finder = TemplateFinder.build(template_type, nil, name: declared(params)[:name])
|
|
new_template = finder.execute
|
|
|
|
render_response(template_type, new_template)
|
|
end
|
|
end
|
|
end
|
|
end
|