Skip to content

Curl commands should declare --url explicitly

Amy Qualls requested to merge aqualls-followup-curl-url into master

What does this MR do?

In Document current expectations for curl commands (!122694 - merged), @.luke proposed a thoughtful change to our REST API docs spec: that we should format URL parameters like all other curl parameters. Adding the --url parameter is a subtle improvement for comprehension, especially for newer users.

Without the explicitly declared parameter:

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --form "title=ssh-key" \
  --form "key=ssh-rsa AAAAB3NzaC1yc2EA..." \
  "https://gitlab.example.com/api/v4/users/25/keys"

With --url on the last line:

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --form "title=ssh-key" \
  --form "key=ssh-rsa AAAAB3NzaC1yc2EA..." \
  --url "https://gitlab.example.com/api/v4/users/25/keys"

Acknowledgments for transparency

In general terms, Kati liked the idea of requiring this parameter. I also know that Suzanne and I have different thresholds for what rules we're willing to enforce, and Suzanne is on vacation right now. It didn't feel right to encourage scope creep on !122694 (merged) while she was on vacation, so I've moved the idea to this follow-up MR.

  • Many curl examples in our API docs don't do this, though I don't have a count pro / con.
  • We could probably test for this, though I haven't tried building such a test.

Because Suzanne is out this week and I'm out next week, I've created this MR + assigned @dianalogan and @kpaizee as reviewers. I want to make sure I adhere to both the letter and spirit of transparency here.

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.

Merge request reports