diff options
Diffstat (limited to 'Documentation/rest-api-projects.txt')
-rw-r--r-- | Documentation/rest-api-projects.txt | 106 |
1 files changed, 106 insertions, 0 deletions
diff --git a/Documentation/rest-api-projects.txt b/Documentation/rest-api-projects.txt index 9aba0e9133..35caac4114 100644 --- a/Documentation/rest-api-projects.txt +++ b/Documentation/rest-api-projects.txt @@ -408,6 +408,58 @@ link:#repository-statistics-info[RepositoryStatisticsInfo] entity. } ---- +[[get-config]] +Get Config +~~~~~~~~~~ +[verse] +'GET /projects/link:#project-name[\{project-name\}]/config' + +Gets some configuration information about a project. Note that this +config info is not simply the contents of `project.config`; it generally +contains fields that may have been inherited from parent projects. + +.Request +---- + GET /projects/myproject/config +---- + +A link:#config-info[ConfigInfo] entity is returned that describes the +project configuration. Some fields are only visible to users that have +read access to `refs/meta/config`. + +.Response +---- + HTTP/1.1 200 OK + Content-Disposition: attachment + Content-Type: application/json;charset=UTF-8 + + )]}' + { + "kind": "gerritcodereview#project_config", + "use_contributor_agreements": { + "value": true, + "configured_value": "TRUE", + "inherited_value": false + }, + "use_content_merge": { + "value": true, + "configured_value": "INHERIT", + "inherited_value": true + }, + "use_signed_off_by": { + "value": false, + "configured_value": "INHERIT", + "inherited_value": false + }, + "require_change_id": { + "value": false, + "configured_value": "FALSE", + "inherited_value": true + } + "commentlinks": {} + } +---- + [[run-gc]] Run GC ~~~~~~ @@ -693,6 +745,43 @@ The name of the project. JSON Entities ------------- +[[config-info]] +ConfigInfo +~~~~~~~~~~ +The `ConfigInfo` entity contains information about the effective project +configuration. + +Fields marked with * are only visible to users who have read access to +`refs/meta/config`. + +[options="header",width="50%",cols="1,6"] +|====================================== +|Field Name |Description +|`use_contributor_agreements*`| +link:#inherited-boolean-info[InheritedBooleanInfo] that tells whether +authors must complete a contributor agreement on the site before +pushing any commits or changes to this project. +|`use_content_merge*`| +link:#inherited-boolean-info[InheritedBooleanInfo] that tells whether +Gerrit will try to perform a 3-way merge of text file content when a +file has been modified by both the destination branch and the change +being submitted. This option only takes effect if submit type is not +FAST_FORWARD_ONLY. +|`use_signed_off_by*`| +link:#inherited-boolean-info[InheritedBooleanInfo] that tells whether +each change must contain a Signed-off-by line from either the author or +the uploader in the commit message. +|`require_change_id*`| +link:#inherited-boolean-info[InheritedBooleanInfo] that tells whether a +valid link:user-changeid.html[Change-Id] footer in any commit uploaded +for review is required. This does not apply to commits pushed directly +to a branch or tag. +|`commentlinks`| +Comment link configuration for the project. Has the same format as the +link:config-gerrit.html#_a_id_commentlink_a_section_commentlink[commentlink section] +of `gerrit.config`. +|====================================== + [[dashboard-info]] DashboardInfo ~~~~~~~~~~~~~ @@ -775,6 +864,23 @@ The ref to which `HEAD` should be set, the `refs/heads` prefix can be omitted. |============================ +[[inherited-boolean-info]] +InheritedBooleanInfo +~~~~~~~~~~~~~~~~~~~~ +A boolean value that can also be inherited. + +[options="header",width="50%",cols="1,^2,4"] +|================================ +|Field Name ||Description +|`value` || +The effective boolean value. +|`configured_value` || +The configured value, can be `TRUE`, `FALSE` or `INHERITED`. +|`inherited_value` |optional| +The boolean value inherited from the parent. + +Not set if there is no parent. +|================================ + [[project-description-input]] ProjectDescriptionInput ~~~~~~~~~~~~~~~~~~~~~~~ |