# :exclamation: COMMUNITY CONTRIBUTORS, PLEASE PICK UP ONE EXAMPLE FIX TO ALLOW OTHER NEW CONTRIBUTORS TO LEARN :exclamation: In https://gitlab.com/gitlab-org/gitlab/-/merge_requests/175318#note_2261628187, Lee asked if many of the API pages need their curl commands cleaned up. Answer: yes. I’ve gradually cleaned up some of them related to my engineering groups, but there are nearly 200 files total… ## How to contribute (no assignment needed) This issue is open to multiple contributors, so you **do not need to be assigned**. Pick **one** API doc file from the tables below (one marked :question:), then: 1. Create a branch. 2. Apply the implementation plan to that file’s `curl` examples. 3. Open a merge request (MR) and link it back to this issue. 4. Assign the MR to a reviewer (you can choose a Technical Writer / Docs reviewer or follow any reviewer guidance in the project). Please only submit **one file per contributor** so more people can participate. ## Implementation plan The guidance for `curl` commands in the [REST API pages](https://docs.gitlab.com/ee/development/documentation/restful_api_styleguide.html#curl-commands) is relatively new, and many of our API pages don’t have those updates yet. The needed changes: - Break parameters apart, one per line, with some wiggle room on the initial parameter (which is short) - If a method is declared - Each line of a multi-line curl command (except the last) should end in `\` and be indented - Explicitly declare the `--url` parameter, instead of implying it. Before: ```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/resource_milestone_events/120" ``` After: ```shell curl --request GET \ --header "PRIVATE-TOKEN: <your_access_token>" \ --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/resource_milestone_events/120" ``` The curl command is now multiple lines, indented, and declares the --url parameter. Less horizontal scrolling, and easier to read! ## The list! Status: - :question: Curl commands unchecked. (Default status.) - :x: Curl commands need cleanup. - :white_check_mark: Curl commands are correct. ### Monitor stage | Filename | Status | |----------|--------| | `doc/api/alert_management_alerts.md` | :white_check_mark: | | `doc/api/product_analytics.md` | :white_check_mark: | | `doc/api/usage_data.md` | :white_check_mark: | | `doc/api/error_tracking.md` | :white_check_mark: | ### Deploy stage | Filename | Status | |----------|--------| | `doc/api/environments.md` | :white_check_mark: | | `doc/api/group_clusters.md` | :white_check_mark: | | `doc/api/deployments.md` | :white_check_mark: | | `doc/api/protected_environments.md` | :white_check_mark: | | `doc/api/feature_flag_user_lists.md` | :white_check_mark: | | `doc/api/model_registry.md` | :white_check_mark: | | `doc/api/deploy_keys.md` | :white_check_mark: | | `doc/api/group_protected_environments.md` | :white_check_mark: | | `doc/api/version.md` | :white_check_mark: | | `doc/api/metadata.md` | :white_check_mark: | | `doc/api/deploy_tokens.md` | :white_check_mark: | | `doc/api/group_releases.md` | :white_check_mark: | | `doc/api/feature_flags.md` | :white_check_mark: | | `doc/api/features.md` | :white_check_mark: | | `doc/api/instance_clusters.md` | :white_check_mark: | | `doc/api/freeze_periods.md` | :question: | | `doc/api/cluster_agents.md` | :white_check_mark: | | `doc/api/project_clusters.md` | :question: | | `doc/api/resource_groups.md` | :question: | ### Package stage | Filename | Status | |----------|--------| | `doc/api/container_registry.md` | :white_check_mark: | | `doc/api/container_repository_protection_rules.md` | :white_check_mark: | | `doc/api/dependency_proxy.md` | :white_check_mark: | | `doc/api/packages.md` | :white_check_mark: | | `doc/api/project_packages_protection_rules.md` | :white_check_mark: | ### Verify stage | Filename | Status | |----------|--------| | `doc/api/group_level_variables.md` | :question: | | `doc/api/instance_level_ci_variables.md` | :white_check_mark: | | `doc/api/job_artifacts.md` | :question: | | `doc/api/jobs.md` | :white_check_mark: | | `doc/api/lint.md` | :question: | | `doc/api/merge_trains.md` | :question: | | `doc/api/pipeline_schedules.md` | :question: | | `doc/api/pipeline_triggers.md` | :question: | | `doc/api/pipelines.md` | :question: | | `doc/api/project_level_variables.md` | :question: | | `doc/api/runners.md` | :question: | ### Foundations stage | Filename | Status | |----------|--------| | `doc/api/bulk_imports.md` | :question: | | `doc/api/group_import_export.md` | :question: | | `doc/api/group_relations_export.md` | :question: | | `doc/api/group_webhooks.md` | :question: | | `doc/api/import.md` | :question: | | `doc/api/index.md` | :question: | | `doc/api/integrations.md` | :question: | | `doc/api/notification_settings.md` | :question: | | `doc/api/project_import_export.md` | :question: | | `doc/api/project_relations_export.md` | :question: | | `doc/api/project_webhooks.md` | :question: | | `doc/api/search.md` | :question: | | `doc/api/search_admin.md` | :white_check_mark: | | `doc/api/system_hooks.md` | :question: | | `doc/api/todos.md` | :question: | ### Systems stage | Filename | Status | |----------|--------| | `doc/api/admin_sidekiq_queues.md` | :question: | | `doc/api/geo_nodes.md` | :white_check_mark: | | `doc/api/geo_sites.md` | :question: | | `doc/api/project_repository_storage_moves.md` | :question: | | `doc/api/sidekiq_metrics.md` | :question: | ### Create stage, Source Code group | Filename | Status | |----------|--------| | `doc/api/branches.md` | :white_check_mark: | | `doc/api/commits.md` | :white_check_mark: | | `doc/api/discussions.md` | :white_check_mark: | | `doc/api/group_protected_branches.md` | :white_check_mark: | | `doc/api/group_push_rules.md` | :white_check_mark: | | `doc/api/group_ssh_certificates.md` | :white_check_mark: | | `doc/api/keys.md` | :white_check_mark: | | `doc/api/merge_request_approval_settings.md` | :white_check_mark: | | `doc/api/project_aliases.md` | :white_check_mark: | | `doc/api/project_badges.md` | :white_check_mark: | | `doc/api/project_pull_mirroring.md` | :white_check_mark: | | `doc/api/project_push_rules.md` | :question: | | `doc/api/project_snippets.md` | :white_check_mark: | | `doc/api/project_statistics.md` | :white_check_mark: | | `doc/api/project_templates.md` | :white_check_mark: | | `doc/api/protected_branches.md` | :white_check_mark: | | `doc/api/protected_tags.md` | :x: | | `doc/api/remote_mirrors.md` | :white_check_mark: | | `doc/api/repositories.md` | :white_check_mark: | | `doc/api/repository_files.md` | :white_check_mark: | | `doc/api/repository_submodules.md` | :x: | | `doc/api/snippet_repository_storage_moves.md` | :question: | | `doc/api/snippets.md` | :white_check_mark: | | `doc/api/suggestions.md` | :white_check_mark: | | `doc/api/tags.md` | :white_check_mark: | | `doc/api/web_commits.md` | :white_check_mark: | ### Create stage, other groups | Filename | Status | |----------|--------| | `doc/api/code_suggestions.md` | :question: | | `doc/api/draft_notes.md` | :white_check_mark: | | `doc/api/group_repository_storage_moves.md` | :question: | | `doc/api/merge_request_approvals.md` | :white_check_mark: | | `doc/api/merge_request_context_commits.md` | :white_check_mark: | | `doc/api/merge_requests.md` | :white_check_mark: | ### Plan stage, Project Management group | Filename | Status | |----------|--------| | `doc/api/boards.md` | :white_check_mark: | | `doc/api/custom_attributes.md` | :question: | | `doc/api/emoji_reactions.md` | :question: | | `doc/api/group_boards.md` | :question: | | `doc/api/group_iterations.md` | :white_check_mark: | | `doc/api/group_labels.md` | :white_check_mark: | | `doc/api/group_markdown_uploads.md` | :white_check_mark: | | `doc/api/group_milestones.md` | :white_check_mark: | | `doc/api/issue_links.md` | :question: | | `doc/api/issues.md` | :question: | | `doc/api/issues_statistics.md` | :question: | | `doc/api/iterations.md` | :question: | | `doc/api/labels.md` | :question: | | `doc/api/milestones.md` | :question: | | `doc/api/notes.md` | :white_check_mark: | | `doc/api/project_markdown_uploads.md` | :question: | | `doc/api/resource_iteration_events.md` | :question: | | `doc/api/resource_milestone_events.md` | :question: | | `doc/api/resource_state_events.md` | :question: | | `doc/api/resource_weight_events.md` | :question: | ### Plan stage, other | Filename | Status | |----------|--------| | `doc/api/epic_issues.md` | :white_check_mark: | | `doc/api/epic_links.md` | :white_check_mark: | | `doc/api/epics.md` | :question: | | `doc/api/group_activity_analytics.md` | :white_check_mark: | | `doc/api/group_epic_boards.md` | :question: | | `doc/api/group_wikis.md` | :question: | | `doc/api/linked_epics.md` | :question: | | `doc/api/markdown.md` | :question: | | `doc/api/pages.md` | :question: | | `doc/api/pages_domains.md` | :white_check_mark: | | `doc/api/wikis.md` | :white_check_mark: | ### Data access stage | Filename | Status | |----------|--------| | `doc/api/database_migrations.md` | :question: | | `doc/api/group_badges.md` | :question: | | `doc/api/group_ldap_links.md` | :white_check_mark: | | `doc/api/groups.md` | :question: | | `doc/api/invitations.md` | :question: | | `doc/api/organizations.md` | :question: | | `doc/api/project_forks.md` | :question: | | `doc/api/project_starring.md` | :question: | | `doc/api/projects.md` | :question: | | `doc/api/topics.md` | :question: | ### Security risk management stage | Filename | Status | |----------|--------| | `doc/api/dependency_list_export.md` | :question: | | `doc/api/project_vulnerabilities.md` | :question: | | `doc/api/status_checks.md` | :question: | | `doc/api/vulnerabilities.md` | :question: | | `doc/api/vulnerability_exports.md` | :question: | | `doc/api/vulnerability_findings.md` | :question: | ### Software supply chain security stage | Filename | Status | |----------|--------| | `doc/api/access_requests.md` | :white_check_mark: | | `doc/api/appearance.md` | :question: | | `doc/api/applications.md` | :question: | | `doc/api/audit_events.md` | :white_check_mark: | | `doc/api/avatar.md` | :white_check_mark: | | `doc/api/events.md` | :question: | | `doc/api/google_cloud_integration.md` | :question: | | `doc/api/group_access_tokens.md` | :white_check_mark: | | `doc/api/group_enterprise_users.md` | :question: | | `doc/api/group_service_accounts.md` | :question: | | `doc/api/member_roles.md` | :question: | | `doc/api/members.md` | :question: | | `doc/api/namespaces.md` | :white_check_mark: | | `doc/api/oauth2.md` | :question: | | `doc/api/personal_access_tokens.md` | :question: | | `doc/api/plan_limits.md` | :question: | | `doc/api/project_access_tokens.md` | :white_check_mark: | | `doc/api/project_job_token_scopes.md` | :question: | | `doc/api/resource_label_events.md` | :question: | | `doc/api/saml.md` | :question: | | `doc/api/scim.md` | :white_check_mark: | | `doc/api/secure_files.md` | :white_check_mark: | | `doc/api/settings.md` | :question: | | `doc/api/statistics.md` | :question: | | `doc/api/user_email_addresses.md` | :question: | | `doc/api/user_follow_unfollow.md` | :question: | | `doc/api/user_keys.md` | :question: | | `doc/api/user_moderation.md` | :question: | | `doc/api/user_service_accounts.md` | :question: | | `doc/api/user_tokens.md` | :question: | | `doc/api/users.md` | :question: | ### Other | Filename | Status | |----------|--------| | `doc/api/broadcast_messages.md` | :white_check_mark: | | `doc/api/chat.md` | :question: | | `doc/api/dependencies.md` | :question: | | `doc/api/experiments.md` | :question: | | `doc/api/group_security_settings.md` | :question: | | `doc/api/license.md` | :white_check_mark: | | `doc/api/project_container_registry_protection_rules.md` | :question: | | `doc/api/project_security_settings.md` | :question: |