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

98 lines
2.8 KiB
Ruby
Raw Normal View History

2021-12-11 22:18:48 +05:30
# frozen_string_literal: true
module API
class Topics < ::API::Base
include PaginationParams
feature_category :projects
desc 'Get topics' do
detail 'This feature was introduced in GitLab 14.5.'
success Entities::Projects::Topic
end
params do
optional :search, type: String, desc: 'Return list of topics matching the search criteria'
use :pagination
end
get 'topics' do
topics = ::Projects::TopicsFinder.new(params: declared_params(include_missing: false)).execute
present paginate(topics), with: Entities::Projects::Topic
end
desc 'Get topic' do
detail 'This feature was introduced in GitLab 14.5.'
success Entities::Projects::Topic
end
params do
requires :id, type: Integer, desc: 'ID of project topic'
end
get 'topics/:id' do
topic = ::Projects::Topic.find(params[:id])
present topic, with: Entities::Projects::Topic
end
desc 'Create a topic' do
detail 'This feature was introduced in GitLab 14.5.'
success Entities::Projects::Topic
end
params do
2022-07-16 23:28:13 +05:30
requires :name, type: String, desc: 'Slug (name)'
requires :title, type: String, desc: 'Title'
2021-12-11 22:18:48 +05:30
optional :description, type: String, desc: 'Description'
optional :avatar, type: ::API::Validations::Types::WorkhorseFile, desc: 'Avatar image for topic'
end
post 'topics' do
authenticated_as_admin!
topic = ::Projects::Topic.new(declared_params(include_missing: false))
if topic.save
present topic, with: Entities::Projects::Topic
else
render_validation_error!(topic)
end
end
desc 'Update a topic' do
detail 'This feature was introduced in GitLab 14.5.'
success Entities::Projects::Topic
end
params do
requires :id, type: Integer, desc: 'ID of project topic'
2022-07-16 23:28:13 +05:30
optional :name, type: String, desc: 'Slug (name)'
optional :title, type: String, desc: 'Title'
2021-12-11 22:18:48 +05:30
optional :description, type: String, desc: 'Description'
optional :avatar, type: ::API::Validations::Types::WorkhorseFile, desc: 'Avatar image for topic'
end
put 'topics/:id' do
authenticated_as_admin!
topic = ::Projects::Topic.find(params[:id])
2022-01-26 12:08:38 +05:30
topic.remove_avatar! if params.key?(:avatar) && params[:avatar].nil?
2021-12-11 22:18:48 +05:30
if topic.update(declared_params(include_missing: false))
present topic, with: Entities::Projects::Topic
else
render_validation_error!(topic)
end
end
2022-05-07 20:08:51 +05:30
desc 'Delete a topic' do
detail 'This feature was introduced in GitLab 14.9.'
end
params do
requires :id, type: Integer, desc: 'ID of project topic'
end
delete 'topics/:id' do
authenticated_as_admin!
topic = ::Projects::Topic.find(params[:id])
destroy_conditionally!(topic)
end
2021-12-11 22:18:48 +05:30
end
end