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
|
# frozen_string_literal: true
module API
class Pages < ::API::Base
feature_category :pages
before do
require_pages_config_enabled!
end
params do
requires :id, types: [String, Integer],
desc: 'The ID or URL-encoded path of the project owned by the authenticated user'
end
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
desc 'Unpublish pages' do
detail 'Remove pages. The user must have administrator access. This feature was introduced in GitLab 12.6'
success code: 204
failure [
{ code: 401, message: 'Unauthorized' },
{ code: 404, message: 'Not Found' }
]
tags %w[pages]
end
delete ':id/pages' do
authenticated_with_can_read_all_resources!
authorize! :remove_pages, user_project
::Pages::DeleteService.new(user_project, current_user).execute
no_content!
end
desc 'Update pages settings' do
detail 'Update page settings for a project. User must have administrative access.'
success code: 200
failure [
{ code: 401, message: 'Unauthorized' },
{ code: 404, message: 'Not Found' }
]
tags %w[pages]
end
params do
optional :pages_unique_domain_enabled, type: Boolean, desc: 'Whether to use unique domain'
optional :pages_https_only, type: Boolean, desc: 'Whether to force HTTPS'
end
patch ':id/pages' do
authenticated_with_can_read_all_resources!
authorize! :update_pages, user_project
break not_found! unless user_project.pages_enabled?
response = ::Pages::UpdateService.new(user_project, current_user, params).execute
if response.success?
present ::Pages::ProjectSettings.new(response.payload[:project]), with: Entities::Pages::ProjectSettings
else
forbidden!(response.message)
end
end
desc 'Get pages settings' do
detail 'Get pages URL and other settings. This feature was introduced in Gitlab 16.8'
success code: 200
failure [
{ code: 401, message: 'Unauthorized' },
{ code: 404, message: 'Not Found' }
]
tags %w[pages]
end
get ':id/pages' do
authorize! :read_pages, user_project
break not_found! unless user_project.pages_enabled?
present ::Pages::ProjectSettings.new(user_project), with: Entities::Pages::ProjectSettings
end
end
end
end
|
