Coverage for src/gitlabracadabra/objects/project.py: 80%

1# 

2# Copyright (C) 2019-2025 Mathieu Parent <math.parent@gmail.com> 

3# 

4# This program is free software: you can redistribute it and/or modify 

5# it under the terms of the GNU Lesser General Public License as published by 

6# the Free Software Foundation, either version 3 of the License, or 

7# (at your option) any later version. 

8# 

9# This program is distributed in the hope that it will be useful, 

10# but WITHOUT ANY WARRANTY; without even the implied warranty of 

11# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

12# GNU Lesser General Public License for more details. 

13# 

14# You should have received a copy of the GNU Lesser General Public License 

15# along with this program. If not, see <http://www.gnu.org/licenses/>. 

16 

17import logging 

18from http import HTTPStatus 

19from typing import ClassVar 

20 

21from gitlab.exceptions import GitlabListError 

22 

23from gitlabracadabra.gitlab.access_levels import access_level_value 

24from gitlabracadabra.mixins.boards import BoardsMixin 

25from gitlabracadabra.mixins.groups import GroupsMixin 

26from gitlabracadabra.mixins.image_mirrors import ImageMirrorsMixin 

27from gitlabracadabra.mixins.labels import LabelsMixin 

28from gitlabracadabra.mixins.members import MembersMixin 

29from gitlabracadabra.mixins.milestones import MilestonesMixin 

30from gitlabracadabra.mixins.mirrors import MirrorsMixin 

31from gitlabracadabra.mixins.package_mirrors import PackageMirrorsMixin 

32from gitlabracadabra.mixins.pipeline_schedules import PipelineSchedulesMixin 

33from gitlabracadabra.mixins.protected_branches import ProtectedBranchesMixin 

34from gitlabracadabra.mixins.rename_branches import RenameBranchesMixin 

35from gitlabracadabra.mixins.variables import VariablesMixin 

36from gitlabracadabra.mixins.webhooks import WebhooksMixin 

37from gitlabracadabra.objects.object import GitLabracadabraObject 

38 

39logger = logging.getLogger(__name__) 

40 

41 

42class GitLabracadabraProject( 

43 BoardsMixin, 

44 GroupsMixin, 

45 ImageMirrorsMixin, 

46 LabelsMixin, 

47 MembersMixin, 

48 MilestonesMixin, 

49 MirrorsMixin, 

50 PackageMirrorsMixin, 

51 PipelineSchedulesMixin, 

52 ProtectedBranchesMixin, 

53 RenameBranchesMixin, 

54 VariablesMixin, 

55 WebhooksMixin, 

56 GitLabracadabraObject, 

57): 

58 EXAMPLE_YAML_HEADER: ClassVar[str] = "mygroup/myproject:\n" 

