summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2019-09-19 06:06:09 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2019-09-19 06:06:09 +0000
commit82a534c245f830d7692d03c557075f211bec6e75 (patch)
tree13ea86d520326d6a36e562bcca889cdeb1e4cde5 /doc/api
parent2c352d252d072549e77d9de71fb9efe7bae94da6 (diff)
downloadgitlab-ce-82a534c245f830d7692d03c557075f211bec6e75.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/projects.md5
-rw-r--r--doc/api/protected_branches.md38
2 files changed, 28 insertions, 15 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md
index 4aae101791b..38c3708c7e5 100644
--- a/doc/api/projects.md
+++ b/doc/api/projects.md
@@ -931,9 +931,13 @@ POST /projects
| `auto_devops_deploy_strategy` | string | no | Auto Deploy strategy (`continuous`, `manual` or `timed_incremental`) |
| `repository_storage` | string | no | **(STARTER ONLY)** Which storage shard the repository is on. Available only to admins |
| `approvals_before_merge` | integer | no | **(STARTER)** How many approvers should approve merge requests by default |
+| `external_authorization_classification_label` | string | no | **(PREMIUM)** The classification label for the project |
| `mirror` | boolean | no | **(STARTER)** Enables pull mirroring in a project |
| `mirror_trigger_builds` | boolean | no | **(STARTER)** Pull mirroring triggers builds |
| `initialize_with_readme` | boolean | no | `false` by default |
+| `template_name` | string | no | When used without `use_custom_template`, name of a [built-in project template](../gitlab-basics/create-project.md#built-in-templates). When used with `use_custom_template`, name of a custom project template |
+| `use_custom_template` | boolean | no | **(PREMIUM)** Use either custom [instance](../user/admin_area/custom_project_templates.md) or [group](../user/group/custom_project_templates.md) (with `group_with_project_templates_id`) project template |
+| `group_with_project_templates_id` | integer | no | **(PREMIUM)** For group-level custom templates, specifies ID of group from which all the custom project templates are sourced. Leave empty for instance-level templates. Requires `use_custom_template` to be true |
NOTE: **Note:** If your HTTP repository is not publicly accessible,
add authentication information to the URL: `https://username:password@gitlab.company.com/group/project.git`
@@ -991,6 +995,7 @@ POST /projects/user/:user_id
| `external_authorization_classification_label` | string | no | **(PREMIUM)** The classification label for the project |
| `mirror` | boolean | no | **(STARTER)** Enables pull mirroring in a project |
| `mirror_trigger_builds` | boolean | no | **(STARTER)** Pull mirroring triggers builds |
+| `initialize_with_readme` | boolean | no | `false` by default |
| `template_name` | string | no | When used without `use_custom_template`, name of a [built-in project template](../gitlab-basics/create-project.md#built-in-templates). When used with `use_custom_template`, name of a custom project template |
| `use_custom_template` | boolean | no | **(PREMIUM)** Use either custom [instance](../user/admin_area/custom_project_templates.md) or [group](../user/group/custom_project_templates.md) (with `group_with_project_templates_id`) project template |
| `group_with_project_templates_id` | integer | no | **(PREMIUM)** For group-level custom templates, specifies ID of group from which all the custom project templates are sourced. Leave empty for instance-level templates. Requires `use_custom_template` to be true |
diff --git a/doc/api/protected_branches.md b/doc/api/protected_branches.md
index a14c9046ca7..debf1b264f9 100644
--- a/doc/api/protected_branches.md
+++ b/doc/api/protected_branches.md
@@ -46,7 +46,8 @@ Example response:
"access_level": 40,
"access_level_description": "Maintainers"
}
- ]
+ ],
+ "code_owner_approval_required": "false"
},
...
]
@@ -76,7 +77,8 @@ Example response:
"group_id": 1234,
"access_level_description": "Example Merge Group"
}
- ]
+ ],
+ "code_owner_approval_required": "false"
},
...
]
@@ -115,7 +117,8 @@ Example response:
"access_level": 40,
"access_level_description": "Maintainers"
}
- ]
+ ],
+ "code_owner_approval_required": "false"
}
```
@@ -142,7 +145,8 @@ Example response:
"group_id": 1234,
"access_level_description": "Example Merge Group"
}
- ]
+ ],
+ "code_owner_approval_required": "false"
}
```
@@ -161,14 +165,15 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitla
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
-| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
-| `name` | string | yes | The name of the branch or wildcard |
-| `push_access_level` | string | no | Access levels allowed to push (defaults: `40`, maintainer access level) |
-| `merge_access_level` | string | no | Access levels allowed to merge (defaults: `40`, maintainer access level) |
-| `unprotect_access_level` | string | no | Access levels allowed to unprotect (defaults: `40`, maintainer access level) |
-| `allowed_to_push` | array | no | **(STARTER)** Array of access levels allowed to push, with each described by a hash |
-| `allowed_to_merge` | array | no | **(STARTER)** Array of access levels allowed to merge, with each described by a hash |
-| `allowed_to_unprotect` | array | no | **(STARTER)**Array of access levels allowed to unprotect, with each described by a hash |
+| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
+| `name` | string | yes | The name of the branch or wildcard |
+| `push_access_level` | string | no | Access levels allowed to push (defaults: `40`, maintainer access level) |
+| `merge_access_level` | string | no | Access levels allowed to merge (defaults: `40`, maintainer access level) |
+| `unprotect_access_level` | string | no | Access levels allowed to unprotect (defaults: `40`, maintainer access level) |
+| `allowed_to_push` | array | no | **(STARTER)** Array of access levels allowed to push, with each described by a hash |
+| `allowed_to_merge` | array | no | **(STARTER)** Array of access levels allowed to merge, with each described by a hash |
+| `allowed_to_unprotect` | array | no | **(STARTER)** Array of access levels allowed to unprotect, with each described by a hash |
+| `code_owner_approval_required` | boolean | no | **(PREMIUM)** Prevent pushes to this branch if it matches an item in the [`CODEOWNERS` file](../user/project/code_owners.md). (defaults: false) |
Example response:
@@ -192,7 +197,8 @@ Example response:
"access_level": 40,
"access_level_description": "Maintainers"
}
- ]
+ ],
+ "code_owner_approval_required": "false"
}
```
@@ -227,7 +233,8 @@ Example response:
"group_id": null,
"access_level_description": "Maintainers"
}
- ]
+ ],
+ "code_owner_approval_required": "false"
}
```
@@ -268,7 +275,8 @@ Example response:
"group_id": null,
"access_level_description": "Maintainers"
}
- ]
+ ],
+ "code_owner_approval_required": "false"
}
```