2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2018-05-09 12:01:36 +05:30
module API
module Helpers
module ProjectsHelpers
extend ActiveSupport :: Concern
2019-09-04 21:01:54 +05:30
extend Grape :: API :: Helpers
2018-05-09 12:01:36 +05:30
2019-09-04 21:01:54 +05:30
params :optional_project_params_ce do
optional :description , type : String , desc : 'The description of the project'
2019-09-30 21:07:59 +05:30
optional :build_git_strategy , type : String , values : %w( fetch clone ) , desc : 'The Git strategy. Defaults to `fetch`'
optional :build_timeout , type : Integer , desc : 'Build timeout'
optional :auto_cancel_pending_pipelines , type : String , values : %w( disabled enabled ) , desc : 'Auto-cancel pending pipelines'
optional :build_coverage_regex , type : String , desc : 'Test coverage parsing'
2019-09-04 21:01:54 +05:30
optional :ci_config_path , type : String , desc : 'The path to CI config file. Defaults to `.gitlab-ci.yml`'
2019-09-30 21:07:59 +05:30
# TODO: remove in API v5, replaced by *_access_level
2019-09-04 21:01:54 +05:30
optional :issues_enabled , type : Boolean , desc : 'Flag indication if the issue tracker is enabled'
optional :merge_requests_enabled , type : Boolean , desc : 'Flag indication if merge requests are enabled'
optional :wiki_enabled , type : Boolean , desc : 'Flag indication if the wiki is enabled'
optional :jobs_enabled , type : Boolean , desc : 'Flag indication if jobs are enabled'
optional :snippets_enabled , type : Boolean , desc : 'Flag indication if snippets are enabled'
2019-09-30 21:07:59 +05:30
optional :issues_access_level , type : String , values : %w( disabled private enabled ) , desc : 'Issues access level. One of `disabled`, `private` or `enabled`'
optional :repository_access_level , type : String , values : %w( disabled private enabled ) , desc : 'Repository access level. One of `disabled`, `private` or `enabled`'
optional :merge_requests_access_level , type : String , values : %w( disabled private enabled ) , desc : 'Merge requests access level. One of `disabled`, `private` or `enabled`'
optional :wiki_access_level , type : String , values : %w( disabled private enabled ) , desc : 'Wiki access level. One of `disabled`, `private` or `enabled`'
optional :builds_access_level , type : String , values : %w( disabled private enabled ) , desc : 'Builds access level. One of `disabled`, `private` or `enabled`'
optional :snippets_access_level , type : String , values : %w( disabled private enabled ) , desc : 'Snippets access level. One of `disabled`, `private` or `enabled`'
2020-03-13 15:44:24 +05:30
optional :pages_access_level , type : String , values : %w( disabled private enabled public ) , desc : 'Pages access level. One of `disabled`, `private`, `enabled` or `public`'
2019-09-30 21:07:59 +05:30
2020-03-13 15:44:24 +05:30
optional :emails_disabled , type : Boolean , desc : 'Disable email notifications'
2019-09-04 21:01:54 +05:30
optional :shared_runners_enabled , type : Boolean , desc : 'Flag indication if shared runners are enabled for that project'
optional :resolve_outdated_diff_discussions , type : Boolean , desc : 'Automatically resolve merge request diffs discussions on lines changed with a push'
2019-12-26 22:10:19 +05:30
optional :remove_source_branch_after_merge , type : Boolean , desc : 'Remove the source branch by default after merge'
2019-09-04 21:01:54 +05:30
optional :container_registry_enabled , type : Boolean , desc : 'Flag indication if the container registry is enabled for that project'
2020-03-13 15:44:24 +05:30
optional :container_expiration_policy_attributes , type : Hash do
use :optional_container_expiration_policy_params
end
2019-09-04 21:01:54 +05:30
optional :lfs_enabled , type : Boolean , desc : 'Flag indication if Git LFS is enabled for that project'
optional :visibility , type : String , values : Gitlab :: VisibilityLevel . string_values , desc : 'The visibility of the project.'
optional :public_builds , type : Boolean , desc : 'Perform public builds'
optional :request_access_enabled , type : Boolean , desc : 'Allow users to request member access'
optional :only_allow_merge_if_pipeline_succeeds , type : Boolean , desc : 'Only allow to merge if builds succeed'
optional :only_allow_merge_if_all_discussions_are_resolved , type : Boolean , desc : 'Only allow to merge if all discussions are resolved'
optional :tag_list , type : Array [ String ] , desc : 'The list of tags for a project'
2019-12-04 20:38:33 +05:30
# TODO: remove rubocop disable - https://gitlab.com/gitlab-org/gitlab/issues/14960
optional :avatar , type : File , desc : 'Avatar image for project' # rubocop:disable Scalability/FileUploads
2019-09-04 21:01:54 +05:30
optional :printing_merge_request_link_enabled , type : Boolean , desc : 'Show link to create/view merge request when pushing from the command line'
optional :merge_method , type : String , values : %w( ff rebase_merge merge ) , desc : 'The merge method used when merging merge requests'
2020-03-13 15:44:24 +05:30
optional :suggestion_commit_message , type : String , desc : 'The commit message used to apply merge request suggestions'
2019-09-04 21:01:54 +05:30
optional :initialize_with_readme , type : Boolean , desc : " Initialize a project with a README.md "
optional :ci_default_git_depth , type : Integer , desc : 'Default number of revisions for shallow cloning'
2019-09-30 21:07:59 +05:30
optional :auto_devops_enabled , type : Boolean , desc : 'Flag indication if Auto DevOps is enabled'
optional :auto_devops_deploy_strategy , type : String , values : %w( continuous manual timed_incremental ) , desc : 'Auto Deploy strategy'
2020-03-13 15:44:24 +05:30
optional :autoclose_referenced_issues , type : Boolean , desc : 'Flag indication if referenced issues auto-closing is enabled'
2019-09-04 21:01:54 +05:30
end
params :optional_project_params_ee do
end
2019-07-07 11:18:12 +05:30
2019-09-04 21:01:54 +05:30
params :optional_project_params do
use :optional_project_params_ce
use :optional_project_params_ee
end
2019-12-04 20:38:33 +05:30
params :optional_create_project_params_ee do
end
params :optional_create_project_params do
use :optional_project_params
use :optional_create_project_params_ee
end
2019-09-04 21:01:54 +05:30
params :optional_filter_params_ee do
end
2018-05-09 12:01:36 +05:30
2019-09-04 21:01:54 +05:30
params :optional_update_params_ee do
2018-05-09 12:01:36 +05:30
end
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
params :optional_container_expiration_policy_params do
optional :cadence , type : String , desc : 'Container expiration policy cadence for recurring job'
optional :keep_n , type : String , desc : 'Container expiration policy number of images to keep'
optional :older_than , type : String , desc : 'Container expiration policy remove images older than value'
optional :name_regex , type : String , desc : 'Container expiration policy regex for image removal'
optional :enabled , type : Boolean , desc : 'Flag indication if container expiration policy is enabled'
end
2019-07-07 11:18:12 +05:30
def self . update_params_at_least_one_of
[
2020-03-13 15:44:24 +05:30
:autoclose_referenced_issues ,
2019-09-30 21:07:59 +05:30
:auto_devops_enabled ,
:auto_devops_deploy_strategy ,
:auto_cancel_pending_pipelines ,
:build_coverage_regex ,
:build_git_strategy ,
:build_timeout ,
:builds_access_level ,
2019-07-07 11:18:12 +05:30
:ci_config_path ,
2019-09-30 21:07:59 +05:30
:ci_default_git_depth ,
2019-07-07 11:18:12 +05:30
:container_registry_enabled ,
2020-03-13 15:44:24 +05:30
:container_expiration_policy_attributes ,
2019-07-07 11:18:12 +05:30
:default_branch ,
:description ,
2020-03-13 15:44:24 +05:30
:emails_disabled ,
2019-09-30 21:07:59 +05:30
:issues_access_level ,
2019-07-07 11:18:12 +05:30
:lfs_enabled ,
2019-09-30 21:07:59 +05:30
:merge_requests_access_level ,
2019-07-07 11:18:12 +05:30
:merge_method ,
:name ,
:only_allow_merge_if_all_discussions_are_resolved ,
:only_allow_merge_if_pipeline_succeeds ,
2020-03-13 15:44:24 +05:30
:pages_access_level ,
2019-07-07 11:18:12 +05:30
:path ,
:printing_merge_request_link_enabled ,
:public_builds ,
2019-12-26 22:10:19 +05:30
:remove_source_branch_after_merge ,
2019-09-30 21:07:59 +05:30
:repository_access_level ,
2019-07-07 11:18:12 +05:30
:request_access_enabled ,
2019-09-30 21:07:59 +05:30
:resolve_outdated_diff_discussions ,
2019-07-07 11:18:12 +05:30
:shared_runners_enabled ,
2019-09-30 21:07:59 +05:30
:snippets_access_level ,
2019-07-07 11:18:12 +05:30
:tag_list ,
:visibility ,
2019-09-30 21:07:59 +05:30
:wiki_access_level ,
2019-07-07 11:18:12 +05:30
:avatar ,
2020-03-13 15:44:24 +05:30
:suggestion_commit_message ,
2019-09-30 21:07:59 +05:30
# TODO: remove in API v5, replaced by *_access_level
:issues_enabled ,
:jobs_enabled ,
:merge_requests_enabled ,
:wiki_enabled ,
:snippets_enabled
2019-07-07 11:18:12 +05:30
]
end
2019-09-30 21:07:59 +05:30
def filter_attributes_using_license! ( attrs )
end
2018-05-09 12:01:36 +05:30
end
end
end
2019-12-04 20:38:33 +05:30
API :: Helpers :: ProjectsHelpers . prepend_if_ee ( 'EE::API::Helpers::ProjectsHelpers' )