59 DOC: ClassVar[list[str]] = [ 

60 "# Project lifecycle", 

61 "gitlab_id", 

62 "create_object", 

63 "delete_object", 

64 "initialize_with_readme", 

65 "repository_object_format", 

66 "# Manage", 

67 "## Members", 

68 "members", 

69 "unknown_members", 

70 "groups", 

71 "unknown_groups", 

72 "## Labels", 

73 "labels", 

74 "unknown_labels", 

75 "# Plan", 

76 "## Issue boards", 

77 "boards", 

78 "unknown_boards", 

79 "unknown_board_lists", 

80 "## Milestones", 

81 "milestones", 

82 "unknown_milestones", 

83 # '## Iterations', 

84 "# Code", 

85 "## Branches", 

86 "branches", 

87 "rename_branches", 

88 "# Build", 

89 "## Pipeline schedules", 

90 "pipeline_schedules", 

91 "unknown_pipeline_schedules", 

92 "unknown_pipeline_schedule_variables", 

93 "# Settings", 

94 "## General Settings", 

95 "### Naming, description, topics", 

96 "name", 

97 "description", 

98 "topics", 

99 # 'avatar', # FIXME: Gitlabracadabra 

100 "### Visibility, project features, permissions", 

101 "visibility", 

102 "request_access_enabled", 

103 "issues_access_level", 

104 # 'cve_id_request_enabled', # FIXME: GitLab 

105 "repository_access_level", 

106 "merge_requests_access_level", 

107 "forking_access_level", 

108 "lfs_enabled", 

109 "builds_access_level", 

110 "container_registry_access_level", 

111 "analytics_access_level", 

112 "requirements_access_level", 

113 "security_and_compliance_access_level", 

114 "wiki_access_level", 

115 "snippets_access_level", 

116 "packages_enabled", 

117 "model_experiments_access_level", 

118 "model_registry_access_level", 

119 "pages_access_level", 

120 "monitor_access_level", 

121 "environments_access_level", 

122 "feature_flags_access_level", 

123 "infrastructure_access_level", 

124 "releases_access_level", 

125 # 'duo_features_enabled', # FIXME: Gitlab 

126 "emails_enabled", 

127 # 'show_diff_preview_in_email', # FIXME: Gitlab 

128 # 'show_default_award_emojis', # FIXME: Gitlab 

129 # 'ci_resources_enabled', # FIXME: Gitlab 

130 # '### Badges', 

131 "### Default description template for issues", 

132 "issues_template", 

133 "### Service Desk", 

134 "service_desk_enabled", 

135 # 'service_desk_...', # FIXME: Gitlab 

136 "### Advanced", 

137 "archived", 

138 # '## Integrations', # FIXME: section 

139 "## Webhooks", 

140 "webhooks", 

141 "unknown_webhooks", 

142 "## Repository", 

143 "### Branch defaults", 

144 "default_branch", 

145 "autoclose_referenced_issues", 

146 "issue_branch_template", 

147 # '### Branch Rules', # FIXME: ... 

148 # '### Push Rules', # FIXME: ... 

149 "### Mirroring repositories", 

150 "mirror", 

151 "import_url", 

152 "mirror_user_id", 

153 "mirror_overwrites_diverged_branches", 

154 "mirror_trigger_builds", 

155 "only_mirror_protected_branches", 

156 "### Protected Branches", 

157 "protected_branches", 

158 "unknown_protected_branches", 

159 "### Protected Tags", 

160 "protected_tags", 

161 "unknown_protected_tags", 

162 # '### Deploy Keys', # FIXME: ... 

163 # '### Deploy Tokens', # FIXME: ... 

164 "## Merge requests", 

165 "### Merge requests", 

166 "merge_method", 

167 "merge_pipelines_enabled", 

168 "merge_trains_enabled", 

169 # 'merge_trains_skip_train_allowed', # FIXME: GitLab 

170 "resolve_outdated_diff_discussions", 

171 "printing_merge_request_link_enabled", 

172 "remove_source_branch_after_merge", 

173 "squash_option", 

174 "only_allow_merge_if_pipeline_succeeds", 

175 "allow_merge_on_skipped_pipeline", 

176 "only_allow_merge_if_all_discussions_are_resolved", 

177 "only_allow_merge_if_all_status_checks_passed", 

178 "suggestion_commit_message", 

179 "merge_commit_template", 

180 "squash_commit_template", 

181 "merge_requests_template", 

182 "### Merge request approvals", # FIXME: ... 

183 "approvals_before_merge", 

184 "## CI / CD Settings", 

185 "### General pipelines", 

186 "public_jobs", 

187 "auto_cancel_pending_pipelines", 

188 "ci_forward_deployment_enabled", 

189 "ci_forward_deployment_rollback_allowed", 

190 "ci_separated_caches", 

191 "ci_restrict_pipeline_cancellation_role", 

192 "ci_config_path", 

193 "build_git_strategy", 

194 "ci_default_git_depth", 

195 "build_timeout", 

196 "ci_allow_fork_pipelines_to_run_in_parent_project", 

197 "### Auto DevOps", 

198 "auto_devops_enabled", 

199 "auto_devops_deploy_strategy", 

200 "### Protected Environments", 

201 # FIXME: ... 

202 "allow_pipeline_trigger_approve_deployment", 

203 "### Runners", 

204 "shared_runners_enabled", 

205 "group_runners_enabled", 

206 "### Artifacts", 

207 "keep_latest_artifact", 

208 "### Variables", 

209 "variables", 

210 "unknown_variables", 

211 # '### Pipeline trigger tokens', # FIXME: section 

212 # '### Automatic deployment rollbacks', # FIXME: section 

213 # 'auto_rollback_enabled', # FIXME: GitLab 

214 # '### Deploy freezes', # FIXME: section 

215 # '### Job token permissions', # FIXME: section 

216 # '### Secure files', # FIXME: section 

217 # '### Pipeline subscriptions', # FIXME: section 

218 "## Packages and registries", 

219 "### Cleanup policies", 

220 "container_expiration_policy", 

221 "# Mirroring repositories, packages and container images", 

222 "mirrors", 

223 "package_mirrors", 

224 "image_mirrors", 

225 "# Deprecated", 

226 "build_coverage_regex", 

227 "container_registry_enabled", 

228 "emails_disabled", 

229 "issues_enabled", 

230 "jobs_enabled", 

231 "merge_requests_enabled", 

232 "public_builds", 

233 "snippets_enabled", 

234 "tag_list", 

235 "wiki_enabled", 

236 ] 

