summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorNick Thomas <nick@gitlab.com>2018-09-26 11:58:58 +0100
committerNick Thomas <nick@gitlab.com>2018-10-19 01:39:59 +0100
commit34480bb8501eaf1c5b71284fc9cd2bcdbf04fdea (patch)
tree03aa9679b382df634b72eac48e3cc6ca48e5ce2e /doc/api
parent57b4884e621ab51e4aacfed771985d178bc50a3a (diff)
downloadgitlab-ce-34480bb8501eaf1c5b71284fc9cd2bcdbf04fdea.tar.gz
Backport CE to changes to support group-level file templates
When the feature is available, this setting allows admins to choose a project as a source of custom file templates. This is in addition to any instance-wide templates, whether custom or vendored into the GitLab codebase.
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/groups.md7
-rw-r--r--doc/api/project_templates.md16
2 files changed, 17 insertions, 6 deletions
diff --git a/doc/api/groups.md b/doc/api/groups.md
index be75c363a40..a9462fc413f 100644
--- a/doc/api/groups.md
+++ b/doc/api/groups.md
@@ -37,6 +37,7 @@ GET /groups
"request_access_enabled": false,
"full_name": "Foobar Group",
"full_path": "foo-bar",
+ "file_template_project_id": 1,
"parent_id": null
}
]
@@ -62,6 +63,7 @@ GET /groups?statistics=true
"request_access_enabled": false,
"full_name": "Foobar Group",
"full_path": "foo-bar",
+ "file_template_project_id": 1,
"parent_id": null,
"statistics": {
"storage_size" : 212,
@@ -122,6 +124,7 @@ GET /groups/:id/subgroups
"request_access_enabled": false,
"full_name": "Foobar Group",
"full_path": "foo-bar",
+ "file_template_project_id": 1,
"parent_id": 123
}
]
@@ -232,6 +235,7 @@ Example response:
"request_access_enabled": false,
"full_name": "Twitter",
"full_path": "twitter",
+ "file_template_project_id": 1,
"parent_id": null,
"projects": [
{
@@ -386,6 +390,7 @@ Example response:
"request_access_enabled": false,
"full_name": "Twitter",
"full_path": "twitter",
+ "file_template_project_id": 1,
"parent_id": null
}
```
@@ -442,6 +447,7 @@ PUT /groups/:id
| `visibility` | string | no | The visibility level of the group. Can be `private`, `internal`, or `public`. |
| `lfs_enabled` (optional) | boolean | no | Enable/disable Large File Storage (LFS) for the projects in this group |
| `request_access_enabled` | boolean | no | Allow users to request member access. |
+| `file_template_project_id` | integer | no | **(Premium)** The ID of a project to load custom file templates from |
```bash
curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/groups/5?name=Experimental"
@@ -462,6 +468,7 @@ Example response:
"request_access_enabled": false,
"full_name": "Foobar Group",
"full_path": "foo-bar",
+ "file_template_project_id": 1,
"parent_id": null,
"projects": [
{
diff --git a/doc/api/project_templates.md b/doc/api/project_templates.md
index ebdfa975849..ef98205cd68 100644
--- a/doc/api/project_templates.md
+++ b/doc/api/project_templates.md
@@ -1,19 +1,23 @@
# Project templates API
-This API is a project-specific implementation of these endpoints:
+This API is a project-specific version of these endpoints:
- [Dockerfile templates](templates/dockerfiles.md)
- [Gitignore templates](templates/gitignores.md)
- [GitLab CI Config templates](templates/gitlab_ci_ymls.md)
- [Open source license templates](templates/licenses.md)
-It deprecates those endpoints, which will be removed for API version 5.
+It deprecates these endpoints, which will be removed for API version 5.
-Project-specific templates will be added to this API in time. This includes, but
-is not limited to:
+In addition to templates common to the entire instance, project-specific
+templates are also available from this API endpoint.
-- [Issue and Merge Request templates](../user/project/description_templates.html)
-- [Group level file templates](https://gitlab.com/gitlab-org/gitlab-ee/issues/5987) **(Premium)**
+Support will be added for [Issue and Merge Request templates](../user/project/description_templates.md)
+in a future release.
+
+Support for [Group-level file templates](../user/group/index.md#group-level-file-templates-premium)
+**[PREMIUM]** was [added](https://gitlab.com/gitlab-org/gitlab-ee/issues/5987)
+in GitLab 11.5
## Get all templates of a particular type