237 SCHEMA: ClassVar[dict] = { 

238 "$schema": "http://json-schema.org/draft-04/schema#", 

239 "title": "Project", 

240 "type": "object", 

241 "properties": { 

242 "gitlab_id": { 

243 "type": "string", 

244 "description": "GitLab id", 

245 "_example": "gitlab", 

246 "_doc_link": "action_file.md#gitlab_id", 

247 }, 

248 "create_object": { 

249 "type": "boolean", 

250 "description": "Create object if it does not exists", 

251 }, 

252 "delete_object": { 

253 "type": "boolean", 

254 "description": "Delete object if it exists", 

255 }, 

256 # From https://docs.gitlab.com/ee/api/projects.html#create-project 

257 # and https://docs.gitlab.com/ee/api/projects.html#edit-project 

258 "initialize_with_readme": { 

259 "type": "boolean", 

260 "description": "false by default", 

261 }, 

262 "repository_object_format": { 

263 "type": "string", 

264 "description": "Repository object format", 

265 "enum": ["sha1", "sha256"], 

266 }, 

267 # From https://docs.gitlab.com/ee/api/members.html#add-a-member-to-a-group-or-project 

268 # FIXME: expires_at not supported 

269 "members": { 

270 "type": "object", 

271 "description": "Members", 

272 "additionalProperties": { 

273 "type": "string", 

274 "description": "The permissions level to grant the member.", 

275 "enum": ["guest", "reporter", "developer", "maintainer", "owner"], 

276 }, 

277 "_example": ( 

278 "\n foo: developer\n bar: maintainer # one of guest, reporter, developer, maintainer, owner\n" 

279 ), 

280 }, 

281 "unknown_members": { # GitLabracadabra 

282 "type": "string", 

283 "description": "What to do with unknown members (`warn` by default).", 

284 "enum": ["warn", "delete", "remove", "ignore", "skip"], 

285 }, 

286 # From https://docs.gitlab.com/ee/api/projects.html#share-project-with-group_access_level 

287 # and https://docs.gitlab.com/ee/api/projects.html#delete-a-shared-project-link-within-a-group 

288 # FIXME: expires_at not supported 

289 "groups": { 

290 "type": "object", 

291 "description": "Groups", 

292 "additionalProperties": { 

293 "type": "string", 

294 "description": "The permissions level to grant the group.", 

295 "enum": ["guest", "reporter", "developer", "maintainer"], 

296 }, 

297 "_example": ( 

298 "\n group/foo: guest\n group/bar: reporter # one of guest, reporter, developer, maintainer\n" 

299 ), 

300 }, 

301 "unknown_groups": { # GitLabracadabra 

302 "type": "string", 

303 "description": "What to do with unknown groups (`warn` by default).", 

304 "enum": ["warn", "delete", "remove", "ignore", "skip"], 

305 }, 

306 # From https://docs.gitlab.com/ee/api/labels.html#create-a-new-label 

307 "labels": { 

308 "type": "array", 

309 "description": "The list of project's labels", 

310 "items": { 

311 "type": "object", 

312 "properties": { 

313 "name": { 

314 "type": "string", 

315 "description": "The name of the label.", 

316 }, 

317 "color": { 

318 "type": "string", 

319 "description": "The color of the label.", 

320 }, 

321 "description": { 

322 "type": "string", 

323 "description": "The description of the label.", 

324 }, 

325 "priority": { 

326 "type": "integer", 

327 "description": "The priority of the label.", 

328 }, 

329 }, 

330 "required": ["name"], # color not required to allow priority override 

331 "additionalProperties": False, 

332 }, 

333 "uniqueItems": True, 

334 "_example": ( 

335 "\n" 

336 " - name: critical\n" 

337 " priority: 0\n" 

338 " - name: bug\n" 

339 " priority: 1\n" 

340 " - name: confirmed\n" 

341 " priority: 2\n" 

342 ), 

343 }, 

344 "unknown_labels": { # GitLabracadabra 

345 "type": "string", 

346 "description": "What to do with unknown labels (`warn` by default).", 

347 "enum": ["warn", "delete", "remove", "ignore", "skip"], 

348 }, 

349 # From https://docs.gitlab.com/ee/api/boards.html 

350 "boards": { 

351 "type": "array", 

352 "description": "The list of project's boards", 

353 "items": { 

354 "type": "object", 

355 "properties": { 

356 "name": { 

357 "type": "string", 

358 "description": "The name of the board.", 

359 }, 

360 "old_name": { 

361 "type": "string", 

362 "description": "The previous name of the board.", 

363 }, 

364 "hide_backlog_list": { 

365 "type": "boolean", 

366 "description": "Hide the Open list", 

367 }, 

368 "hide_closed_list": { 

369 "type": "boolean", 

370 "description": "Hide the Closed list", 

371 }, 

372 "lists": { 

373 "type": "array", 

374 "description": "Ordered list of labels", 

375 "items": { 

376 "type": "object", 

377 "properties": { 

378 "label": { 

379 "type": "string", 

380 "description": "The name of a label", 

381 }, 

382 }, 

383 }, 

384 }, 

385 "unknown_lists": { # GitLabracadabra 

386 "type": "string", 

387 "description": ( 

388 "What to do with unknown board lists (Value of `unknown_board_lists` by default)." 

389 ), 

390 "enum": ["warn", "delete", "remove", "ignore", "skip"], 

391 }, 

392 }, 

393 "required": ["name"], 

394 "additionalProperties": False, 

395 }, 

396 "uniqueItems": True, 

397 "_example": ( 

398 "\n" 

399 " - name: My Board\n" 

400 " # old_name: Development # Use this to rename a board\n" 

401 " hide_backlog_list: false\n" 

402 " hide_closed_list: false\n" 

403 " lists:\n" 

404 " - label: TODO\n" 

405 " - label: WIP\n" 

406 ), 

407 }, 

408 "unknown_boards": { # GitLabracadabra 

409 "type": "string", 

410 "description": "What to do with unknown boards (`warn` by default).", 

411 "enum": ["warn", "delete", "remove", "ignore", "skip"], 

412 }, 

413 "unknown_board_lists": { # GitLabracadabra 

414 "type": "string", 

415 "description": "What to do with unknown board lists (`delete` by default).", 

416 "enum": ["warn", "delete", "remove", "ignore", "skip"], 

417 }, 

418 # From https://docs.gitlab.com/ee/api/milestones.html#edit-milestone 

419 "milestones": { 

420 "type": "array", 

421 "description": "The list of project's milestones", 

422 "items": { 

423 "type": "object", 

424 "properties": { 

425 "title": { 

426 "type": "string", 

427 "description": "The title of a milestone", 

428 }, 

429 "description": { 

430 "type": "string", 

431 "description": "The description of a milestone", 

432 }, 

433 "due_date": { 

434 "type": "string", 

435 "description": "The due date of the milestone", 

436 "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", 

437 }, 

438 "start_date": { 

439 "type": "string", 

440 "description": "The start date of the milestone", 

441 "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", 

442 }, 

443 "state": { 

444 "type": "string", 

445 "description": "The state event of the milestone", 

446 "enum": ["closed", "active"], 

447 }, 

448 }, 

449 "required": ["title"], 

450 "additionalProperties": False, 

451 }, 

452 "uniqueItems": True, 

453 "_example": ( 

454 "\n" 

455 " - title: '1.0'\n" 

456 " description: Version 1.0\n" 

457 " due_date: '2021-01-23' # Quotes are mandatory\n" 

458 " start_date: '2020-01-23' # Quotes are mandatory\n" 

459 " state: active # or closed\n" 

460 ), 

461 }, 

462 "unknown_milestones": { # GitLabracadabra 

463 "type": "string", 

464 "description": "What to do with unknown milestones (`warn` by default).", 

465 "enum": ["warn", "delete", "remove", "ignore", "skip"], 

466 }, 

467 # From https://docs.gitlab.com/ee/api/branches.html#create-repository-branch 

468 "branches": { 

469 "type": "array", 

470 "description": "The list of branches for a project. Branches are created in order", 

471 "items": { 

472 "type": "string", 

473 }, 

474 "uniqueItems": True, 

475 "_example": ("\n - main\n - develop"), 

476 }, 

477 "rename_branches": { 

478 "type": "array", 

479 "description": "Rename branches of a project. Rename pairs (old_name: new_name) are processed in order", 

480 "items": { 

481 "type": "object", 

482 "additionalProperties": { 

483 "type": "string", 

484 "description": "The new branch name.", 

485 }, 

486 "minProperties": 1, 

487 "maxProperties": 1, 

488 }, 

489 "uniqueItems": True, 

490 "_example": ( 

491 "\n" 

492 " - old_name: new_name\n" 

493 " # To Rename consecutive branches:\n" 

494 " - branch2: branch3\n" 

495 " - branch1: branch2" 

496 ), 

497 }, 

498 # From https://docs.gitlab.com/ee/api/pipeline_schedules.html#create-a-new-pipeline-schedule 

499 "pipeline_schedules": { 

500 "type": "array", 

501 "description": "The list of project's pipeline schedules", 

502 "items": { 

503 "type": "object", 

504 "properties": { 

505 "description": { 

506 "type": "string", 

507 "description": "The description of pipeline schedule", 

508 "pattern": "[a-zA-Z0-9_]+", 

509 }, 

510 "ref": { 

511 "type": "string", 

512 "description": "The branch/tag name will be triggered", 

513 }, 

514 "cron": { 

515 "type": "string", 

516 "description": ( 

517 "The cron (e.g. `0 1 * * *`) ([Cron syntax](https://en.wikipedia.org/wiki/Cron))" 

518 ), 

519 }, 

520 "cron_timezone": { 

521 "type": "string", 

522 "description": ( 

523 "The timezone supported by `ActiveSupport::TimeZone` " 

524 "(e.g. `Pacific Time (US & Canada)`) (default: `'UTC'`)" 

525 ), 

526 }, 

527 "active": { 

528 "type": "boolean", 

529 "description": "The activation of pipeline schedule", 

530 }, 

531 # From https://docs.gitlab.com/ee/api/pipeline_schedules.html 

532 # #create-a-new-pipeline-schedule-variable 

533 "variables": { 

534 "type": "array", 

535 "description": "The list of project's variables", 

536 "items": { 

537 "type": "object", 

538 "properties": { 

539 "key": { 

540 "type": "string", 

541 "description": "The key of a variable", 

542 "pattern": "[a-zA-Z0-9_]+", 

543 }, 

544 "value": { 

545 "type": "string", 

546 "description": "The value of a variable", 

547 }, 

548 "variable_type": { 

549 "type": "string", 

550 "description": ( 

551 "The type of a variable. Available types are: env_var (default) and file" 

552 ), 

553 "enum": ["env_var", "file"], 

554 }, 

555 }, 

556 "required": ["key", "value"], 

557 "additionalProperties": False, 

558 }, 

559 "uniqueItems": True, 

560 }, 

561 "unknown_variables": { # GitLabracadabra 

562 "type": "string", 

563 "description": ( 

564 "What to do with unknown pipeline schedule variables " 

565 "(Value of `unknown_pipeline_schedule_variables` by default)." 

566 ), 

567 "enum": ["warn", "delete", "remove", "ignore", "skip"], 

568 }, 

569 }, 

570 "required": ["description", "ref", "cron"], 

571 "additionalProperties": False, 

572 }, 

573 "uniqueItems": True, 

574 "_example": ( 

575 "\n" 

576 " - description: Build packages\n" 

577 " ref: main\n" 

578 " cron: '0 1 * * 5'\n" 

579 " # cron_timezone: UTC\n" 

580 " # active: true\n" 

581 " variables:\n" 

582 " - key: MY_VAR\n" 

583 " value: my value\n" 

584 " # variable_type: env_var # or file\n" 

585 " # unknown_variables: warn # one of warn, delete, remove, ignore, skip\n" 

586 ), 

587 }, 

588 "unknown_pipeline_schedules": { # GitLabracadabra 

589 "type": "string", 

590 "description": "What to do with unknown pipeline schedules (`warn` by default).", 

591 "enum": ["warn", "delete", "remove", "ignore", "skip"], 

592 }, 

593 "unknown_pipeline_schedule_variables": { # GitLabracadabra 

594 "type": "string", 

595 "description": "What to do with unknown pipeline schedule variables (`warn` by default).", 

596 "enum": ["warn", "delete", "remove", "ignore", "skip"], 

597 }, 

598 "name": { 

599 "type": "string", 

600 "description": "Project name", 

601 }, 

602 # 'path': { 

603 # 'type': 'string', 

604 # 'description': 'Repository name for new project. ' 

605 # 'Generated based on name if not provided (generated lowercased with dashes).', 

606 # }, 

607 "description": { 

608 "type": "string", 

609 "description": "Project description", 

610 "_example": "|-\n 🧹 GitLabracadabra 🧙\n\n :alembic: Adds some magic to GitLab :crystal\\_ball:", 

611 }, 

612 "topics": { 

613 "type": "array", 

614 "description": "Topics", 

615 "items": { 

616 "type": "string", 

617 }, 

618 "uniqueItems": True, 

619 "_example": "[GitLab, API, YAML]", 

620 }, 

621 # 'avatar': { 

622 # 'type': 'string', 

623 # 'description': 'Project avatar', 

624 # }, 

625 "visibility": { 

626 "type": "string", 

627 "description": "Project visibility", 

628 "enum": ["private", "internal", "public"], 

629 }, 

630 "request_access_enabled": { 

631 "type": "boolean", 

632 "description": "Allow users to request access", 

633 }, 

634 "issues_access_level": { 

635 "type": "string", 

636 "description": "Set visibility of issues.", 

637 "enum": ["disabled", "private", "enabled"], 

638 }, 

639 "repository_access_level": { 

640 "type": "string", 

641 "description": "Set visibility of repository.", 

642 "enum": ["disabled", "private", "enabled"], 

643 }, 

644 "merge_requests_access_level": { 

645 "type": "string", 

646 "description": "Set visibility of merge requests.", 

647 "enum": ["disabled", "private", "enabled"], 

648 }, 

649 "forking_access_level": { 

650 "type": "string", 

651 "description": "Set visibility of forks.", 

652 "enum": ["disabled", "private", "enabled"], 

653 }, 

654 "lfs_enabled": { 

655 "type": "boolean", 

656 "description": "Enable LFS", 

657 }, 

658 "builds_access_level": { 

659 "type": "string", 

660 "description": "Set visibility of pipelines.", 

661 "enum": ["disabled", "private", "enabled"], 

662 }, 

663 "container_registry_access_level": { 

664 "type": "string", 

665 "description": "Set visibility of container registry.", 

666 "enum": ["disabled", "private", "enabled"], 

667 }, 

668 "analytics_access_level": { 

669 "type": "string", 

670 "description": "Set visibility of analytics.", 

671 "enum": ["disabled", "private", "enabled"], 

672 }, 

673 "requirements_access_level": { 

674 "type": "string", 

675 "description": "Set visibility of requirements management.", 

676 "enum": ["disabled", "private", "enabled"], 

677 }, 

678 "security_and_compliance_access_level": { 

679 "type": "string", 

680 "description": "Set visibility of security and compliance.", 

681 "enum": ["disabled", "private", "enabled"], 

682 }, 

683 "wiki_access_level": { 

684 "type": "string", 

685 "description": "Set visibility of wiki.", 

686 "enum": ["disabled", "private", "enabled"], 

687 }, 

688 "snippets_access_level": { 

689 "type": "string", 

690 "description": "Set visibility of snippets.", 

691 "enum": ["disabled", "private", "enabled"], 

692 }, 

693 "packages_enabled": { 

694 "type": "boolean", 

695 "description": "Enable or disable packages repository feature", 

696 }, 

697 "model_experiments_access_level": { 

698 "type": "string", 

699 "description": "Set visibility of machine learning model experiments.", 

700 "enum": ["disabled", "private", "enabled"], 

701 }, 

702 "model_registry_access_level": { 

703 "type": "string", 

704 "description": "Set visibility of machine learning model registry.", 

705 "enum": ["disabled", "private", "enabled"], 

706 }, 

707 "pages_access_level": { 

708 "type": "string", 

709 "description": "Set visibility of GitLab Pages.", 

710 "enum": ["disabled", "private", "enabled", "public"], 

711 }, 

712 "monitor_access_level": { 

713 "type": "string", 

714 "description": "Set visibility of application performance monitoring.", 

715 "enum": ["disabled", "private", "enabled"], 

716 }, 

717 "environments_access_level": { 

718 "type": "string", 

719 "description": "Set visibility of environments.", 

720 "enum": ["disabled", "private", "enabled"], 

721 }, 

722 "feature_flags_access_level": { 

723 "type": "string", 

724 "description": "Set visibility of feature flags.", 

725 "enum": ["disabled", "private", "enabled"], 

726 }, 

727 "infrastructure_access_level": { 

728 "type": "string", 

729 "description": "Set visibility of infrastructure management.", 

730 "enum": ["disabled", "private", "enabled"], 

731 }, 

732 "releases_access_level": { 

733 "type": "string", 

734 "description": "Set visibility of releases.", 

735 "enum": ["disabled", "private", "enabled"], 

736 }, 

737 "emails_enabled": { 

738 "type": "boolean", 

739 "description": "Enable email notifications.", 

740 }, 

741 "issues_template": { 

742 "type": "string", 

743 "description": "Default description for Issues.", 

744 }, 

745 "service_desk_enabled": { 

746 "type": "boolean", 

747 "description": "Enable or disable Service Desk feature.", 

748 }, 

749 # https://docs.gitlab.com/ee/api/projects.html#archive-a-project 

750 # https://docs.gitlab.com/ee/api/projects.html#unarchive-a-project 

751 "archived": { 

752 "type": "boolean", 

753 "description": "Archive or unarchive project", 

754 }, 

755 # From https://docs.gitlab.com/ee/api/projects.html#hooks 

756 "webhooks": { 

757 "type": "array", 

758 "description": "The list of project's webhooks", 

759 "items": { 

760 "type": "object", 

761 "properties": { 

762 "url": { 

763 "type": "string", 

764 "description": "The hook URL", 

765 }, 

766 "push_events": { 

767 "type": "boolean", 

768 "description": "Trigger hook on push events", 

769 }, 

770 "push_events_branch_filter": { 

771 "type": "string", 

772 "description": "Trigger hook on push events for matching branches only", 

773 }, 

774 "issues_events": { 

775 "type": "boolean", 

776 "description": "Trigger hook on issues events", 

777 }, 

778 "confidential_issues_events": { 

779 "type": "boolean", 

780 "description": "Trigger hook on confidential issues events", 

781 }, 

782 "merge_requests_events": { 

783 "type": "boolean", 

784 "description": "Trigger hook on merge requests events", 

785 }, 

786 "tag_push_events": { 

787 "type": "boolean", 

788 "description": "Trigger hook on tag push events", 

789 }, 

790 "note_events": { 

791 "type": "boolean", 

792 "description": "Trigger hook on note events", 

793 }, 

794 "confidential_note_events": { 

795 "type": "boolean", 

796 "description": "Trigger hook on confidential note events", 

797 }, 

798 "job_events": { 

799 "type": "boolean", 

800 "description": "Trigger hook on job events", 

801 }, 

802 "pipeline_events": { 

803 "type": "boolean", 

804 "description": "Trigger hook on pipeline events", 

805 }, 

806 "wiki_page_events": { 

807 "type": "boolean", 

808 "description": "Trigger hook on wiki events", 

809 }, 

810 "enable_ssl_verification": { 

811 "type": "boolean", 

812 "description": "Do SSL verification when triggering the hook", 

813 }, 

814 "token": { 

815 "type": "string", 

816 "description": ( 

817 "Secret token to validate received payloads; this will not be returned in the response" 

818 ), 

819 }, 

820 }, 

821 "required": ["url"], 

822 "additionalProperties": False, 

823 }, 

824 "uniqueItems": True, 

825 "_example": ( 

826 "\n" 

827 " - url: http://example.com/api/trigger\n" 

828 " push_events: true\n" 

829 " push_events_branch_filter: ''\n" 

830 " issues_events: true\n" 

831 " confidential_issues_events: true\n" 

832 " merge_requests_events: true\n" 

833 " tag_push_events: true\n" 

834 " note_events: true\n" 

835 " confidential_note_events: true\n" 

836 " job_events: true\n" 

837 " pipeline_events: true\n" 

838 " wiki_page_events: true\n" 

839 " enable_ssl_verification: true\n" 

840 " # token: T0k3N\n" 

841 ), 

842 }, 

843 "unknown_webhooks": { # GitLabracadabra 

844 "type": "string", 

845 "description": "What to do with unknown webhooks (`warn` by default).", 

846 "enum": ["warn", "delete", "remove", "ignore", "skip"], 

847 }, 

848 "default_branch": { 

849 "type": "string", 

850 "description": "The default branch name", 

851 }, 

852 "autoclose_referenced_issues": { 

853 "type": "boolean", 

854 "description": "Set whether auto-closing referenced issues on default branch", 

855 }, 

856 "issue_branch_template": { 

857 "type": "string", 

858 "description": "Template used to suggest names for branches created from issues.", 

859 }, 

860 # From https://docs.gitlab.com/ee/api/projects.html#edit-project 

861 "mirror": { 

862 "type": "boolean", 

863 "description": "Enables pull mirroring in a project", 

864 }, 

865 "import_url": { 

866 "type": "string", 

867 "description": "URL to import repository from", 

868 }, 

869 "mirror_user_id": { 

870 "type": "integer", 

871 "description": "User responsible for all the activity surrounding a pull mirror event", 

872 }, 

873 "mirror_overwrites_diverged_branches": { 

874 "type": "boolean", 

875 "description": "Pull mirror overwrites diverged branches", 

876 }, 

877 "mirror_trigger_builds": { 

878 "type": "boolean", 

879 "description": "Pull mirroring triggers builds", 

880 }, 

881 "only_mirror_protected_branches": { 

882 "type": "boolean", 

883 "description": "Only mirror protected branches", 

884 }, 

885 # From https://docs.gitlab.com/ee/api/protected_branches.html#protect-repository-branches 

886 "protected_branches": { 

887 "type": "object", 

888 "description": "Protected branches", 

889 "additionalProperties": { 

890 "type": "object", 

891 "properties": { 

892 "merge_access_level": { 

893 "type": "string", 

894 "description": "Access levels allowed to merge.", 

895 "enum": ["noone", "developer", "maintainer", "admin"], 

896 }, 

897 "allowed_to_merge": { 

898 "type": "array", 

899 "description": "", 

900 "items": { 

901 "oneOf": [ 

902 { 

903 "type": "object", 

904 "description": "Role", 

905 "properties": { 

906 "role": { 

907 "type": "string", 

908 "description": "Role name", 

909 "enum": ["noone", "developer", "maintainer", "admin"], 

910 }, 

911 }, 

912 "additionalProperties": False, 

913 }, 

914 { 

915 "type": "object", 

916 "description": "User", 

917 "properties": { 

918 "user": { 

919 "type": "string", 

920 "description": "User name", 

921 }, 

922 }, 

923 "additionalProperties": False, 

924 }, 

925 { 

926 "type": "object", 

927 "description": "Group", 

928 "properties": { 

929 "group": { 

930 "type": "string", 

931 "description": "Group full path", 

932 }, 

933 }, 

934 "additionalProperties": False, 

935 }, 

936 ], 

937 }, 

938 }, 

939 "push_access_level": { 

940 "type": "string", 

941 "description": "Access levels allowed to push.", 

942 "enum": ["noone", "developer", "maintainer", "admin"], 

943 }, 

944 "allowed_to_push": { 

945 "type": "array", 

946 "description": "", 

947 "items": { 

948 "oneOf": [ 

949 { 

950 "type": "object", 

951 "description": "Role", 

952 "properties": { 

953 "role": { 

954 "type": "string", 

955 "description": "Role name", 

956 "enum": ["noone", "developer", "maintainer", "admin"], 

957 }, 

958 }, 

959 "additionalProperties": False, 

960 }, 

961 { 

962 "type": "object", 

963 "description": "User", 

964 "properties": { 

965 "user": { 

966 "type": "string", 

967 "description": "User name", 

968 }, 

969 }, 

970 "additionalProperties": False, 

971 }, 

972 { 

973 "type": "object", 

974 "description": "Group", 

975 "properties": { 

976 "group": { 

977 "type": "string", 

978 "description": "Group full path", 

979 }, 

980 }, 

981 "additionalProperties": False, 

982 },